@deepraxis/sdk 0.1.0-dev.5dca2b5 → 0.1.0-dev.660e4a8
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 +157 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +342 -10
- package/dist/generated/sdk.gen.js +1054 -9
- package/dist/generated/types.gen.d.ts +23800 -18802
- package/dist/operations.generated.d.ts +1603 -117
- package/dist/operations.generated.js +1946 -86
- package/dist/resources.generated.d.ts +690 -98
- package/dist/resources.generated.js +103 -0
- package/package.json +1 -1
|
@@ -58,7 +58,7 @@ export declare const operations: readonly [{
|
|
|
58
58
|
readonly name: "model";
|
|
59
59
|
readonly type: "object";
|
|
60
60
|
readonly required: true;
|
|
61
|
-
readonly description: "
|
|
61
|
+
readonly description: "A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected.";
|
|
62
62
|
}, {
|
|
63
63
|
readonly name: "name";
|
|
64
64
|
readonly type: "string";
|
|
@@ -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- plus 24 letters or digits, as the File API returns it; 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. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. 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,22 @@ 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.";
|
|
154
|
+
}, {
|
|
155
|
+
readonly name: "environment_id";
|
|
156
|
+
readonly type: "string";
|
|
157
|
+
readonly required: false;
|
|
158
|
+
readonly description: "Default environment of a service agent: the environment_id a new session gets when it names none. Use light, node22 or the env_ id of an active environment of your organization; any other value returns 400 environment_id <id> was not found. null means no environment, so sessions are plain conversation without codemode or bash. Saved with the agent version like other configuration, so apply=false keeps the previous environment in effect for new sessions until that version is applied; a session that sets environment_id itself, null included, overrides it. Omit on create for light; on update, omit to keep it. Versions saved before this field existed read as light. Personal agents use a Computer: a non-null value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
159
|
+
}, {
|
|
160
|
+
readonly name: "vault_ids";
|
|
161
|
+
readonly type: "array";
|
|
162
|
+
readonly itemType: "string";
|
|
163
|
+
readonly required: false;
|
|
164
|
+
readonly description: "Default vaults of a service agent: the vault_ids a new session gets when it names none, so the agent's credentials follow the version. At most 50 ids without duplicates; each must be a vault of your organization that is not archived, otherwise 400 vault_ids[<index>] <id> was not found. Saved with the agent version like other configuration, so apply=false keeps the previous vaults in effect for new sessions until that version is applied; a session that sets vault_ids itself, [] included, overrides it. Omit on create for []; on update, omit to keep the list and send an array to replace it as a whole. Versions saved before this field existed read as []. Embed tokens use the vault_ids of the version they pin; vault_ids on the embed policy is deprecated, still accepted and ignored. Personal agents get no default vaults: a non-empty value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
161
165
|
}, {
|
|
162
166
|
readonly name: "preset";
|
|
163
167
|
readonly type: "string";
|
|
@@ -189,7 +193,7 @@ export declare const operations: readonly [{
|
|
|
189
193
|
readonly resource: "agent.agents";
|
|
190
194
|
readonly method: "update";
|
|
191
195
|
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
|
|
196
|
+
readonly description: "Update an agent. Send the current version in the body for optimistic concurrency: a stale version returns 409, and an update that changes nothing keeps the version number. Any real change saves a new version. apply defaults to true and moves active_version to the new version, or to the latest when configuration is unchanged; apply false saves without applying. version_note optionally records up to 280 characters on a newly created version. Existing sessions and tokens keep their version. Omitted fields keep their value. multiagent takes null or a coordinator roster; subagent_model keeps its value when omitted and is cleared by null. Archived agents cannot be updated. Unlike Anthropic Managed Agents, nonempty skills attachments return 400; use the native skill tool for available runtime skills.";
|
|
193
197
|
readonly http: "POST";
|
|
194
198
|
readonly path: "/agent/v1/agents/{agent_id}";
|
|
195
199
|
readonly streaming: "no";
|
|
@@ -221,7 +225,7 @@ export declare const operations: readonly [{
|
|
|
221
225
|
readonly name: "model";
|
|
222
226
|
readonly type: "object";
|
|
223
227
|
readonly required: false;
|
|
224
|
-
readonly description: "
|
|
228
|
+
readonly description: "A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected.";
|
|
225
229
|
}, {
|
|
226
230
|
readonly name: "multiagent";
|
|
227
231
|
readonly type: "object";
|
|
@@ -255,23 +259,21 @@ export declare const operations: readonly [{
|
|
|
255
259
|
readonly required: false;
|
|
256
260
|
readonly description: "The agent's current version, used to prevent concurrent overwrites.\nObtain this value from a create or retrieve response. Must be at least 1 if\nspecified. When supplied, the request fails if it does not match the server's\ncurrent version; omit to apply the update unconditionally.";
|
|
257
261
|
}, {
|
|
258
|
-
readonly name: "
|
|
259
|
-
readonly type: "
|
|
260
|
-
readonly itemType: "object";
|
|
262
|
+
readonly name: "apply";
|
|
263
|
+
readonly type: "boolean";
|
|
261
264
|
readonly required: false;
|
|
262
|
-
readonly description: "
|
|
265
|
+
readonly description: "Defaults to true: apply the newly saved version, or the latest version when configuration is unchanged. Set false to save without changing active_version. Unlike Managed Agents, saving and applying can be separate.";
|
|
263
266
|
}, {
|
|
264
|
-
readonly name: "
|
|
265
|
-
readonly type: "
|
|
266
|
-
readonly itemType: "object";
|
|
267
|
+
readonly name: "version_note";
|
|
268
|
+
readonly type: "string";
|
|
267
269
|
readonly required: false;
|
|
268
|
-
readonly description: "
|
|
270
|
+
readonly description: "Optional change explanation stored as note on the new immutable version, up to 280 characters. Omission stores null. A note alone does not create a version or rewrite an existing note.";
|
|
269
271
|
}, {
|
|
270
|
-
readonly name: "
|
|
272
|
+
readonly name: "bindings";
|
|
271
273
|
readonly type: "array";
|
|
272
274
|
readonly itemType: "object";
|
|
273
275
|
readonly required: false;
|
|
274
|
-
readonly description: "Replace
|
|
276
|
+
readonly description: "Replace the whole bindings list; omission preserves it, and null or [] clears it. Additions apply only to new sessions; once this version is applied, disabling, removing or downgrading a binding revokes it immediately in running sessions on older versions, while apply=false changes no access. Only service agents accept a nonempty list.";
|
|
275
277
|
}, {
|
|
276
278
|
readonly name: "kind";
|
|
277
279
|
readonly type: "string";
|
|
@@ -310,6 +312,22 @@ export declare const operations: readonly [{
|
|
|
310
312
|
readonly type: "object";
|
|
311
313
|
readonly required: false;
|
|
312
314
|
readonly description: "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable.";
|
|
315
|
+
}, {
|
|
316
|
+
readonly name: "avatar";
|
|
317
|
+
readonly type: "string";
|
|
318
|
+
readonly required: false;
|
|
319
|
+
readonly description: "Avatar image of the agent: an absolute https URL of at most 2048 characters, without credentials; any other value returns 400 avatar must be an https URL. It is the default picture in agent lists, the agent detail, the chat header and embedded chat when the embed appearance sets none. Saved with the agent version like other configuration, so apply=false keeps the previous avatar in effect until that version is applied. Omit on create for no avatar; on update, omit to keep it and send null to clear it. Both personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
320
|
+
}, {
|
|
321
|
+
readonly name: "environment_id";
|
|
322
|
+
readonly type: "string";
|
|
323
|
+
readonly required: false;
|
|
324
|
+
readonly description: "Default environment of a service agent: the environment_id a new session gets when it names none. Use light, node22 or the env_ id of an active environment of your organization; any other value returns 400 environment_id <id> was not found. null means no environment, so sessions are plain conversation without codemode or bash. Saved with the agent version like other configuration, so apply=false keeps the previous environment in effect for new sessions until that version is applied; a session that sets environment_id itself, null included, overrides it. Omit on create for light; on update, omit to keep it. Versions saved before this field existed read as light. Personal agents use a Computer: a non-null value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
325
|
+
}, {
|
|
326
|
+
readonly name: "vault_ids";
|
|
327
|
+
readonly type: "array";
|
|
328
|
+
readonly itemType: "string";
|
|
329
|
+
readonly required: false;
|
|
330
|
+
readonly description: "Default vaults of a service agent: the vault_ids a new session gets when it names none, so the agent's credentials follow the version. At most 50 ids without duplicates; each must be a vault of your organization that is not archived, otherwise 400 vault_ids[<index>] <id> was not found. Saved with the agent version like other configuration, so apply=false keeps the previous vaults in effect for new sessions until that version is applied; a session that sets vault_ids itself, [] included, overrides it. Omit on create for []; on update, omit to keep the list and send an array to replace it as a whole. Versions saved before this field existed read as []. Embed tokens use the vault_ids of the version they pin; vault_ids on the embed policy is deprecated, still accepted and ignored. Personal agents get no default vaults: a non-empty value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
313
331
|
}, {
|
|
314
332
|
readonly name: "preset";
|
|
315
333
|
readonly type: "string";
|
|
@@ -332,6 +350,121 @@ export declare const operations: readonly [{
|
|
|
332
350
|
readonly sdkName: "agent_id";
|
|
333
351
|
}];
|
|
334
352
|
readonly query: readonly [];
|
|
353
|
+
}, {
|
|
354
|
+
readonly resource: "agent.agents.customers.auth.accessTokens";
|
|
355
|
+
readonly method: "create";
|
|
356
|
+
readonly summary: "Create customer access token";
|
|
357
|
+
readonly description: "Exchange a grant code, or the agent's publishable key for an anonymous visitor, for a customer access token that authorizes the agent's embedded sessions.\n\nNo Authorization header is required: the grant code or the publishable key is the credential. Agent Kit calls this from the browser, so send the page Origin. With grant_code, the code is consumed atomically: concurrent attempts have exactly one winner, and unknown, used, expired and other-agent codes all return the same 401 GRANT_CODE_INVALID. The sign-in starts now and lasts the code's max_session_seconds. Unlike Shopify, a visitor without an account gets a token too: send publishable_key instead and a new anonymous customer (anon_…) is created, bound to the request Origin, for 7 days. The access token lasts at most two hours and never outlives the sign-in; renew it with access_tokens/renew before expires_at. Both forms share the per-IP minute limit of anonymous issuance (default 20). Example body: {\"grant_code\":\"cgc_…\"}.";
|
|
358
|
+
readonly http: "POST";
|
|
359
|
+
readonly path: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens";
|
|
360
|
+
readonly streaming: "no";
|
|
361
|
+
readonly pagination: false;
|
|
362
|
+
readonly pathParams: readonly [{
|
|
363
|
+
readonly name: "agent_id";
|
|
364
|
+
readonly sdkName: "agent_id";
|
|
365
|
+
}];
|
|
366
|
+
readonly query: readonly [];
|
|
367
|
+
readonly body: {
|
|
368
|
+
readonly required: true;
|
|
369
|
+
readonly fields: readonly [];
|
|
370
|
+
};
|
|
371
|
+
}, {
|
|
372
|
+
readonly resource: "agent.agents.customers.auth.accessTokens";
|
|
373
|
+
readonly method: "deleteCurrent";
|
|
374
|
+
readonly summary: "Log out customer";
|
|
375
|
+
readonly description: "Log the customer out by revoking the sign-in of the presented access token and every token issued in it.\n\nSend the current customer access token as the Bearer credential, with no body, when the customer logs out of your site. Every token of the sign-in, including renewed ones, stops working, and their live event streams close; the customer's conversations are kept. Returns 204. Calling it again with the same token returns 401 ACCESS_TOKEN_REVOKED, so treat that as already logged out.";
|
|
376
|
+
readonly http: "DELETE";
|
|
377
|
+
readonly path: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/current";
|
|
378
|
+
readonly streaming: "no";
|
|
379
|
+
readonly pagination: false;
|
|
380
|
+
readonly pathParams: readonly [{
|
|
381
|
+
readonly name: "agent_id";
|
|
382
|
+
readonly sdkName: "agent_id";
|
|
383
|
+
}];
|
|
384
|
+
readonly query: readonly [];
|
|
385
|
+
}, {
|
|
386
|
+
readonly resource: "agent.agents.customers.auth.accessTokens.renew";
|
|
387
|
+
readonly method: "create";
|
|
388
|
+
readonly summary: "Renew customer access token";
|
|
389
|
+
readonly description: "Get a fresh customer access token in the same sign-in, authenticated with the current one.\n\nSend the current customer access token as the Bearer credential, with no body, a few minutes before expires_at. The new token keeps the version, budget, context, metadata and origin binding of the sign-in and lasts at most two hours, never past session_expires_at. Unlike Shopify, renewal does not revoke the presented token: it stays valid until its own expiry, so a reply that is streaming on it is not cut off. When less than 60 seconds of the sign-in remain, renewal returns 401 CUSTOMER_SESSION_EXPIRED; sign the customer in again with a new grant code from your backend. A token that was logged out or merged returns 401 ACCESS_TOKEN_REVOKED.";
|
|
390
|
+
readonly http: "POST";
|
|
391
|
+
readonly path: "/agent/v1/agents/{agent_id}/customers/auth/access_tokens/renew";
|
|
392
|
+
readonly streaming: "no";
|
|
393
|
+
readonly pagination: false;
|
|
394
|
+
readonly pathParams: readonly [{
|
|
395
|
+
readonly name: "agent_id";
|
|
396
|
+
readonly sdkName: "agent_id";
|
|
397
|
+
}];
|
|
398
|
+
readonly query: readonly [];
|
|
399
|
+
}, {
|
|
400
|
+
readonly resource: "agent.agents.customers.auth.grantCodes";
|
|
401
|
+
readonly method: "create";
|
|
402
|
+
readonly summary: "Create customer grant code";
|
|
403
|
+
readonly description: "Sign your logged-in customer in to a service agent from your backend with a one-time grant code that Agent Kit exchanges for a customer access token.\n\nCall this from your backend with your API key after your own login succeeds, then pass the returned code to Agent Kit in the browser; never call it from the browser. Customer authorization follows Shopify Storefront customer access tokens (Multipass-style sign-in, a short-lived token, renewal and logout), so that experience applies. customer_id is your own identifier for the customer: use an opaque id such as your database user id, not an email address or phone number. The value auth is reserved, and ids starting with anon_ are reserved for anonymous customers. The code works once and expires after expires_in seconds (default 900). The sign-in it starts lasts max_session_seconds (default 7 days); version, budget_cents, system_message, agent_override and metadata apply to every token of the sign-in. Unlike Shopify, origin binds the whole sign-in to one page origin, and anonymous_access_token merges the conversations of the anonymous visitor who chatted before signing in into this customer. Example body: {\"customer_id\":\"cus_8f2a91\",\"origin\":\"https://shop.example.com\"}.";
|
|
404
|
+
readonly http: "POST";
|
|
405
|
+
readonly path: "/agent/v1/agents/{agent_id}/customers/auth/grant_codes";
|
|
406
|
+
readonly streaming: "no";
|
|
407
|
+
readonly pagination: false;
|
|
408
|
+
readonly pathParams: readonly [{
|
|
409
|
+
readonly name: "agent_id";
|
|
410
|
+
readonly sdkName: "agent_id";
|
|
411
|
+
}];
|
|
412
|
+
readonly query: readonly [];
|
|
413
|
+
readonly body: {
|
|
414
|
+
readonly required: true;
|
|
415
|
+
readonly fields: readonly [{
|
|
416
|
+
readonly name: "customer_id";
|
|
417
|
+
readonly type: "string";
|
|
418
|
+
readonly required: true;
|
|
419
|
+
readonly description: "Your stable, opaque identifier for the signed-in customer, such as your database user id. Do not use an email address or phone number. \"auth\" is reserved, and ids starting with anon_ are reserved for anonymous customers.";
|
|
420
|
+
}, {
|
|
421
|
+
readonly name: "version";
|
|
422
|
+
readonly type: "integer";
|
|
423
|
+
readonly required: false;
|
|
424
|
+
readonly description: "Existing agent version that every token of this sign-in pins. Defaults to the agent's active_version when the code is issued.";
|
|
425
|
+
}, {
|
|
426
|
+
readonly name: "budget_cents";
|
|
427
|
+
readonly type: "integer";
|
|
428
|
+
readonly required: false;
|
|
429
|
+
readonly description: "Budget in cents for each session the customer starts. Defaults to the embed policy session budget and cannot exceed its maximum.";
|
|
430
|
+
}, {
|
|
431
|
+
readonly name: "system_message";
|
|
432
|
+
readonly type: "array";
|
|
433
|
+
readonly itemType: "object";
|
|
434
|
+
readonly required: false;
|
|
435
|
+
readonly description: "Optional context the agent receives at the start of each session, as text blocks, limited to 8192 UTF-8 bytes in total.";
|
|
436
|
+
}, {
|
|
437
|
+
readonly name: "agent_override";
|
|
438
|
+
readonly type: "object";
|
|
439
|
+
readonly required: false;
|
|
440
|
+
readonly description: "Optional system prompt override, accepted only when the embed policy allows agent overrides.";
|
|
441
|
+
}, {
|
|
442
|
+
readonly name: "metadata";
|
|
443
|
+
readonly type: "object";
|
|
444
|
+
readonly required: false;
|
|
445
|
+
readonly description: "Up to 16 string pairs copied onto every session the customer starts. The playground key is reserved.";
|
|
446
|
+
}, {
|
|
447
|
+
readonly name: "origin";
|
|
448
|
+
readonly type: "string";
|
|
449
|
+
readonly required: false;
|
|
450
|
+
readonly description: "Page origin, such as https://shop.example.com, that must be one of the agent policy's allowed_origins (or localhost when the policy allows it). When set, every token of this sign-in works only from exactly this origin. Omit to accept any policy origin.";
|
|
451
|
+
}, {
|
|
452
|
+
readonly name: "expires_in";
|
|
453
|
+
readonly type: "integer";
|
|
454
|
+
readonly required: false;
|
|
455
|
+
readonly description: "Seconds the code stays redeemable, from 60 to 86400. Defaults to 900.";
|
|
456
|
+
}, {
|
|
457
|
+
readonly name: "max_session_seconds";
|
|
458
|
+
readonly type: "integer";
|
|
459
|
+
readonly required: false;
|
|
460
|
+
readonly description: "Total lifetime of the sign-in in seconds, from 3600 to 604800 (7 days). Tokens renew within it; after it the customer signs in again. Defaults to 604800.";
|
|
461
|
+
}, {
|
|
462
|
+
readonly name: "anonymous_access_token";
|
|
463
|
+
readonly type: "string";
|
|
464
|
+
readonly required: false;
|
|
465
|
+
readonly description: "The current access token of the anonymous customer who used this agent before signing in. Their conversations become visible to the identified customer, and the anonymous sign-in ends at exchange.";
|
|
466
|
+
}];
|
|
467
|
+
};
|
|
335
468
|
}, {
|
|
336
469
|
readonly resource: "agent.agents.endUsers";
|
|
337
470
|
readonly method: "list";
|
|
@@ -506,6 +639,23 @@ export declare const operations: readonly [{
|
|
|
506
639
|
readonly required: false;
|
|
507
640
|
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
641
|
}];
|
|
642
|
+
}, {
|
|
643
|
+
readonly resource: "agent.agents.versions";
|
|
644
|
+
readonly method: "apply";
|
|
645
|
+
readonly summary: "Apply Agent Version";
|
|
646
|
+
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.";
|
|
647
|
+
readonly http: "POST";
|
|
648
|
+
readonly path: "/agent/v1/agents/{agent_id}/versions/{version}/apply";
|
|
649
|
+
readonly streaming: "no";
|
|
650
|
+
readonly pagination: false;
|
|
651
|
+
readonly pathParams: readonly [{
|
|
652
|
+
readonly name: "agent_id";
|
|
653
|
+
readonly sdkName: "agent_id";
|
|
654
|
+
}, {
|
|
655
|
+
readonly name: "version";
|
|
656
|
+
readonly sdkName: "version";
|
|
657
|
+
}];
|
|
658
|
+
readonly query: readonly [];
|
|
509
659
|
}, {
|
|
510
660
|
readonly resource: "agent.computers";
|
|
511
661
|
readonly method: "list";
|
|
@@ -1478,7 +1628,7 @@ export declare const operations: readonly [{
|
|
|
1478
1628
|
readonly resource: "agent.sessions";
|
|
1479
1629
|
readonly method: "create";
|
|
1480
1630
|
readonly summary: "Create session";
|
|
1481
|
-
readonly description: "Create a session: one conversation with an agent. Pass agent as an agent id (
|
|
1631
|
+
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
1632
|
readonly http: "POST";
|
|
1483
1633
|
readonly path: "/agent/v1/sessions";
|
|
1484
1634
|
readonly streaming: "no";
|
|
@@ -2190,131 +2340,312 @@ export declare const operations: readonly [{
|
|
|
2190
2340
|
readonly description: "When set, this connection also receives streaming deltas\n(`event_start`, `event_delta`) while an event is being produced, before the\nevent itself arrives. Deltas are best-effort; when the final event is produced\nit carries the complete content. A model request that ends early (an error or\ninterrupt) produces no final event — its terminal `span.model_request_end`\ncloses the preview. Accepts one or more event types to preview and may be\nrepeated: `agent.message` streams `content_delta` fragments; `agent.thinking` is\nstart-only — a signal that the agent has begun extended thinking, concluded by\nthe `agent.thinking` event itself. Only previews of the requested event types\nare sent.";
|
|
2191
2341
|
}];
|
|
2192
2342
|
}, {
|
|
2193
|
-
readonly resource: "agent.
|
|
2343
|
+
readonly resource: "agent.skills";
|
|
2194
2344
|
readonly method: "list";
|
|
2195
|
-
readonly summary: "List
|
|
2196
|
-
readonly description: "
|
|
2345
|
+
readonly summary: "List skills";
|
|
2346
|
+
readonly description: "List the skills uploaded to your organization, newest first, in pages of at most 100 (default 20). Use it to find a skill id before reading, versioning or deleting it. Only source=custom has content; source=anthropic returns an empty list. Pass next_page from the response as page to read the next page; a null next_page means the end.";
|
|
2197
2347
|
readonly http: "GET";
|
|
2198
|
-
readonly path: "/agent/v1/
|
|
2348
|
+
readonly path: "/agent/v1/skills";
|
|
2199
2349
|
readonly streaming: "no";
|
|
2200
2350
|
readonly pagination: false;
|
|
2201
2351
|
readonly pathParams: readonly [];
|
|
2202
|
-
readonly query: readonly [
|
|
2352
|
+
readonly query: readonly [{
|
|
2353
|
+
readonly name: "source";
|
|
2354
|
+
readonly type: "string";
|
|
2355
|
+
readonly required: false;
|
|
2356
|
+
readonly description: "Filter skills by source.\n\nIf provided, only skills from the specified source will be returned:\n\n- `\"custom\"`: only return user-created skills\n- `\"anthropic\"`: only return Anthropic-created skills";
|
|
2357
|
+
}, {
|
|
2358
|
+
readonly name: "limit";
|
|
2359
|
+
readonly type: "number";
|
|
2360
|
+
readonly required: false;
|
|
2361
|
+
readonly description: "Number of items per page.";
|
|
2362
|
+
}, {
|
|
2363
|
+
readonly name: "page";
|
|
2364
|
+
readonly type: "string";
|
|
2365
|
+
readonly required: false;
|
|
2366
|
+
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.";
|
|
2367
|
+
}];
|
|
2203
2368
|
}, {
|
|
2204
|
-
readonly resource: "
|
|
2369
|
+
readonly resource: "agent.skills";
|
|
2205
2370
|
readonly method: "create";
|
|
2206
|
-
readonly summary: "
|
|
2207
|
-
readonly description: "Upload
|
|
2371
|
+
readonly summary: "Create skill";
|
|
2372
|
+
readonly description: "Upload a skill: a directory that contains SKILL.md, which the agent reads when it needs the skill. Send multipart/form-data with one files part per file, each file name being its path under one top-level directory (pdf/SKILL.md, pdf/scripts/run.py), and an optional display_name. SKILL.md frontmatter needs a description; name defaults to the directory name. Limits: 8 MB in total, at most 200 files, no .. segments, absolute paths or empty names; a violation returns 400 naming the path or field. The upload creates the skill and its first version, and versions are immutable. Attach the skill to an agent with `skills` on the agent.";
|
|
2208
2373
|
readonly http: "POST";
|
|
2209
|
-
readonly path: "/
|
|
2374
|
+
readonly path: "/agent/v1/skills";
|
|
2210
2375
|
readonly streaming: "no";
|
|
2211
2376
|
readonly pagination: false;
|
|
2377
|
+
readonly multipart: true;
|
|
2212
2378
|
readonly pathParams: readonly [];
|
|
2213
2379
|
readonly query: readonly [];
|
|
2214
2380
|
readonly body: {
|
|
2215
2381
|
readonly required: true;
|
|
2216
2382
|
readonly fields: readonly [{
|
|
2217
|
-
readonly name: "jwt";
|
|
2218
|
-
readonly type: "string";
|
|
2219
|
-
readonly required: true;
|
|
2220
|
-
readonly description: "Upload token from the session.";
|
|
2221
|
-
}, {
|
|
2222
2383
|
readonly name: "files";
|
|
2223
|
-
readonly type: "
|
|
2384
|
+
readonly type: "array";
|
|
2385
|
+
readonly itemType: "string";
|
|
2224
2386
|
readonly required: true;
|
|
2225
|
-
readonly description: "
|
|
2387
|
+
readonly description: "Files to upload for the skill.\n\nAll files must be in the same top-level directory and must include a SKILL.md\nfile at the root of that directory.";
|
|
2388
|
+
}, {
|
|
2389
|
+
readonly name: "display_name";
|
|
2390
|
+
readonly type: "string";
|
|
2391
|
+
readonly required: false;
|
|
2392
|
+
readonly description: "Human-readable, single-line label for the Skill. Maximum 255\ncharacters. Always set: derived from the SKILL.md frontmatter `name` when\nomitted at creation. Not unique.";
|
|
2226
2393
|
}];
|
|
2227
2394
|
};
|
|
2228
2395
|
}, {
|
|
2229
|
-
readonly resource: "
|
|
2230
|
-
readonly method: "
|
|
2231
|
-
readonly summary: "
|
|
2232
|
-
readonly description: "
|
|
2233
|
-
readonly http: "
|
|
2234
|
-
readonly path: "/
|
|
2396
|
+
readonly resource: "agent.skills";
|
|
2397
|
+
readonly method: "delete";
|
|
2398
|
+
readonly summary: "Delete skill";
|
|
2399
|
+
readonly description: "Delete a skill that has no live versions. A skill that still has versions returns 409 Delete all versions first; remove each with skills.versions.delete, then call this. Returns {id, type: skill_deleted}. skill_id comes from skills.create or skills.list.";
|
|
2400
|
+
readonly http: "DELETE";
|
|
2401
|
+
readonly path: "/agent/v1/skills/{skill_id}";
|
|
2235
2402
|
readonly streaming: "no";
|
|
2236
2403
|
readonly pagination: false;
|
|
2237
|
-
readonly pathParams: readonly [
|
|
2404
|
+
readonly pathParams: readonly [{
|
|
2405
|
+
readonly name: "skill_id";
|
|
2406
|
+
readonly sdkName: "skill_id";
|
|
2407
|
+
}];
|
|
2238
2408
|
readonly query: readonly [];
|
|
2239
2409
|
}, {
|
|
2240
|
-
readonly resource: "
|
|
2241
|
-
readonly method: "
|
|
2242
|
-
readonly summary: "
|
|
2243
|
-
readonly description: "
|
|
2244
|
-
readonly http: "
|
|
2245
|
-
readonly path: "/
|
|
2410
|
+
readonly resource: "agent.skills";
|
|
2411
|
+
readonly method: "retrieve";
|
|
2412
|
+
readonly summary: "Get skill";
|
|
2413
|
+
readonly description: "Read one skill by id: its display_name, source and latest_version_id. skill_id comes from skills.create or skills.list. A skill of another organization, or a deleted one, returns 404 Skill not found.";
|
|
2414
|
+
readonly http: "GET";
|
|
2415
|
+
readonly path: "/agent/v1/skills/{skill_id}";
|
|
2246
2416
|
readonly streaming: "no";
|
|
2247
2417
|
readonly pagination: false;
|
|
2248
|
-
readonly pathParams: readonly [
|
|
2418
|
+
readonly pathParams: readonly [{
|
|
2419
|
+
readonly name: "skill_id";
|
|
2420
|
+
readonly sdkName: "skill_id";
|
|
2421
|
+
}];
|
|
2249
2422
|
readonly query: readonly [];
|
|
2250
|
-
readonly body: {
|
|
2251
|
-
readonly required: true;
|
|
2252
|
-
readonly fields: readonly [{
|
|
2253
|
-
readonly name: "subdomain";
|
|
2254
|
-
readonly type: "string";
|
|
2255
|
-
readonly required: true;
|
|
2256
|
-
readonly description: "Account subdomain, 8–32 lowercase letters and digits; part of every Worker URL.";
|
|
2257
|
-
}];
|
|
2258
|
-
};
|
|
2259
2423
|
}, {
|
|
2260
|
-
readonly resource: "
|
|
2424
|
+
readonly resource: "agent.skills.versions";
|
|
2261
2425
|
readonly method: "list";
|
|
2262
|
-
readonly summary: "List
|
|
2263
|
-
readonly description: "List
|
|
2426
|
+
readonly summary: "List skill versions";
|
|
2427
|
+
readonly description: "List the live versions of one skill, newest first, in pages of at most 100 (default 20). Each item carries the name and description read from the SKILL.md of that version. Pass next_page from the response as page to read the next page; a null next_page means the end.";
|
|
2264
2428
|
readonly http: "GET";
|
|
2265
|
-
readonly path: "/
|
|
2429
|
+
readonly path: "/agent/v1/skills/{skill_id}/versions";
|
|
2266
2430
|
readonly streaming: "no";
|
|
2267
|
-
readonly pagination:
|
|
2268
|
-
readonly pathParams: readonly [
|
|
2431
|
+
readonly pagination: false;
|
|
2432
|
+
readonly pathParams: readonly [{
|
|
2433
|
+
readonly name: "skill_id";
|
|
2434
|
+
readonly sdkName: "skill_id";
|
|
2435
|
+
}];
|
|
2269
2436
|
readonly query: readonly [{
|
|
2270
|
-
readonly name: "cursor";
|
|
2271
|
-
readonly type: "string";
|
|
2272
|
-
readonly required: false;
|
|
2273
|
-
readonly description: "next_cursor from the previous page.";
|
|
2274
|
-
}, {
|
|
2275
2437
|
readonly name: "limit";
|
|
2276
|
-
readonly type: "
|
|
2438
|
+
readonly type: "number";
|
|
2277
2439
|
readonly required: false;
|
|
2278
|
-
readonly description: "
|
|
2440
|
+
readonly description: "Number of items per page.";
|
|
2279
2441
|
}, {
|
|
2280
|
-
readonly name: "
|
|
2442
|
+
readonly name: "page";
|
|
2281
2443
|
readonly type: "string";
|
|
2282
2444
|
readonly required: false;
|
|
2283
|
-
readonly description: "
|
|
2445
|
+
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.";
|
|
2284
2446
|
}];
|
|
2285
2447
|
}, {
|
|
2286
|
-
readonly resource: "
|
|
2448
|
+
readonly resource: "agent.skills.versions";
|
|
2287
2449
|
readonly method: "create";
|
|
2288
|
-
readonly summary: "Create
|
|
2289
|
-
readonly description: "
|
|
2450
|
+
readonly summary: "Create skill version";
|
|
2451
|
+
readonly description: "Upload a new version of a skill with the same multipart/form-data shape and limits as skills.create (8 MB, 200 files, one top-level directory containing SKILL.md). The SKILL.md name must equal the name of the skill; a different name returns 400. The new version becomes latest_version_id of the skill, and earlier versions stay unchanged because versions are immutable. Attach it to an agent with `skills` on the agent.";
|
|
2290
2452
|
readonly http: "POST";
|
|
2291
|
-
readonly path: "/
|
|
2453
|
+
readonly path: "/agent/v1/skills/{skill_id}/versions";
|
|
2292
2454
|
readonly streaming: "no";
|
|
2293
2455
|
readonly pagination: false;
|
|
2294
|
-
readonly
|
|
2456
|
+
readonly multipart: true;
|
|
2457
|
+
readonly pathParams: readonly [{
|
|
2458
|
+
readonly name: "skill_id";
|
|
2459
|
+
readonly sdkName: "skill_id";
|
|
2460
|
+
}];
|
|
2295
2461
|
readonly query: readonly [];
|
|
2296
2462
|
readonly body: {
|
|
2297
2463
|
readonly required: true;
|
|
2298
2464
|
readonly fields: readonly [{
|
|
2299
|
-
readonly name: "
|
|
2300
|
-
readonly type: "string";
|
|
2301
|
-
readonly required: true;
|
|
2302
|
-
readonly description: "Worker name, unique in your account: 3–40 lowercase letters, digits or hyphens, starting and ending with a letter or digit, with no two hyphens in a row. The names www, api, admin, app, canary, canary-probe, status, docs and console are reserved.";
|
|
2303
|
-
}, {
|
|
2304
|
-
readonly name: "tags";
|
|
2465
|
+
readonly name: "files";
|
|
2305
2466
|
readonly type: "array";
|
|
2306
2467
|
readonly itemType: "string";
|
|
2307
|
-
readonly required:
|
|
2308
|
-
readonly description: "
|
|
2309
|
-
}
|
|
2310
|
-
|
|
2311
|
-
|
|
2312
|
-
|
|
2313
|
-
|
|
2314
|
-
|
|
2315
|
-
|
|
2316
|
-
|
|
2317
|
-
|
|
2468
|
+
readonly required: true;
|
|
2469
|
+
readonly description: "Files to upload for the skill.\n\nAll files must be in the same top-level directory and must include a SKILL.md\nfile at the root of that directory.";
|
|
2470
|
+
}];
|
|
2471
|
+
};
|
|
2472
|
+
}, {
|
|
2473
|
+
readonly resource: "agent.skills.versions";
|
|
2474
|
+
readonly method: "delete";
|
|
2475
|
+
readonly summary: "Delete skill version";
|
|
2476
|
+
readonly description: "Soft-delete one version of a skill so it can no longer be read or downloaded; latest_version_id of the skill falls back to the newest remaining version. Returns {id, type: skill_version_deleted}. A skill can be deleted only after all of its versions are deleted.";
|
|
2477
|
+
readonly http: "DELETE";
|
|
2478
|
+
readonly path: "/agent/v1/skills/{skill_id}/versions/{version}";
|
|
2479
|
+
readonly streaming: "no";
|
|
2480
|
+
readonly pagination: false;
|
|
2481
|
+
readonly pathParams: readonly [{
|
|
2482
|
+
readonly name: "skill_id";
|
|
2483
|
+
readonly sdkName: "skill_id";
|
|
2484
|
+
}, {
|
|
2485
|
+
readonly name: "version";
|
|
2486
|
+
readonly sdkName: "version";
|
|
2487
|
+
}];
|
|
2488
|
+
readonly query: readonly [];
|
|
2489
|
+
}, {
|
|
2490
|
+
readonly resource: "agent.skills.versions";
|
|
2491
|
+
readonly method: "retrieve";
|
|
2492
|
+
readonly summary: "Get skill version";
|
|
2493
|
+
readonly description: "Read one version of a skill: its name, description and created_at as read from SKILL.md. version is the id returned by skills.versions.create or skills.versions.list. A deleted or unknown version returns 404 Skill version not found.";
|
|
2494
|
+
readonly http: "GET";
|
|
2495
|
+
readonly path: "/agent/v1/skills/{skill_id}/versions/{version}";
|
|
2496
|
+
readonly streaming: "no";
|
|
2497
|
+
readonly pagination: false;
|
|
2498
|
+
readonly pathParams: readonly [{
|
|
2499
|
+
readonly name: "skill_id";
|
|
2500
|
+
readonly sdkName: "skill_id";
|
|
2501
|
+
}, {
|
|
2502
|
+
readonly name: "version";
|
|
2503
|
+
readonly sdkName: "version";
|
|
2504
|
+
}];
|
|
2505
|
+
readonly query: readonly [];
|
|
2506
|
+
}, {
|
|
2507
|
+
readonly resource: "agent.skills.versions";
|
|
2508
|
+
readonly method: "retrieveContent";
|
|
2509
|
+
readonly summary: "Download skill version";
|
|
2510
|
+
readonly description: "Download the content of one version as a zip archive (application/zip): the uploaded directory with its top-level folder and every file. version is the id returned by skills.versions.create or skills.versions.list; a deleted version returns 404.";
|
|
2511
|
+
readonly http: "GET";
|
|
2512
|
+
readonly path: "/agent/v1/skills/{skill_id}/versions/{version}/content";
|
|
2513
|
+
readonly streaming: "no";
|
|
2514
|
+
readonly pagination: false;
|
|
2515
|
+
readonly pathParams: readonly [{
|
|
2516
|
+
readonly name: "skill_id";
|
|
2517
|
+
readonly sdkName: "skill_id";
|
|
2518
|
+
}, {
|
|
2519
|
+
readonly name: "version";
|
|
2520
|
+
readonly sdkName: "version";
|
|
2521
|
+
}];
|
|
2522
|
+
readonly query: readonly [];
|
|
2523
|
+
}, {
|
|
2524
|
+
readonly resource: "agent.toolsets";
|
|
2525
|
+
readonly method: "list";
|
|
2526
|
+
readonly summary: "List Toolsets";
|
|
2527
|
+
readonly description: "Discover tool names, input schemas, read-only status and default permission policies before configuring an agent. The catalog is read-only: enable tools through agents.create or agents.update. agent_toolset_20260401 includes bash, edit, glob, grep, read, write, web_search, web_fetch, task_output, task_stop, monitor, agent, send_message, codemode and skill, plus todo_write, enter_plan_mode, ask_user_question and goal_read, which are listed so they can be switched off. Native additions require bash enabled; codemode requires bash (enabling it with bash disabled returns 400; keep bash enabled with permission_policy always_ask to restrict it); send_message also requires agent. To keep only some tools, set default_config.enabled to false and enable the wanted tools in configs; unlisted tools follow default_config. The catalog includes plugin names and versions. Sessions created through /anthropic/v1 expose only the eight official tools.";
|
|
2528
|
+
readonly http: "GET";
|
|
2529
|
+
readonly path: "/agent/v1/toolsets";
|
|
2530
|
+
readonly streaming: "no";
|
|
2531
|
+
readonly pagination: false;
|
|
2532
|
+
readonly pathParams: readonly [];
|
|
2533
|
+
readonly query: readonly [];
|
|
2534
|
+
}, {
|
|
2535
|
+
readonly resource: "application.assets.upload";
|
|
2536
|
+
readonly method: "create";
|
|
2537
|
+
readonly summary: "Upload assets";
|
|
2538
|
+
readonly description: "Upload one batch: files maps hash to base64 content. The last batch returns the completion token.";
|
|
2539
|
+
readonly http: "POST";
|
|
2540
|
+
readonly path: "/application/v1/assets/upload";
|
|
2541
|
+
readonly streaming: "no";
|
|
2542
|
+
readonly pagination: false;
|
|
2543
|
+
readonly pathParams: readonly [];
|
|
2544
|
+
readonly query: readonly [];
|
|
2545
|
+
readonly body: {
|
|
2546
|
+
readonly required: true;
|
|
2547
|
+
readonly fields: readonly [{
|
|
2548
|
+
readonly name: "jwt";
|
|
2549
|
+
readonly type: "string";
|
|
2550
|
+
readonly required: true;
|
|
2551
|
+
readonly description: "Upload token from the session.";
|
|
2552
|
+
}, {
|
|
2553
|
+
readonly name: "files";
|
|
2554
|
+
readonly type: "object";
|
|
2555
|
+
readonly required: true;
|
|
2556
|
+
readonly description: "Hash → base64 file content.";
|
|
2557
|
+
}];
|
|
2558
|
+
};
|
|
2559
|
+
}, {
|
|
2560
|
+
readonly resource: "application.subdomain";
|
|
2561
|
+
readonly method: "retrieve";
|
|
2562
|
+
readonly summary: "Get account subdomain";
|
|
2563
|
+
readonly description: "Return the account subdomain used in every Worker URL. A default is created on first use.";
|
|
2564
|
+
readonly http: "GET";
|
|
2565
|
+
readonly path: "/application/v1/subdomain";
|
|
2566
|
+
readonly streaming: "no";
|
|
2567
|
+
readonly pagination: false;
|
|
2568
|
+
readonly pathParams: readonly [];
|
|
2569
|
+
readonly query: readonly [];
|
|
2570
|
+
}, {
|
|
2571
|
+
readonly resource: "application.subdomain";
|
|
2572
|
+
readonly method: "update";
|
|
2573
|
+
readonly summary: "Change account subdomain";
|
|
2574
|
+
readonly description: "Change the account subdomain. Every Worker moves to the new address at once; old addresses stop resolving.";
|
|
2575
|
+
readonly http: "PUT";
|
|
2576
|
+
readonly path: "/application/v1/subdomain";
|
|
2577
|
+
readonly streaming: "no";
|
|
2578
|
+
readonly pagination: false;
|
|
2579
|
+
readonly pathParams: readonly [];
|
|
2580
|
+
readonly query: readonly [];
|
|
2581
|
+
readonly body: {
|
|
2582
|
+
readonly required: true;
|
|
2583
|
+
readonly fields: readonly [{
|
|
2584
|
+
readonly name: "subdomain";
|
|
2585
|
+
readonly type: "string";
|
|
2586
|
+
readonly required: true;
|
|
2587
|
+
readonly description: "Account subdomain, 8–32 lowercase letters and digits; part of every Worker URL.";
|
|
2588
|
+
}];
|
|
2589
|
+
};
|
|
2590
|
+
}, {
|
|
2591
|
+
readonly resource: "application.workers";
|
|
2592
|
+
readonly method: "list";
|
|
2593
|
+
readonly summary: "List Workers";
|
|
2594
|
+
readonly description: "List Workers in your account. Filter by status or by label with label.<key>=<value>.";
|
|
2595
|
+
readonly http: "GET";
|
|
2596
|
+
readonly path: "/application/v1/workers";
|
|
2597
|
+
readonly streaming: "no";
|
|
2598
|
+
readonly pagination: true;
|
|
2599
|
+
readonly pathParams: readonly [];
|
|
2600
|
+
readonly query: readonly [{
|
|
2601
|
+
readonly name: "cursor";
|
|
2602
|
+
readonly type: "string";
|
|
2603
|
+
readonly required: false;
|
|
2604
|
+
readonly description: "next_cursor from the previous page.";
|
|
2605
|
+
}, {
|
|
2606
|
+
readonly name: "limit";
|
|
2607
|
+
readonly type: "integer";
|
|
2608
|
+
readonly required: false;
|
|
2609
|
+
readonly description: "Items per page.";
|
|
2610
|
+
}, {
|
|
2611
|
+
readonly name: "status";
|
|
2612
|
+
readonly type: "string";
|
|
2613
|
+
readonly required: false;
|
|
2614
|
+
readonly description: "Worker status: draft (no deployment yet), active (serving), suspended (stopped by an administrator), deleted (soft-deleted, restorable for 7 days), purging (resources being removed), purged (gone).";
|
|
2615
|
+
}];
|
|
2616
|
+
}, {
|
|
2617
|
+
readonly resource: "application.workers";
|
|
2618
|
+
readonly method: "create";
|
|
2619
|
+
readonly summary: "Create Worker";
|
|
2620
|
+
readonly description: "Create a Worker. It serves nothing until a version is deployed.";
|
|
2621
|
+
readonly http: "POST";
|
|
2622
|
+
readonly path: "/application/v1/workers";
|
|
2623
|
+
readonly streaming: "no";
|
|
2624
|
+
readonly pagination: false;
|
|
2625
|
+
readonly pathParams: readonly [];
|
|
2626
|
+
readonly query: readonly [];
|
|
2627
|
+
readonly body: {
|
|
2628
|
+
readonly required: true;
|
|
2629
|
+
readonly fields: readonly [{
|
|
2630
|
+
readonly name: "name";
|
|
2631
|
+
readonly type: "string";
|
|
2632
|
+
readonly required: true;
|
|
2633
|
+
readonly description: "Worker name, unique in your account: 3–40 lowercase letters, digits or hyphens, starting and ending with a letter or digit, with no two hyphens in a row. The names www, api, admin, app, canary, canary-probe, status, docs and console are reserved.";
|
|
2634
|
+
}, {
|
|
2635
|
+
readonly name: "tags";
|
|
2636
|
+
readonly type: "array";
|
|
2637
|
+
readonly itemType: "string";
|
|
2638
|
+
readonly required: false;
|
|
2639
|
+
readonly description: "Up to 8 tags.";
|
|
2640
|
+
}, {
|
|
2641
|
+
readonly name: "observability";
|
|
2642
|
+
readonly type: "object";
|
|
2643
|
+
readonly required: false;
|
|
2644
|
+
readonly description: "Observability settings.";
|
|
2645
|
+
}, {
|
|
2646
|
+
readonly name: "subdomain";
|
|
2647
|
+
readonly type: "object";
|
|
2648
|
+
readonly required: false;
|
|
2318
2649
|
readonly description: "Subdomain settings.";
|
|
2319
2650
|
}, {
|
|
2320
2651
|
readonly name: "praxis";
|
|
@@ -2880,12 +3211,12 @@ export declare const operations: readonly [{
|
|
|
2880
3211
|
readonly name: "namespace";
|
|
2881
3212
|
readonly type: "string";
|
|
2882
3213
|
readonly required: true;
|
|
2883
|
-
readonly description: "Choose a namespace without prior registration; praxis is
|
|
3214
|
+
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
3215
|
}, {
|
|
2885
3216
|
readonly name: "name";
|
|
2886
3217
|
readonly type: "string";
|
|
2887
3218
|
readonly required: true;
|
|
2888
|
-
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
3219
|
+
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
2889
3220
|
}, {
|
|
2890
3221
|
readonly name: "description";
|
|
2891
3222
|
readonly type: "string";
|
|
@@ -2937,8 +3268,8 @@ export declare const operations: readonly [{
|
|
|
2937
3268
|
}, {
|
|
2938
3269
|
readonly resource: "automation.actions";
|
|
2939
3270
|
readonly method: "retrieve";
|
|
2940
|
-
readonly summary: "Get an
|
|
2941
|
-
readonly description: "Read the
|
|
3271
|
+
readonly summary: "Get an Action with its current input and output JSON Schemas";
|
|
3272
|
+
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
3273
|
readonly http: "GET";
|
|
2943
3274
|
readonly path: "/automation/v1/actions/{ns}/{name}";
|
|
2944
3275
|
readonly streaming: "no";
|
|
@@ -3382,8 +3713,8 @@ export declare const operations: readonly [{
|
|
|
3382
3713
|
}, {
|
|
3383
3714
|
readonly resource: "automation.runs";
|
|
3384
3715
|
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
|
|
3716
|
+
readonly summary: "Run a published target or execute draft source";
|
|
3717
|
+
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
3718
|
readonly http: "POST";
|
|
3388
3719
|
readonly path: "/automation/v1/runs";
|
|
3389
3720
|
readonly streaming: "no";
|
|
@@ -3766,7 +4097,7 @@ export declare const operations: readonly [{
|
|
|
3766
4097
|
readonly resource: "automation.scripts";
|
|
3767
4098
|
readonly method: "create";
|
|
3768
4099
|
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
|
|
4100
|
+
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
4101
|
readonly http: "POST";
|
|
3771
4102
|
readonly path: "/automation/v1/scripts";
|
|
3772
4103
|
readonly streaming: "no";
|
|
@@ -3779,12 +4110,12 @@ export declare const operations: readonly [{
|
|
|
3779
4110
|
readonly name: "namespace";
|
|
3780
4111
|
readonly type: "string";
|
|
3781
4112
|
readonly required: true;
|
|
3782
|
-
readonly description: "Choose a namespace without prior registration; praxis is
|
|
4113
|
+
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
4114
|
}, {
|
|
3784
4115
|
readonly name: "name";
|
|
3785
4116
|
readonly type: "string";
|
|
3786
4117
|
readonly required: true;
|
|
3787
|
-
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
4118
|
+
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
3788
4119
|
}, {
|
|
3789
4120
|
readonly name: "description";
|
|
3790
4121
|
readonly type: "string";
|
|
@@ -3823,7 +4154,7 @@ export declare const operations: readonly [{
|
|
|
3823
4154
|
readonly resource: "automation.scripts";
|
|
3824
4155
|
readonly method: "update";
|
|
3825
4156
|
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.";
|
|
4157
|
+
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
4158
|
readonly http: "PATCH";
|
|
3828
4159
|
readonly path: "/automation/v1/scripts/{ns}/{name}";
|
|
3829
4160
|
readonly streaming: "no";
|
|
@@ -4582,7 +4913,7 @@ export declare const operations: readonly [{
|
|
|
4582
4913
|
readonly resource: "automation.workflows";
|
|
4583
4914
|
readonly method: "create";
|
|
4584
4915
|
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
|
|
4916
|
+
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
4917
|
readonly http: "POST";
|
|
4587
4918
|
readonly path: "/automation/v1/workflows";
|
|
4588
4919
|
readonly streaming: "no";
|
|
@@ -4595,12 +4926,12 @@ export declare const operations: readonly [{
|
|
|
4595
4926
|
readonly name: "namespace";
|
|
4596
4927
|
readonly type: "string";
|
|
4597
4928
|
readonly required: true;
|
|
4598
|
-
readonly description: "Choose a namespace without prior registration; praxis is
|
|
4929
|
+
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
4930
|
}, {
|
|
4600
4931
|
readonly name: "name";
|
|
4601
4932
|
readonly type: "string";
|
|
4602
4933
|
readonly required: true;
|
|
4603
|
-
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-
|
|
4934
|
+
readonly description: "Name, folded to lowercase; matches [a-z0-9][a-z0-9_-]{0,63}.";
|
|
4604
4935
|
}, {
|
|
4605
4936
|
readonly name: "description";
|
|
4606
4937
|
readonly type: "string";
|
|
@@ -10959,6 +11290,1161 @@ export declare const operations: readonly [{
|
|
|
10959
11290
|
readonly description: "Whether to filter out adult or unsafe content from results. Not supported for `fast` or `ultra-fast` search depths.";
|
|
10960
11291
|
}];
|
|
10961
11292
|
};
|
|
11293
|
+
}, {
|
|
11294
|
+
readonly resource: "ticket.activity";
|
|
11295
|
+
readonly method: "retrieve";
|
|
11296
|
+
readonly summary: "List activity";
|
|
11297
|
+
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.";
|
|
11298
|
+
readonly http: "GET";
|
|
11299
|
+
readonly path: "/ticket/v1/activity";
|
|
11300
|
+
readonly streaming: "no";
|
|
11301
|
+
readonly pagination: false;
|
|
11302
|
+
readonly pathParams: readonly [];
|
|
11303
|
+
readonly query: readonly [{
|
|
11304
|
+
readonly name: "repository";
|
|
11305
|
+
readonly type: "string";
|
|
11306
|
+
readonly required: false;
|
|
11307
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11308
|
+
}, {
|
|
11309
|
+
readonly name: "page_size";
|
|
11310
|
+
readonly type: "integer";
|
|
11311
|
+
readonly required: false;
|
|
11312
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11313
|
+
}, {
|
|
11314
|
+
readonly name: "page_token";
|
|
11315
|
+
readonly type: "string";
|
|
11316
|
+
readonly required: false;
|
|
11317
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11318
|
+
}, {
|
|
11319
|
+
readonly name: "filter";
|
|
11320
|
+
readonly type: "string";
|
|
11321
|
+
readonly required: false;
|
|
11322
|
+
readonly description: "Activity qualifiers: actor, actor-kind, action, ticket, source and since; passed unchanged to the service.";
|
|
11323
|
+
}];
|
|
11324
|
+
}, {
|
|
11325
|
+
readonly resource: "ticket.comments";
|
|
11326
|
+
readonly method: "delete";
|
|
11327
|
+
readonly summary: "Remove comments";
|
|
11328
|
+
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.";
|
|
11329
|
+
readonly http: "DELETE";
|
|
11330
|
+
readonly path: "/ticket/v1/comments/{id}";
|
|
11331
|
+
readonly streaming: "no";
|
|
11332
|
+
readonly pagination: false;
|
|
11333
|
+
readonly pathParams: readonly [{
|
|
11334
|
+
readonly name: "id";
|
|
11335
|
+
readonly sdkName: "id";
|
|
11336
|
+
}];
|
|
11337
|
+
readonly query: readonly [{
|
|
11338
|
+
readonly name: "repository";
|
|
11339
|
+
readonly type: "string";
|
|
11340
|
+
readonly required: false;
|
|
11341
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11342
|
+
}];
|
|
11343
|
+
}, {
|
|
11344
|
+
readonly resource: "ticket.comments";
|
|
11345
|
+
readonly method: "retrieve";
|
|
11346
|
+
readonly summary: "Read comments";
|
|
11347
|
+
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.";
|
|
11348
|
+
readonly http: "GET";
|
|
11349
|
+
readonly path: "/ticket/v1/comments/{id}";
|
|
11350
|
+
readonly streaming: "no";
|
|
11351
|
+
readonly pagination: false;
|
|
11352
|
+
readonly pathParams: readonly [{
|
|
11353
|
+
readonly name: "id";
|
|
11354
|
+
readonly sdkName: "id";
|
|
11355
|
+
}];
|
|
11356
|
+
readonly query: readonly [{
|
|
11357
|
+
readonly name: "repository";
|
|
11358
|
+
readonly type: "string";
|
|
11359
|
+
readonly required: false;
|
|
11360
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11361
|
+
}];
|
|
11362
|
+
}, {
|
|
11363
|
+
readonly resource: "ticket.comments";
|
|
11364
|
+
readonly method: "update";
|
|
11365
|
+
readonly summary: "Update comments";
|
|
11366
|
+
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.";
|
|
11367
|
+
readonly http: "PATCH";
|
|
11368
|
+
readonly path: "/ticket/v1/comments/{id}";
|
|
11369
|
+
readonly streaming: "no";
|
|
11370
|
+
readonly pagination: false;
|
|
11371
|
+
readonly pathParams: readonly [{
|
|
11372
|
+
readonly name: "id";
|
|
11373
|
+
readonly sdkName: "id";
|
|
11374
|
+
}];
|
|
11375
|
+
readonly query: readonly [{
|
|
11376
|
+
readonly name: "repository";
|
|
11377
|
+
readonly type: "string";
|
|
11378
|
+
readonly required: false;
|
|
11379
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11380
|
+
}];
|
|
11381
|
+
readonly body: {
|
|
11382
|
+
readonly required: true;
|
|
11383
|
+
readonly fields: readonly [{
|
|
11384
|
+
readonly name: "body";
|
|
11385
|
+
readonly type: "string";
|
|
11386
|
+
readonly required: true;
|
|
11387
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11388
|
+
}, {
|
|
11389
|
+
readonly name: "in_reply_to";
|
|
11390
|
+
readonly type: "string";
|
|
11391
|
+
readonly required: false;
|
|
11392
|
+
readonly description: "Opaque identifier returned by this resource's create or list operation.";
|
|
11393
|
+
}];
|
|
11394
|
+
};
|
|
11395
|
+
}, {
|
|
11396
|
+
readonly resource: "ticket.comments.reactions";
|
|
11397
|
+
readonly method: "list";
|
|
11398
|
+
readonly summary: "List reactions";
|
|
11399
|
+
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.";
|
|
11400
|
+
readonly http: "GET";
|
|
11401
|
+
readonly path: "/ticket/v1/comments/{id}/reactions";
|
|
11402
|
+
readonly streaming: "no";
|
|
11403
|
+
readonly pagination: false;
|
|
11404
|
+
readonly pathParams: readonly [{
|
|
11405
|
+
readonly name: "id";
|
|
11406
|
+
readonly sdkName: "id";
|
|
11407
|
+
}];
|
|
11408
|
+
readonly query: readonly [{
|
|
11409
|
+
readonly name: "repository";
|
|
11410
|
+
readonly type: "string";
|
|
11411
|
+
readonly required: false;
|
|
11412
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11413
|
+
}, {
|
|
11414
|
+
readonly name: "page_size";
|
|
11415
|
+
readonly type: "integer";
|
|
11416
|
+
readonly required: false;
|
|
11417
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11418
|
+
}, {
|
|
11419
|
+
readonly name: "page_token";
|
|
11420
|
+
readonly type: "string";
|
|
11421
|
+
readonly required: false;
|
|
11422
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11423
|
+
}];
|
|
11424
|
+
}, {
|
|
11425
|
+
readonly resource: "ticket.comments.reactions";
|
|
11426
|
+
readonly method: "create";
|
|
11427
|
+
readonly summary: "Create or add reactions";
|
|
11428
|
+
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.";
|
|
11429
|
+
readonly http: "POST";
|
|
11430
|
+
readonly path: "/ticket/v1/comments/{id}/reactions";
|
|
11431
|
+
readonly streaming: "no";
|
|
11432
|
+
readonly pagination: false;
|
|
11433
|
+
readonly pathParams: readonly [{
|
|
11434
|
+
readonly name: "id";
|
|
11435
|
+
readonly sdkName: "id";
|
|
11436
|
+
}];
|
|
11437
|
+
readonly query: readonly [{
|
|
11438
|
+
readonly name: "repository";
|
|
11439
|
+
readonly type: "string";
|
|
11440
|
+
readonly required: false;
|
|
11441
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11442
|
+
}];
|
|
11443
|
+
readonly body: {
|
|
11444
|
+
readonly required: true;
|
|
11445
|
+
readonly fields: readonly [{
|
|
11446
|
+
readonly name: "content";
|
|
11447
|
+
readonly type: "string";
|
|
11448
|
+
readonly enum: readonly ["+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket"];
|
|
11449
|
+
readonly required: true;
|
|
11450
|
+
readonly description: "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket.";
|
|
11451
|
+
}];
|
|
11452
|
+
};
|
|
11453
|
+
}, {
|
|
11454
|
+
readonly resource: "ticket.comments.reactions";
|
|
11455
|
+
readonly method: "delete";
|
|
11456
|
+
readonly summary: "Remove reactions";
|
|
11457
|
+
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.";
|
|
11458
|
+
readonly http: "DELETE";
|
|
11459
|
+
readonly path: "/ticket/v1/comments/{id}/reactions/{content}";
|
|
11460
|
+
readonly streaming: "no";
|
|
11461
|
+
readonly pagination: false;
|
|
11462
|
+
readonly pathParams: readonly [{
|
|
11463
|
+
readonly name: "id";
|
|
11464
|
+
readonly sdkName: "id";
|
|
11465
|
+
}, {
|
|
11466
|
+
readonly name: "content";
|
|
11467
|
+
readonly sdkName: "content";
|
|
11468
|
+
}];
|
|
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
|
+
}, {
|
|
11476
|
+
readonly resource: "ticket.labels";
|
|
11477
|
+
readonly method: "list";
|
|
11478
|
+
readonly summary: "List labels";
|
|
11479
|
+
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.";
|
|
11480
|
+
readonly http: "GET";
|
|
11481
|
+
readonly path: "/ticket/v1/labels";
|
|
11482
|
+
readonly streaming: "no";
|
|
11483
|
+
readonly pagination: false;
|
|
11484
|
+
readonly pathParams: readonly [];
|
|
11485
|
+
readonly query: readonly [{
|
|
11486
|
+
readonly name: "repository";
|
|
11487
|
+
readonly type: "string";
|
|
11488
|
+
readonly required: false;
|
|
11489
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11490
|
+
}, {
|
|
11491
|
+
readonly name: "page_size";
|
|
11492
|
+
readonly type: "integer";
|
|
11493
|
+
readonly required: false;
|
|
11494
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11495
|
+
}, {
|
|
11496
|
+
readonly name: "page_token";
|
|
11497
|
+
readonly type: "string";
|
|
11498
|
+
readonly required: false;
|
|
11499
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11500
|
+
}];
|
|
11501
|
+
}, {
|
|
11502
|
+
readonly resource: "ticket.labels";
|
|
11503
|
+
readonly method: "create";
|
|
11504
|
+
readonly summary: "Create or add labels";
|
|
11505
|
+
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.";
|
|
11506
|
+
readonly http: "POST";
|
|
11507
|
+
readonly path: "/ticket/v1/labels";
|
|
11508
|
+
readonly streaming: "no";
|
|
11509
|
+
readonly pagination: false;
|
|
11510
|
+
readonly pathParams: readonly [];
|
|
11511
|
+
readonly query: readonly [{
|
|
11512
|
+
readonly name: "repository";
|
|
11513
|
+
readonly type: "string";
|
|
11514
|
+
readonly required: false;
|
|
11515
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11516
|
+
}];
|
|
11517
|
+
readonly body: {
|
|
11518
|
+
readonly required: true;
|
|
11519
|
+
readonly fields: readonly [{
|
|
11520
|
+
readonly name: "name";
|
|
11521
|
+
readonly type: "string";
|
|
11522
|
+
readonly required: true;
|
|
11523
|
+
readonly description: "Case-insensitive label name within the repository.";
|
|
11524
|
+
}, {
|
|
11525
|
+
readonly name: "color";
|
|
11526
|
+
readonly type: "string";
|
|
11527
|
+
readonly required: true;
|
|
11528
|
+
readonly description: "Six hexadecimal digits without #.";
|
|
11529
|
+
}, {
|
|
11530
|
+
readonly name: "description";
|
|
11531
|
+
readonly type: "string";
|
|
11532
|
+
readonly required: false;
|
|
11533
|
+
readonly description: "Label's purpose.";
|
|
11534
|
+
}];
|
|
11535
|
+
};
|
|
11536
|
+
}, {
|
|
11537
|
+
readonly resource: "ticket.labels";
|
|
11538
|
+
readonly method: "delete";
|
|
11539
|
+
readonly summary: "Remove labels";
|
|
11540
|
+
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.";
|
|
11541
|
+
readonly http: "DELETE";
|
|
11542
|
+
readonly path: "/ticket/v1/labels/{name}";
|
|
11543
|
+
readonly streaming: "no";
|
|
11544
|
+
readonly pagination: false;
|
|
11545
|
+
readonly pathParams: readonly [{
|
|
11546
|
+
readonly name: "name";
|
|
11547
|
+
readonly sdkName: "name";
|
|
11548
|
+
}];
|
|
11549
|
+
readonly query: readonly [{
|
|
11550
|
+
readonly name: "repository";
|
|
11551
|
+
readonly type: "string";
|
|
11552
|
+
readonly required: false;
|
|
11553
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11554
|
+
}];
|
|
11555
|
+
}, {
|
|
11556
|
+
readonly resource: "ticket.labels";
|
|
11557
|
+
readonly method: "update";
|
|
11558
|
+
readonly summary: "Update labels";
|
|
11559
|
+
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.";
|
|
11560
|
+
readonly http: "PATCH";
|
|
11561
|
+
readonly path: "/ticket/v1/labels/{name}";
|
|
11562
|
+
readonly streaming: "no";
|
|
11563
|
+
readonly pagination: false;
|
|
11564
|
+
readonly pathParams: readonly [{
|
|
11565
|
+
readonly name: "name";
|
|
11566
|
+
readonly sdkName: "name";
|
|
11567
|
+
}];
|
|
11568
|
+
readonly query: readonly [{
|
|
11569
|
+
readonly name: "repository";
|
|
11570
|
+
readonly type: "string";
|
|
11571
|
+
readonly required: false;
|
|
11572
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11573
|
+
}];
|
|
11574
|
+
readonly body: {
|
|
11575
|
+
readonly required: true;
|
|
11576
|
+
readonly fields: readonly [{
|
|
11577
|
+
readonly name: "color";
|
|
11578
|
+
readonly type: "string";
|
|
11579
|
+
readonly required: false;
|
|
11580
|
+
readonly description: "Six hexadecimal digits without #.";
|
|
11581
|
+
}, {
|
|
11582
|
+
readonly name: "description";
|
|
11583
|
+
readonly type: "string";
|
|
11584
|
+
readonly required: false;
|
|
11585
|
+
readonly description: "Label's purpose.";
|
|
11586
|
+
}, {
|
|
11587
|
+
readonly name: "new_name";
|
|
11588
|
+
readonly type: "string";
|
|
11589
|
+
readonly required: false;
|
|
11590
|
+
readonly description: "Case-insensitive label name within the repository.";
|
|
11591
|
+
}];
|
|
11592
|
+
};
|
|
11593
|
+
}, {
|
|
11594
|
+
readonly resource: "ticket.milestones";
|
|
11595
|
+
readonly method: "list";
|
|
11596
|
+
readonly summary: "List milestones";
|
|
11597
|
+
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.";
|
|
11598
|
+
readonly http: "GET";
|
|
11599
|
+
readonly path: "/ticket/v1/milestones";
|
|
11600
|
+
readonly streaming: "no";
|
|
11601
|
+
readonly pagination: false;
|
|
11602
|
+
readonly pathParams: readonly [];
|
|
11603
|
+
readonly query: readonly [{
|
|
11604
|
+
readonly name: "repository";
|
|
11605
|
+
readonly type: "string";
|
|
11606
|
+
readonly required: false;
|
|
11607
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11608
|
+
}, {
|
|
11609
|
+
readonly name: "page_size";
|
|
11610
|
+
readonly type: "integer";
|
|
11611
|
+
readonly required: false;
|
|
11612
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11613
|
+
}, {
|
|
11614
|
+
readonly name: "page_token";
|
|
11615
|
+
readonly type: "string";
|
|
11616
|
+
readonly required: false;
|
|
11617
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11618
|
+
}];
|
|
11619
|
+
}, {
|
|
11620
|
+
readonly resource: "ticket.milestones";
|
|
11621
|
+
readonly method: "create";
|
|
11622
|
+
readonly summary: "Create or add milestones";
|
|
11623
|
+
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.";
|
|
11624
|
+
readonly http: "POST";
|
|
11625
|
+
readonly path: "/ticket/v1/milestones";
|
|
11626
|
+
readonly streaming: "no";
|
|
11627
|
+
readonly pagination: false;
|
|
11628
|
+
readonly pathParams: readonly [];
|
|
11629
|
+
readonly query: readonly [{
|
|
11630
|
+
readonly name: "repository";
|
|
11631
|
+
readonly type: "string";
|
|
11632
|
+
readonly required: false;
|
|
11633
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11634
|
+
}];
|
|
11635
|
+
readonly body: {
|
|
11636
|
+
readonly required: true;
|
|
11637
|
+
readonly fields: readonly [{
|
|
11638
|
+
readonly name: "title";
|
|
11639
|
+
readonly type: "string";
|
|
11640
|
+
readonly required: true;
|
|
11641
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11642
|
+
}, {
|
|
11643
|
+
readonly name: "description";
|
|
11644
|
+
readonly type: "string";
|
|
11645
|
+
readonly required: false;
|
|
11646
|
+
readonly description: "Milestone description.";
|
|
11647
|
+
}, {
|
|
11648
|
+
readonly name: "due_on";
|
|
11649
|
+
readonly type: "string";
|
|
11650
|
+
readonly required: false;
|
|
11651
|
+
readonly description: "Due date, or null if unset.";
|
|
11652
|
+
}, {
|
|
11653
|
+
readonly name: "state";
|
|
11654
|
+
readonly type: "string";
|
|
11655
|
+
readonly enum: readonly ["open", "closed"];
|
|
11656
|
+
readonly required: false;
|
|
11657
|
+
readonly description: "open means actionable; closed means resolved or declined.";
|
|
11658
|
+
}];
|
|
11659
|
+
};
|
|
11660
|
+
}, {
|
|
11661
|
+
readonly resource: "ticket.milestones";
|
|
11662
|
+
readonly method: "delete";
|
|
11663
|
+
readonly summary: "Remove milestones";
|
|
11664
|
+
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.";
|
|
11665
|
+
readonly http: "DELETE";
|
|
11666
|
+
readonly path: "/ticket/v1/milestones/{number}";
|
|
11667
|
+
readonly streaming: "no";
|
|
11668
|
+
readonly pagination: false;
|
|
11669
|
+
readonly pathParams: readonly [{
|
|
11670
|
+
readonly name: "number";
|
|
11671
|
+
readonly sdkName: "number";
|
|
11672
|
+
}];
|
|
11673
|
+
readonly query: readonly [{
|
|
11674
|
+
readonly name: "repository";
|
|
11675
|
+
readonly type: "string";
|
|
11676
|
+
readonly required: false;
|
|
11677
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11678
|
+
}];
|
|
11679
|
+
}, {
|
|
11680
|
+
readonly resource: "ticket.milestones";
|
|
11681
|
+
readonly method: "retrieve";
|
|
11682
|
+
readonly summary: "Read milestones";
|
|
11683
|
+
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.";
|
|
11684
|
+
readonly http: "GET";
|
|
11685
|
+
readonly path: "/ticket/v1/milestones/{number}";
|
|
11686
|
+
readonly streaming: "no";
|
|
11687
|
+
readonly pagination: false;
|
|
11688
|
+
readonly pathParams: readonly [{
|
|
11689
|
+
readonly name: "number";
|
|
11690
|
+
readonly sdkName: "number";
|
|
11691
|
+
}];
|
|
11692
|
+
readonly query: readonly [{
|
|
11693
|
+
readonly name: "repository";
|
|
11694
|
+
readonly type: "string";
|
|
11695
|
+
readonly required: false;
|
|
11696
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11697
|
+
}];
|
|
11698
|
+
}, {
|
|
11699
|
+
readonly resource: "ticket.milestones";
|
|
11700
|
+
readonly method: "update";
|
|
11701
|
+
readonly summary: "Update milestones";
|
|
11702
|
+
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.";
|
|
11703
|
+
readonly http: "PATCH";
|
|
11704
|
+
readonly path: "/ticket/v1/milestones/{number}";
|
|
11705
|
+
readonly streaming: "no";
|
|
11706
|
+
readonly pagination: false;
|
|
11707
|
+
readonly pathParams: readonly [{
|
|
11708
|
+
readonly name: "number";
|
|
11709
|
+
readonly sdkName: "number";
|
|
11710
|
+
}];
|
|
11711
|
+
readonly query: readonly [{
|
|
11712
|
+
readonly name: "repository";
|
|
11713
|
+
readonly type: "string";
|
|
11714
|
+
readonly required: false;
|
|
11715
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11716
|
+
}];
|
|
11717
|
+
readonly body: {
|
|
11718
|
+
readonly required: true;
|
|
11719
|
+
readonly fields: readonly [{
|
|
11720
|
+
readonly name: "title";
|
|
11721
|
+
readonly type: "string";
|
|
11722
|
+
readonly required: false;
|
|
11723
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11724
|
+
}, {
|
|
11725
|
+
readonly name: "description";
|
|
11726
|
+
readonly type: "string";
|
|
11727
|
+
readonly required: false;
|
|
11728
|
+
readonly description: "Milestone description.";
|
|
11729
|
+
}, {
|
|
11730
|
+
readonly name: "due_on";
|
|
11731
|
+
readonly type: "string";
|
|
11732
|
+
readonly required: false;
|
|
11733
|
+
readonly description: "Due date, or null if unset.";
|
|
11734
|
+
}, {
|
|
11735
|
+
readonly name: "state";
|
|
11736
|
+
readonly type: "string";
|
|
11737
|
+
readonly enum: readonly ["open", "closed"];
|
|
11738
|
+
readonly required: false;
|
|
11739
|
+
readonly description: "open means actionable; closed means resolved or declined.";
|
|
11740
|
+
}];
|
|
11741
|
+
};
|
|
11742
|
+
}, {
|
|
11743
|
+
readonly resource: "ticket.repositories";
|
|
11744
|
+
readonly method: "list";
|
|
11745
|
+
readonly summary: "List repositories";
|
|
11746
|
+
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.";
|
|
11747
|
+
readonly http: "GET";
|
|
11748
|
+
readonly path: "/ticket/v1/repositories";
|
|
11749
|
+
readonly streaming: "no";
|
|
11750
|
+
readonly pagination: false;
|
|
11751
|
+
readonly pathParams: readonly [];
|
|
11752
|
+
readonly query: readonly [{
|
|
11753
|
+
readonly name: "page_size";
|
|
11754
|
+
readonly type: "integer";
|
|
11755
|
+
readonly required: false;
|
|
11756
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11757
|
+
}, {
|
|
11758
|
+
readonly name: "page_token";
|
|
11759
|
+
readonly type: "string";
|
|
11760
|
+
readonly required: false;
|
|
11761
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11762
|
+
}];
|
|
11763
|
+
}, {
|
|
11764
|
+
readonly resource: "ticket.tickets";
|
|
11765
|
+
readonly method: "list";
|
|
11766
|
+
readonly summary: "List tickets";
|
|
11767
|
+
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.";
|
|
11768
|
+
readonly http: "GET";
|
|
11769
|
+
readonly path: "/ticket/v1/tickets";
|
|
11770
|
+
readonly streaming: "no";
|
|
11771
|
+
readonly pagination: false;
|
|
11772
|
+
readonly pathParams: readonly [];
|
|
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
|
+
readonly name: "page_size";
|
|
11780
|
+
readonly type: "integer";
|
|
11781
|
+
readonly required: false;
|
|
11782
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11783
|
+
}, {
|
|
11784
|
+
readonly name: "page_token";
|
|
11785
|
+
readonly type: "string";
|
|
11786
|
+
readonly required: false;
|
|
11787
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11788
|
+
}, {
|
|
11789
|
+
readonly name: "filter";
|
|
11790
|
+
readonly type: "string";
|
|
11791
|
+
readonly required: false;
|
|
11792
|
+
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.";
|
|
11793
|
+
}];
|
|
11794
|
+
}, {
|
|
11795
|
+
readonly resource: "ticket.tickets";
|
|
11796
|
+
readonly method: "create";
|
|
11797
|
+
readonly summary: "Create or add tickets";
|
|
11798
|
+
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.";
|
|
11799
|
+
readonly http: "POST";
|
|
11800
|
+
readonly path: "/ticket/v1/tickets";
|
|
11801
|
+
readonly streaming: "no";
|
|
11802
|
+
readonly pagination: false;
|
|
11803
|
+
readonly pathParams: readonly [];
|
|
11804
|
+
readonly query: readonly [{
|
|
11805
|
+
readonly name: "repository";
|
|
11806
|
+
readonly type: "string";
|
|
11807
|
+
readonly required: false;
|
|
11808
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11809
|
+
}];
|
|
11810
|
+
readonly body: {
|
|
11811
|
+
readonly required: true;
|
|
11812
|
+
readonly fields: readonly [{
|
|
11813
|
+
readonly name: "title";
|
|
11814
|
+
readonly type: "string";
|
|
11815
|
+
readonly required: true;
|
|
11816
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11817
|
+
}, {
|
|
11818
|
+
readonly name: "body";
|
|
11819
|
+
readonly type: "string";
|
|
11820
|
+
readonly required: false;
|
|
11821
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11822
|
+
}, {
|
|
11823
|
+
readonly name: "type";
|
|
11824
|
+
readonly type: "string";
|
|
11825
|
+
readonly required: false;
|
|
11826
|
+
readonly description: "Built-in type name; null clears an existing type.";
|
|
11827
|
+
}, {
|
|
11828
|
+
readonly name: "labels";
|
|
11829
|
+
readonly type: "array";
|
|
11830
|
+
readonly itemType: "string";
|
|
11831
|
+
readonly required: false;
|
|
11832
|
+
readonly description: "Labels attached to this ticket; updates replace the complete list.";
|
|
11833
|
+
}, {
|
|
11834
|
+
readonly name: "assignees";
|
|
11835
|
+
readonly type: "array";
|
|
11836
|
+
readonly itemType: "string";
|
|
11837
|
+
readonly required: false;
|
|
11838
|
+
readonly description: "Complete assignee list, at most ten.";
|
|
11839
|
+
}, {
|
|
11840
|
+
readonly name: "milestone";
|
|
11841
|
+
readonly type: "integer";
|
|
11842
|
+
readonly required: false;
|
|
11843
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11844
|
+
}, {
|
|
11845
|
+
readonly name: "parent";
|
|
11846
|
+
readonly type: "integer";
|
|
11847
|
+
readonly required: false;
|
|
11848
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11849
|
+
}];
|
|
11850
|
+
};
|
|
11851
|
+
}, {
|
|
11852
|
+
readonly resource: "ticket.tickets";
|
|
11853
|
+
readonly method: "retrieve";
|
|
11854
|
+
readonly summary: "Read tickets";
|
|
11855
|
+
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.";
|
|
11856
|
+
readonly http: "GET";
|
|
11857
|
+
readonly path: "/ticket/v1/tickets/{number}";
|
|
11858
|
+
readonly streaming: "no";
|
|
11859
|
+
readonly pagination: false;
|
|
11860
|
+
readonly pathParams: readonly [{
|
|
11861
|
+
readonly name: "number";
|
|
11862
|
+
readonly sdkName: "number";
|
|
11863
|
+
}];
|
|
11864
|
+
readonly query: readonly [{
|
|
11865
|
+
readonly name: "repository";
|
|
11866
|
+
readonly type: "string";
|
|
11867
|
+
readonly required: false;
|
|
11868
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11869
|
+
}];
|
|
11870
|
+
}, {
|
|
11871
|
+
readonly resource: "ticket.tickets";
|
|
11872
|
+
readonly method: "update";
|
|
11873
|
+
readonly summary: "Update tickets";
|
|
11874
|
+
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.";
|
|
11875
|
+
readonly http: "PATCH";
|
|
11876
|
+
readonly path: "/ticket/v1/tickets/{number}";
|
|
11877
|
+
readonly streaming: "no";
|
|
11878
|
+
readonly pagination: false;
|
|
11879
|
+
readonly pathParams: readonly [{
|
|
11880
|
+
readonly name: "number";
|
|
11881
|
+
readonly sdkName: "number";
|
|
11882
|
+
}];
|
|
11883
|
+
readonly query: readonly [{
|
|
11884
|
+
readonly name: "repository";
|
|
11885
|
+
readonly type: "string";
|
|
11886
|
+
readonly required: false;
|
|
11887
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11888
|
+
}];
|
|
11889
|
+
readonly body: {
|
|
11890
|
+
readonly required: true;
|
|
11891
|
+
readonly fields: readonly [{
|
|
11892
|
+
readonly name: "title";
|
|
11893
|
+
readonly type: "string";
|
|
11894
|
+
readonly required: false;
|
|
11895
|
+
readonly description: "Short title, at most 256 Unicode characters.";
|
|
11896
|
+
}, {
|
|
11897
|
+
readonly name: "body";
|
|
11898
|
+
readonly type: "string";
|
|
11899
|
+
readonly required: false;
|
|
11900
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11901
|
+
}, {
|
|
11902
|
+
readonly name: "type";
|
|
11903
|
+
readonly type: "string";
|
|
11904
|
+
readonly required: false;
|
|
11905
|
+
readonly description: "Built-in type name; null clears an existing type.";
|
|
11906
|
+
}, {
|
|
11907
|
+
readonly name: "labels";
|
|
11908
|
+
readonly type: "array";
|
|
11909
|
+
readonly itemType: "string";
|
|
11910
|
+
readonly required: false;
|
|
11911
|
+
readonly description: "Labels attached to this ticket; updates replace the complete list.";
|
|
11912
|
+
}, {
|
|
11913
|
+
readonly name: "assignees";
|
|
11914
|
+
readonly type: "array";
|
|
11915
|
+
readonly itemType: "string";
|
|
11916
|
+
readonly required: false;
|
|
11917
|
+
readonly description: "Complete assignee list, at most ten.";
|
|
11918
|
+
}, {
|
|
11919
|
+
readonly name: "milestone";
|
|
11920
|
+
readonly type: "integer";
|
|
11921
|
+
readonly required: false;
|
|
11922
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11923
|
+
}, {
|
|
11924
|
+
readonly name: "state";
|
|
11925
|
+
readonly type: "string";
|
|
11926
|
+
readonly enum: readonly ["open", "closed"];
|
|
11927
|
+
readonly required: false;
|
|
11928
|
+
readonly description: "open means actionable; closed means resolved or declined.";
|
|
11929
|
+
}, {
|
|
11930
|
+
readonly name: "state_reason";
|
|
11931
|
+
readonly type: "string";
|
|
11932
|
+
readonly enum: readonly ["completed", "not_planned", "duplicate"];
|
|
11933
|
+
readonly required: false;
|
|
11934
|
+
readonly description: "Reason for closing: completed resolves, not_planned declines, duplicate marks a duplicate.";
|
|
11935
|
+
}, {
|
|
11936
|
+
readonly name: "duplicate_of";
|
|
11937
|
+
readonly type: "integer";
|
|
11938
|
+
readonly required: false;
|
|
11939
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
11940
|
+
}];
|
|
11941
|
+
};
|
|
11942
|
+
}, {
|
|
11943
|
+
readonly resource: "ticket.tickets.comments";
|
|
11944
|
+
readonly method: "list";
|
|
11945
|
+
readonly summary: "List comments";
|
|
11946
|
+
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.";
|
|
11947
|
+
readonly http: "GET";
|
|
11948
|
+
readonly path: "/ticket/v1/tickets/{number}/comments";
|
|
11949
|
+
readonly streaming: "no";
|
|
11950
|
+
readonly pagination: false;
|
|
11951
|
+
readonly pathParams: readonly [{
|
|
11952
|
+
readonly name: "number";
|
|
11953
|
+
readonly sdkName: "number";
|
|
11954
|
+
}];
|
|
11955
|
+
readonly query: readonly [{
|
|
11956
|
+
readonly name: "repository";
|
|
11957
|
+
readonly type: "string";
|
|
11958
|
+
readonly required: false;
|
|
11959
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11960
|
+
}, {
|
|
11961
|
+
readonly name: "page_size";
|
|
11962
|
+
readonly type: "integer";
|
|
11963
|
+
readonly required: false;
|
|
11964
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
11965
|
+
}, {
|
|
11966
|
+
readonly name: "page_token";
|
|
11967
|
+
readonly type: "string";
|
|
11968
|
+
readonly required: false;
|
|
11969
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
11970
|
+
}];
|
|
11971
|
+
}, {
|
|
11972
|
+
readonly resource: "ticket.tickets.comments";
|
|
11973
|
+
readonly method: "create";
|
|
11974
|
+
readonly summary: "Create or add comments";
|
|
11975
|
+
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.";
|
|
11976
|
+
readonly http: "POST";
|
|
11977
|
+
readonly path: "/ticket/v1/tickets/{number}/comments";
|
|
11978
|
+
readonly streaming: "no";
|
|
11979
|
+
readonly pagination: false;
|
|
11980
|
+
readonly pathParams: readonly [{
|
|
11981
|
+
readonly name: "number";
|
|
11982
|
+
readonly sdkName: "number";
|
|
11983
|
+
}];
|
|
11984
|
+
readonly query: readonly [{
|
|
11985
|
+
readonly name: "repository";
|
|
11986
|
+
readonly type: "string";
|
|
11987
|
+
readonly required: false;
|
|
11988
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
11989
|
+
}];
|
|
11990
|
+
readonly body: {
|
|
11991
|
+
readonly required: true;
|
|
11992
|
+
readonly fields: readonly [{
|
|
11993
|
+
readonly name: "body";
|
|
11994
|
+
readonly type: "string";
|
|
11995
|
+
readonly required: true;
|
|
11996
|
+
readonly description: "Markdown text, at most 65536 characters.";
|
|
11997
|
+
}, {
|
|
11998
|
+
readonly name: "in_reply_to";
|
|
11999
|
+
readonly type: "string";
|
|
12000
|
+
readonly required: false;
|
|
12001
|
+
readonly description: "Opaque identifier returned by this resource's create or list operation.";
|
|
12002
|
+
}];
|
|
12003
|
+
};
|
|
12004
|
+
}, {
|
|
12005
|
+
readonly resource: "ticket.tickets.dependencies";
|
|
12006
|
+
readonly method: "retrieveBlockedBy";
|
|
12007
|
+
readonly summary: "List blocked by";
|
|
12008
|
+
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.";
|
|
12009
|
+
readonly http: "GET";
|
|
12010
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocked_by";
|
|
12011
|
+
readonly streaming: "no";
|
|
12012
|
+
readonly pagination: false;
|
|
12013
|
+
readonly pathParams: readonly [{
|
|
12014
|
+
readonly name: "number";
|
|
12015
|
+
readonly sdkName: "number";
|
|
12016
|
+
}];
|
|
12017
|
+
readonly query: readonly [{
|
|
12018
|
+
readonly name: "repository";
|
|
12019
|
+
readonly type: "string";
|
|
12020
|
+
readonly required: false;
|
|
12021
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12022
|
+
}, {
|
|
12023
|
+
readonly name: "page_size";
|
|
12024
|
+
readonly type: "integer";
|
|
12025
|
+
readonly required: false;
|
|
12026
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
12027
|
+
}, {
|
|
12028
|
+
readonly name: "page_token";
|
|
12029
|
+
readonly type: "string";
|
|
12030
|
+
readonly required: false;
|
|
12031
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
12032
|
+
}];
|
|
12033
|
+
}, {
|
|
12034
|
+
readonly resource: "ticket.tickets.dependencies.blockedBy";
|
|
12035
|
+
readonly method: "create";
|
|
12036
|
+
readonly summary: "Create or add blocked by";
|
|
12037
|
+
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.";
|
|
12038
|
+
readonly http: "POST";
|
|
12039
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocked_by";
|
|
12040
|
+
readonly streaming: "no";
|
|
12041
|
+
readonly pagination: false;
|
|
12042
|
+
readonly pathParams: readonly [{
|
|
12043
|
+
readonly name: "number";
|
|
12044
|
+
readonly sdkName: "number";
|
|
12045
|
+
}];
|
|
12046
|
+
readonly query: readonly [{
|
|
12047
|
+
readonly name: "repository";
|
|
12048
|
+
readonly type: "string";
|
|
12049
|
+
readonly required: false;
|
|
12050
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12051
|
+
}];
|
|
12052
|
+
readonly body: {
|
|
12053
|
+
readonly required: true;
|
|
12054
|
+
readonly fields: readonly [{
|
|
12055
|
+
readonly name: "blocked_by";
|
|
12056
|
+
readonly type: "integer";
|
|
12057
|
+
readonly required: true;
|
|
12058
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
12059
|
+
}];
|
|
12060
|
+
};
|
|
12061
|
+
}, {
|
|
12062
|
+
readonly resource: "ticket.tickets.dependencies.blockedBy";
|
|
12063
|
+
readonly method: "delete";
|
|
12064
|
+
readonly summary: "Remove blocked by";
|
|
12065
|
+
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.";
|
|
12066
|
+
readonly http: "DELETE";
|
|
12067
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocked_by/{n}";
|
|
12068
|
+
readonly streaming: "no";
|
|
12069
|
+
readonly pagination: false;
|
|
12070
|
+
readonly pathParams: readonly [{
|
|
12071
|
+
readonly name: "number";
|
|
12072
|
+
readonly sdkName: "number";
|
|
12073
|
+
}, {
|
|
12074
|
+
readonly name: "n";
|
|
12075
|
+
readonly sdkName: "n";
|
|
12076
|
+
}];
|
|
12077
|
+
readonly query: readonly [{
|
|
12078
|
+
readonly name: "repository";
|
|
12079
|
+
readonly type: "string";
|
|
12080
|
+
readonly required: false;
|
|
12081
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12082
|
+
}];
|
|
12083
|
+
}, {
|
|
12084
|
+
readonly resource: "ticket.tickets.dependencies";
|
|
12085
|
+
readonly method: "retrieveBlocking";
|
|
12086
|
+
readonly summary: "List blocking";
|
|
12087
|
+
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.";
|
|
12088
|
+
readonly http: "GET";
|
|
12089
|
+
readonly path: "/ticket/v1/tickets/{number}/dependencies/blocking";
|
|
12090
|
+
readonly streaming: "no";
|
|
12091
|
+
readonly pagination: false;
|
|
12092
|
+
readonly pathParams: readonly [{
|
|
12093
|
+
readonly name: "number";
|
|
12094
|
+
readonly sdkName: "number";
|
|
12095
|
+
}];
|
|
12096
|
+
readonly query: readonly [{
|
|
12097
|
+
readonly name: "repository";
|
|
12098
|
+
readonly type: "string";
|
|
12099
|
+
readonly required: false;
|
|
12100
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12101
|
+
}, {
|
|
12102
|
+
readonly name: "page_size";
|
|
12103
|
+
readonly type: "integer";
|
|
12104
|
+
readonly required: false;
|
|
12105
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
12106
|
+
}, {
|
|
12107
|
+
readonly name: "page_token";
|
|
12108
|
+
readonly type: "string";
|
|
12109
|
+
readonly required: false;
|
|
12110
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
12111
|
+
}];
|
|
12112
|
+
}, {
|
|
12113
|
+
readonly resource: "ticket.tickets.events";
|
|
12114
|
+
readonly method: "list";
|
|
12115
|
+
readonly summary: "List events";
|
|
12116
|
+
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.";
|
|
12117
|
+
readonly http: "GET";
|
|
12118
|
+
readonly path: "/ticket/v1/tickets/{number}/events";
|
|
12119
|
+
readonly streaming: "no";
|
|
12120
|
+
readonly pagination: false;
|
|
12121
|
+
readonly pathParams: readonly [{
|
|
12122
|
+
readonly name: "number";
|
|
12123
|
+
readonly sdkName: "number";
|
|
12124
|
+
}];
|
|
12125
|
+
readonly query: readonly [{
|
|
12126
|
+
readonly name: "repository";
|
|
12127
|
+
readonly type: "string";
|
|
12128
|
+
readonly required: false;
|
|
12129
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12130
|
+
}, {
|
|
12131
|
+
readonly name: "page_size";
|
|
12132
|
+
readonly type: "integer";
|
|
12133
|
+
readonly required: false;
|
|
12134
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
12135
|
+
}, {
|
|
12136
|
+
readonly name: "page_token";
|
|
12137
|
+
readonly type: "string";
|
|
12138
|
+
readonly required: false;
|
|
12139
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
12140
|
+
}];
|
|
12141
|
+
}, {
|
|
12142
|
+
readonly resource: "ticket.tickets";
|
|
12143
|
+
readonly method: "deleteLock";
|
|
12144
|
+
readonly summary: "Remove lock";
|
|
12145
|
+
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.";
|
|
12146
|
+
readonly http: "DELETE";
|
|
12147
|
+
readonly path: "/ticket/v1/tickets/{number}/lock";
|
|
12148
|
+
readonly streaming: "no";
|
|
12149
|
+
readonly pagination: false;
|
|
12150
|
+
readonly pathParams: readonly [{
|
|
12151
|
+
readonly name: "number";
|
|
12152
|
+
readonly sdkName: "number";
|
|
12153
|
+
}];
|
|
12154
|
+
readonly query: readonly [{
|
|
12155
|
+
readonly name: "repository";
|
|
12156
|
+
readonly type: "string";
|
|
12157
|
+
readonly required: false;
|
|
12158
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12159
|
+
}];
|
|
12160
|
+
}, {
|
|
12161
|
+
readonly resource: "ticket.tickets";
|
|
12162
|
+
readonly method: "updateLock";
|
|
12163
|
+
readonly summary: "Update lock";
|
|
12164
|
+
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.";
|
|
12165
|
+
readonly http: "PUT";
|
|
12166
|
+
readonly path: "/ticket/v1/tickets/{number}/lock";
|
|
12167
|
+
readonly streaming: "no";
|
|
12168
|
+
readonly pagination: false;
|
|
12169
|
+
readonly pathParams: readonly [{
|
|
12170
|
+
readonly name: "number";
|
|
12171
|
+
readonly sdkName: "number";
|
|
12172
|
+
}];
|
|
12173
|
+
readonly query: readonly [{
|
|
12174
|
+
readonly name: "repository";
|
|
12175
|
+
readonly type: "string";
|
|
12176
|
+
readonly required: false;
|
|
12177
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12178
|
+
}];
|
|
12179
|
+
readonly body: {
|
|
12180
|
+
readonly required: false;
|
|
12181
|
+
readonly fields: readonly [{
|
|
12182
|
+
readonly name: "lock_reason";
|
|
12183
|
+
readonly type: "string";
|
|
12184
|
+
readonly enum: readonly ["off-topic", "too heated", "resolved", "spam"];
|
|
12185
|
+
readonly required: false;
|
|
12186
|
+
readonly description: "Reason for locking: off-topic, too heated, resolved, or spam.";
|
|
12187
|
+
}];
|
|
12188
|
+
};
|
|
12189
|
+
}, {
|
|
12190
|
+
readonly resource: "ticket.tickets.reactions";
|
|
12191
|
+
readonly method: "list";
|
|
12192
|
+
readonly summary: "List reactions";
|
|
12193
|
+
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.";
|
|
12194
|
+
readonly http: "GET";
|
|
12195
|
+
readonly path: "/ticket/v1/tickets/{number}/reactions";
|
|
12196
|
+
readonly streaming: "no";
|
|
12197
|
+
readonly pagination: false;
|
|
12198
|
+
readonly pathParams: readonly [{
|
|
12199
|
+
readonly name: "number";
|
|
12200
|
+
readonly sdkName: "number";
|
|
12201
|
+
}];
|
|
12202
|
+
readonly query: readonly [{
|
|
12203
|
+
readonly name: "repository";
|
|
12204
|
+
readonly type: "string";
|
|
12205
|
+
readonly required: false;
|
|
12206
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12207
|
+
}, {
|
|
12208
|
+
readonly name: "page_size";
|
|
12209
|
+
readonly type: "integer";
|
|
12210
|
+
readonly required: false;
|
|
12211
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
12212
|
+
}, {
|
|
12213
|
+
readonly name: "page_token";
|
|
12214
|
+
readonly type: "string";
|
|
12215
|
+
readonly required: false;
|
|
12216
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
12217
|
+
}];
|
|
12218
|
+
}, {
|
|
12219
|
+
readonly resource: "ticket.tickets.reactions";
|
|
12220
|
+
readonly method: "create";
|
|
12221
|
+
readonly summary: "Create or add reactions";
|
|
12222
|
+
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.";
|
|
12223
|
+
readonly http: "POST";
|
|
12224
|
+
readonly path: "/ticket/v1/tickets/{number}/reactions";
|
|
12225
|
+
readonly streaming: "no";
|
|
12226
|
+
readonly pagination: false;
|
|
12227
|
+
readonly pathParams: readonly [{
|
|
12228
|
+
readonly name: "number";
|
|
12229
|
+
readonly sdkName: "number";
|
|
12230
|
+
}];
|
|
12231
|
+
readonly query: readonly [{
|
|
12232
|
+
readonly name: "repository";
|
|
12233
|
+
readonly type: "string";
|
|
12234
|
+
readonly required: false;
|
|
12235
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12236
|
+
}];
|
|
12237
|
+
readonly body: {
|
|
12238
|
+
readonly required: true;
|
|
12239
|
+
readonly fields: readonly [{
|
|
12240
|
+
readonly name: "content";
|
|
12241
|
+
readonly type: "string";
|
|
12242
|
+
readonly enum: readonly ["+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket"];
|
|
12243
|
+
readonly required: true;
|
|
12244
|
+
readonly description: "Reaction to add or remove: +1 approves, -1 disapproves, laugh, confused, heart, hooray, eyes, or rocket.";
|
|
12245
|
+
}];
|
|
12246
|
+
};
|
|
12247
|
+
}, {
|
|
12248
|
+
readonly resource: "ticket.tickets.reactions";
|
|
12249
|
+
readonly method: "delete";
|
|
12250
|
+
readonly summary: "Remove reactions";
|
|
12251
|
+
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.";
|
|
12252
|
+
readonly http: "DELETE";
|
|
12253
|
+
readonly path: "/ticket/v1/tickets/{number}/reactions/{content}";
|
|
12254
|
+
readonly streaming: "no";
|
|
12255
|
+
readonly pagination: false;
|
|
12256
|
+
readonly pathParams: readonly [{
|
|
12257
|
+
readonly name: "number";
|
|
12258
|
+
readonly sdkName: "number";
|
|
12259
|
+
}, {
|
|
12260
|
+
readonly name: "content";
|
|
12261
|
+
readonly sdkName: "content";
|
|
12262
|
+
}];
|
|
12263
|
+
readonly query: readonly [{
|
|
12264
|
+
readonly name: "repository";
|
|
12265
|
+
readonly type: "string";
|
|
12266
|
+
readonly required: false;
|
|
12267
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12268
|
+
}];
|
|
12269
|
+
}, {
|
|
12270
|
+
readonly resource: "ticket.tickets.relations";
|
|
12271
|
+
readonly method: "list";
|
|
12272
|
+
readonly summary: "List relations";
|
|
12273
|
+
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.";
|
|
12274
|
+
readonly http: "GET";
|
|
12275
|
+
readonly path: "/ticket/v1/tickets/{number}/relations";
|
|
12276
|
+
readonly streaming: "no";
|
|
12277
|
+
readonly pagination: false;
|
|
12278
|
+
readonly pathParams: readonly [{
|
|
12279
|
+
readonly name: "number";
|
|
12280
|
+
readonly sdkName: "number";
|
|
12281
|
+
}];
|
|
12282
|
+
readonly query: readonly [{
|
|
12283
|
+
readonly name: "repository";
|
|
12284
|
+
readonly type: "string";
|
|
12285
|
+
readonly required: false;
|
|
12286
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12287
|
+
}, {
|
|
12288
|
+
readonly name: "page_size";
|
|
12289
|
+
readonly type: "integer";
|
|
12290
|
+
readonly required: false;
|
|
12291
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
12292
|
+
}, {
|
|
12293
|
+
readonly name: "page_token";
|
|
12294
|
+
readonly type: "string";
|
|
12295
|
+
readonly required: false;
|
|
12296
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
12297
|
+
}];
|
|
12298
|
+
}, {
|
|
12299
|
+
readonly resource: "ticket.tickets.relations";
|
|
12300
|
+
readonly method: "create";
|
|
12301
|
+
readonly summary: "Create or add relations";
|
|
12302
|
+
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.";
|
|
12303
|
+
readonly http: "POST";
|
|
12304
|
+
readonly path: "/ticket/v1/tickets/{number}/relations";
|
|
12305
|
+
readonly streaming: "no";
|
|
12306
|
+
readonly pagination: false;
|
|
12307
|
+
readonly pathParams: readonly [{
|
|
12308
|
+
readonly name: "number";
|
|
12309
|
+
readonly sdkName: "number";
|
|
12310
|
+
}];
|
|
12311
|
+
readonly query: readonly [{
|
|
12312
|
+
readonly name: "repository";
|
|
12313
|
+
readonly type: "string";
|
|
12314
|
+
readonly required: false;
|
|
12315
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12316
|
+
}];
|
|
12317
|
+
readonly body: {
|
|
12318
|
+
readonly required: true;
|
|
12319
|
+
readonly fields: readonly [{
|
|
12320
|
+
readonly name: "relates_to";
|
|
12321
|
+
readonly type: "integer";
|
|
12322
|
+
readonly required: true;
|
|
12323
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
12324
|
+
}];
|
|
12325
|
+
};
|
|
12326
|
+
}, {
|
|
12327
|
+
readonly resource: "ticket.tickets.relations";
|
|
12328
|
+
readonly method: "delete";
|
|
12329
|
+
readonly summary: "Remove relations";
|
|
12330
|
+
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.";
|
|
12331
|
+
readonly http: "DELETE";
|
|
12332
|
+
readonly path: "/ticket/v1/tickets/{number}/relations/{n}";
|
|
12333
|
+
readonly streaming: "no";
|
|
12334
|
+
readonly pagination: false;
|
|
12335
|
+
readonly pathParams: readonly [{
|
|
12336
|
+
readonly name: "number";
|
|
12337
|
+
readonly sdkName: "number";
|
|
12338
|
+
}, {
|
|
12339
|
+
readonly name: "n";
|
|
12340
|
+
readonly sdkName: "n";
|
|
12341
|
+
}];
|
|
12342
|
+
readonly query: readonly [{
|
|
12343
|
+
readonly name: "repository";
|
|
12344
|
+
readonly type: "string";
|
|
12345
|
+
readonly required: false;
|
|
12346
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12347
|
+
}];
|
|
12348
|
+
}, {
|
|
12349
|
+
readonly resource: "ticket.tickets.subTickets";
|
|
12350
|
+
readonly method: "list";
|
|
12351
|
+
readonly summary: "List sub tickets";
|
|
12352
|
+
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.";
|
|
12353
|
+
readonly http: "GET";
|
|
12354
|
+
readonly path: "/ticket/v1/tickets/{number}/sub_tickets";
|
|
12355
|
+
readonly streaming: "no";
|
|
12356
|
+
readonly pagination: false;
|
|
12357
|
+
readonly pathParams: readonly [{
|
|
12358
|
+
readonly name: "number";
|
|
12359
|
+
readonly sdkName: "number";
|
|
12360
|
+
}];
|
|
12361
|
+
readonly query: readonly [{
|
|
12362
|
+
readonly name: "repository";
|
|
12363
|
+
readonly type: "string";
|
|
12364
|
+
readonly required: false;
|
|
12365
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12366
|
+
}, {
|
|
12367
|
+
readonly name: "page_size";
|
|
12368
|
+
readonly type: "integer";
|
|
12369
|
+
readonly required: false;
|
|
12370
|
+
readonly description: "Records per page; defaults to 30, maximum 100.";
|
|
12371
|
+
}, {
|
|
12372
|
+
readonly name: "page_token";
|
|
12373
|
+
readonly type: "string";
|
|
12374
|
+
readonly required: false;
|
|
12375
|
+
readonly description: "Cursor returned as next_page_token; omit for the first page.";
|
|
12376
|
+
}];
|
|
12377
|
+
}, {
|
|
12378
|
+
readonly resource: "ticket.tickets.subTickets";
|
|
12379
|
+
readonly method: "create";
|
|
12380
|
+
readonly summary: "Create or add sub tickets";
|
|
12381
|
+
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.";
|
|
12382
|
+
readonly http: "POST";
|
|
12383
|
+
readonly path: "/ticket/v1/tickets/{number}/sub_tickets";
|
|
12384
|
+
readonly streaming: "no";
|
|
12385
|
+
readonly pagination: false;
|
|
12386
|
+
readonly pathParams: readonly [{
|
|
12387
|
+
readonly name: "number";
|
|
12388
|
+
readonly sdkName: "number";
|
|
12389
|
+
}];
|
|
12390
|
+
readonly query: readonly [{
|
|
12391
|
+
readonly name: "repository";
|
|
12392
|
+
readonly type: "string";
|
|
12393
|
+
readonly required: false;
|
|
12394
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12395
|
+
}];
|
|
12396
|
+
readonly body: {
|
|
12397
|
+
readonly required: true;
|
|
12398
|
+
readonly fields: readonly [{
|
|
12399
|
+
readonly name: "child";
|
|
12400
|
+
readonly type: "integer";
|
|
12401
|
+
readonly required: true;
|
|
12402
|
+
readonly description: "Repository-local number returned by create or list; distinct from the object's id.";
|
|
12403
|
+
}, {
|
|
12404
|
+
readonly name: "replace_parent";
|
|
12405
|
+
readonly type: "boolean";
|
|
12406
|
+
readonly required: false;
|
|
12407
|
+
readonly description: "Allow replacing an existing parent.";
|
|
12408
|
+
}];
|
|
12409
|
+
};
|
|
12410
|
+
}, {
|
|
12411
|
+
readonly resource: "ticket.tickets.subTickets";
|
|
12412
|
+
readonly method: "delete";
|
|
12413
|
+
readonly summary: "Remove sub tickets";
|
|
12414
|
+
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.";
|
|
12415
|
+
readonly http: "DELETE";
|
|
12416
|
+
readonly path: "/ticket/v1/tickets/{number}/sub_tickets/{child}";
|
|
12417
|
+
readonly streaming: "no";
|
|
12418
|
+
readonly pagination: false;
|
|
12419
|
+
readonly pathParams: readonly [{
|
|
12420
|
+
readonly name: "number";
|
|
12421
|
+
readonly sdkName: "number";
|
|
12422
|
+
}, {
|
|
12423
|
+
readonly name: "child";
|
|
12424
|
+
readonly sdkName: "child";
|
|
12425
|
+
}];
|
|
12426
|
+
readonly query: readonly [{
|
|
12427
|
+
readonly name: "repository";
|
|
12428
|
+
readonly type: "string";
|
|
12429
|
+
readonly required: false;
|
|
12430
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12431
|
+
}];
|
|
12432
|
+
}, {
|
|
12433
|
+
readonly resource: "ticket.types";
|
|
12434
|
+
readonly method: "list";
|
|
12435
|
+
readonly summary: "Read types";
|
|
12436
|
+
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.";
|
|
12437
|
+
readonly http: "GET";
|
|
12438
|
+
readonly path: "/ticket/v1/types";
|
|
12439
|
+
readonly streaming: "no";
|
|
12440
|
+
readonly pagination: false;
|
|
12441
|
+
readonly pathParams: readonly [];
|
|
12442
|
+
readonly query: readonly [{
|
|
12443
|
+
readonly name: "repository";
|
|
12444
|
+
readonly type: "string";
|
|
12445
|
+
readonly required: false;
|
|
12446
|
+
readonly description: "Repository id from GET /ticket/v1/repositories; omit for the default tickets container.";
|
|
12447
|
+
}];
|
|
10962
12448
|
}, {
|
|
10963
12449
|
readonly resource: "vault.authorizations";
|
|
10964
12450
|
readonly method: "create";
|