@deepraxis/sdk 0.1.0-dev.ea77ce8 → 0.1.0-dev.ec3814e
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 +256 -1
- package/dist/core/client.d.ts +9 -1
- package/dist/core/client.js +6 -0
- package/dist/core/transport.d.ts +5 -0
- package/dist/core/transport.js +6 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +540 -40
- package/dist/generated/sdk.gen.js +1571 -83
- package/dist/generated/types.gen.d.ts +30498 -21129
- package/dist/helpers/application-publish.d.ts +24 -4
- package/dist/helpers/application-publish.js +53 -3
- package/dist/helpers/database-count.d.ts +17 -0
- package/dist/helpers/database-count.js +11 -0
- package/dist/helpers/file-upload.d.ts +24 -0
- package/dist/helpers/file-upload.js +113 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +2 -0
- package/dist/operations.generated.d.ts +2151 -83
- package/dist/operations.generated.js +2961 -378
- package/dist/resources.generated.d.ts +1584 -155
- package/dist/resources.generated.js +157 -0
- package/package.json +1 -1
|
@@ -45,7 +45,7 @@ export declare const operations: readonly [{
|
|
|
45
45
|
readonly resource: "agent.agents";
|
|
46
46
|
readonly method: "create";
|
|
47
47
|
readonly summary: "Create agent";
|
|
48
|
-
readonly description: "Create a reusable agent definition, then pass its returned id to sessions.create to start a conversation. The definition includes model, system prompt, tools, MCP servers and an optional multiagent roster. It is saved as version 1; real updates create new versions. Unlike Anthropic Managed Agents, nonempty skills attachments
|
|
48
|
+
readonly description: "Create a reusable agent definition, then pass its returned id to sessions.create to start a conversation. The definition includes model, system prompt, tools, MCP servers and an optional multiagent roster. It is saved as version 1; real updates create new versions. Unlike Anthropic Managed Agents, nonempty skills attachments return 400; the native skill tool is separate from the skills field. Use tools: [{type: \"agent_toolset_20260401\"}] for built-in tools including codemode, skill and agent; inspect toolsets.list for names and schemas, and keep bash enabled for native additions. To offer only some tools, set default_config: {enabled: false} and list the tools to keep in configs, e.g. tools: [{type: \"agent_toolset_20260401\", default_config: {enabled: false}, configs: [{name: \"codemode\", enabled: true}, {name: \"bash\", enabled: true, permission_policy: {type: \"always_ask\"}}]}]; every tool not listed, including todo_write, enter_plan_mode, ask_user_question and goal_read, follows default_config, and the response echoes it. codemode runs through bash, so enabling codemode while bash is disabled returns 400. Optional mcp_toolset entries pair with mcp_servers. model accepts platform model IDs such as deepseek-flash, not only the Claude IDs in the protocol examples. model.settings.reasoning sets default thinking; other extra model controls return 400. Example: {\"name\":\"helper\",\"model\":{\"id\":\"deepseek-flash\"},\"tools\":[{\"type\":\"agent_toolset_20260401\"}]}.";
|
|
49
49
|
readonly http: "POST";
|
|
50
50
|
readonly path: "/agent/v1/agents";
|
|
51
51
|
readonly streaming: "no";
|
|
@@ -74,7 +74,7 @@ export declare const operations: readonly [{
|
|
|
74
74
|
readonly type: "array";
|
|
75
75
|
readonly itemType: "object";
|
|
76
76
|
readonly required: false;
|
|
77
|
-
readonly description: "
|
|
77
|
+
readonly description: "Praxis extension: HTTP, SSE or trusted stdio MCP servers paired with mcp_toolset entries and saved with the agent version.";
|
|
78
78
|
}, {
|
|
79
79
|
readonly name: "metadata";
|
|
80
80
|
readonly type: "object";
|
|
@@ -102,6 +102,12 @@ export declare const operations: readonly [{
|
|
|
102
102
|
readonly itemType: "object";
|
|
103
103
|
readonly required: false;
|
|
104
104
|
readonly description: "Tool configurations available to the agent. Maximum of 128 tools\nacross all toolsets allowed.";
|
|
105
|
+
}, {
|
|
106
|
+
readonly name: "bindings";
|
|
107
|
+
readonly type: "array";
|
|
108
|
+
readonly itemType: "object";
|
|
109
|
+
readonly required: false;
|
|
110
|
+
readonly description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- 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.";
|
|
105
111
|
}, {
|
|
106
112
|
readonly name: "kind";
|
|
107
113
|
readonly type: "string";
|
|
@@ -140,6 +146,28 @@ export declare const operations: readonly [{
|
|
|
140
146
|
readonly type: "object";
|
|
141
147
|
readonly required: false;
|
|
142
148
|
readonly description: "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable.";
|
|
149
|
+
}, {
|
|
150
|
+
readonly name: "avatar";
|
|
151
|
+
readonly type: "string";
|
|
152
|
+
readonly required: false;
|
|
153
|
+
readonly description: "Avatar image of the agent: an absolute https URL of at most 2048 characters, without credentials; any other value returns 400 avatar must be an https URL. It is the default picture in agent lists, the agent detail, the chat header and embedded chat when the embed appearance sets none. Saved with the agent version like other configuration, so apply=false keeps the previous avatar in effect until that version is applied. Omit on create for no avatar; on update, omit to keep it and send null to clear it. Both personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
154
|
+
}, {
|
|
155
|
+
readonly name: "environment_id";
|
|
156
|
+
readonly type: "string";
|
|
157
|
+
readonly required: false;
|
|
158
|
+
readonly description: "Default environment of a service agent: the environment_id a new session gets when it names none. Use light, node22 or the env_ id of an active environment of your organization; any other value returns 400 environment_id <id> was not found. null means no environment, so sessions are plain conversation without codemode or bash. Saved with the agent version like other configuration, so apply=false keeps the previous environment in effect for new sessions until that version is applied; a session that sets environment_id itself, null included, overrides it. Omit on create for light; on update, omit to keep it. Versions saved before this field existed read as light. Personal agents use a Computer: a non-null value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
159
|
+
}, {
|
|
160
|
+
readonly name: "vault_ids";
|
|
161
|
+
readonly type: "array";
|
|
162
|
+
readonly itemType: "string";
|
|
163
|
+
readonly required: false;
|
|
164
|
+
readonly description: "Default vaults of a service agent: the vault_ids a new session gets when it names none, so the agent's credentials follow the version. At most 50 ids without duplicates; each must be a vault of your organization that is not archived, otherwise 400 vault_ids[<index>] <id> was not found. Saved with the agent version like other configuration, so apply=false keeps the previous vaults in effect for new sessions until that version is applied; a session that sets vault_ids itself, [] included, overrides it. Omit on create for []; on update, omit to keep the list and send an array to replace it as a whole. Versions saved before this field existed read as []. Embed tokens use the vault_ids of the version they pin; vault_ids on the embed policy is deprecated, still accepted and ignored. Personal agents get no default vaults: a non-empty value returns 400 and the field is not returned. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
165
|
+
}, {
|
|
166
|
+
readonly name: "preset";
|
|
167
|
+
readonly type: "string";
|
|
168
|
+
readonly enum: readonly ["minimal", "data-editor", "full"];
|
|
169
|
+
readonly required: false;
|
|
170
|
+
readonly description: "Optional tool preset. minimal enables read, glob, grep and ask_user_question; data-editor also enables write and edit; full uses the default toolset with always_allow. Explicit tools override matching preset entries. codemode requires bash and is absent from data-editor.";
|
|
143
171
|
}];
|
|
144
172
|
};
|
|
145
173
|
}, {
|
|
@@ -165,7 +193,7 @@ export declare const operations: readonly [{
|
|
|
165
193
|
readonly resource: "agent.agents";
|
|
166
194
|
readonly method: "update";
|
|
167
195
|
readonly summary: "Update agent";
|
|
168
|
-
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.";
|
|
169
197
|
readonly http: "POST";
|
|
170
198
|
readonly path: "/agent/v1/agents/{agent_id}";
|
|
171
199
|
readonly streaming: "no";
|
|
@@ -187,7 +215,7 @@ export declare const operations: readonly [{
|
|
|
187
215
|
readonly type: "array";
|
|
188
216
|
readonly itemType: "object";
|
|
189
217
|
readonly required: false;
|
|
190
|
-
readonly description: "
|
|
218
|
+
readonly description: "Praxis extension: HTTP, SSE or trusted stdio MCP servers paired with mcp_toolset entries and saved with the agent version.";
|
|
191
219
|
}, {
|
|
192
220
|
readonly name: "metadata";
|
|
193
221
|
readonly type: "object";
|
|
@@ -230,6 +258,22 @@ export declare const operations: readonly [{
|
|
|
230
258
|
readonly type: "number";
|
|
231
259
|
readonly required: false;
|
|
232
260
|
readonly description: "The agent's current version, used to prevent concurrent overwrites.\nObtain this value from a create or retrieve response. Must be at least 1 if\nspecified. When supplied, the request fails if it does not match the server's\ncurrent version; omit to apply the update unconditionally.";
|
|
261
|
+
}, {
|
|
262
|
+
readonly name: "apply";
|
|
263
|
+
readonly type: "boolean";
|
|
264
|
+
readonly required: false;
|
|
265
|
+
readonly description: "Defaults to true: apply the newly saved version, or the latest version when configuration is unchanged. Set false to save without changing active_version. Unlike Managed Agents, saving and applying can be separate.";
|
|
266
|
+
}, {
|
|
267
|
+
readonly name: "version_note";
|
|
268
|
+
readonly type: "string";
|
|
269
|
+
readonly required: false;
|
|
270
|
+
readonly description: "Optional change explanation stored as note on the new immutable version, up to 280 characters. Omission stores null. A note alone does not create a version or rewrite an existing note.";
|
|
271
|
+
}, {
|
|
272
|
+
readonly name: "bindings";
|
|
273
|
+
readonly type: "array";
|
|
274
|
+
readonly itemType: "object";
|
|
275
|
+
readonly required: false;
|
|
276
|
+
readonly description: "Replace the whole bindings list; omission preserves it, and null or [] clears it. Additions apply only to new sessions; 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.";
|
|
233
277
|
}, {
|
|
234
278
|
readonly name: "kind";
|
|
235
279
|
readonly type: "string";
|
|
@@ -268,6 +312,28 @@ export declare const operations: readonly [{
|
|
|
268
312
|
readonly type: "object";
|
|
269
313
|
readonly required: false;
|
|
270
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.";
|
|
331
|
+
}, {
|
|
332
|
+
readonly name: "preset";
|
|
333
|
+
readonly type: "string";
|
|
334
|
+
readonly enum: readonly ["minimal", "data-editor", "full"];
|
|
335
|
+
readonly required: false;
|
|
336
|
+
readonly description: "Optional tool preset. minimal enables read, glob, grep and ask_user_question; data-editor also enables write and edit; full uses the default toolset with always_allow. Explicit tools override matching preset entries. codemode requires bash and is absent from data-editor.";
|
|
271
337
|
}];
|
|
272
338
|
};
|
|
273
339
|
}, {
|
|
@@ -284,6 +350,271 @@ export declare const operations: readonly [{
|
|
|
284
350
|
readonly sdkName: "agent_id";
|
|
285
351
|
}];
|
|
286
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
|
+
};
|
|
468
|
+
}, {
|
|
469
|
+
readonly resource: "agent.agents.endUsers";
|
|
470
|
+
readonly method: "list";
|
|
471
|
+
readonly summary: "List End Users";
|
|
472
|
+
readonly description: "List users who have sessions or token issuance history on a service agent.\n\nOrdered by last_active_at and external_user_id descending. q is a case-sensitive literal prefix, including underscores. limit is 1–100, default 20. Reuse next_page with the same organization, agent, q and limit. Preemptively blocked users without history do not appear. End-user credentials and inaccessible or personal agents return 404.";
|
|
473
|
+
readonly http: "GET";
|
|
474
|
+
readonly path: "/agent/v1/agents/{agent_id}/end_users";
|
|
475
|
+
readonly streaming: "no";
|
|
476
|
+
readonly pagination: false;
|
|
477
|
+
readonly pathParams: readonly [{
|
|
478
|
+
readonly name: "agent_id";
|
|
479
|
+
readonly sdkName: "agent_id";
|
|
480
|
+
}];
|
|
481
|
+
readonly query: readonly [{
|
|
482
|
+
readonly name: "limit";
|
|
483
|
+
readonly type: "integer";
|
|
484
|
+
readonly required: false;
|
|
485
|
+
readonly description: "Maximum users per page; defaults to 20.";
|
|
486
|
+
}, {
|
|
487
|
+
readonly name: "page";
|
|
488
|
+
readonly type: "string";
|
|
489
|
+
readonly required: false;
|
|
490
|
+
readonly description: "next_page from the previous response with the same agent, q and limit.";
|
|
491
|
+
}, {
|
|
492
|
+
readonly name: "q";
|
|
493
|
+
readonly type: "string";
|
|
494
|
+
readonly required: false;
|
|
495
|
+
readonly description: "Case-sensitive literal prefix of external_user_id; omit or use an empty string for all users.";
|
|
496
|
+
}];
|
|
497
|
+
}, {
|
|
498
|
+
readonly resource: "agent.agents.endUsers";
|
|
499
|
+
readonly method: "delete";
|
|
500
|
+
readonly summary: "Delete end-user data";
|
|
501
|
+
readonly description: "Delete a host application's end-user data from one service agent after explicit confirmation.\n\nDevelop only. Set confirm to the exact external_user_id; missing or mismatched confirmation returns 400. Returns 202 with a pending task id, not completion. Poll the deletion endpoint. Concurrent requests reuse the unfinished task; retry DELETE after failure to resume it. Tokens are revoked and the user is blocked before a seven-day recovery snapshot is verified. Sessions including child sessions, conversation data, grants and feedback are then removed. A pre-existing block remains; a temporary block is removed on success. Attachment metadata is recorded and File attachments are retained. No charge is introduced by this operation. Example: DELETE /agent/v1/agents/agent_example/end_users/customer_123?confirm=customer_123.";
|
|
502
|
+
readonly http: "DELETE";
|
|
503
|
+
readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}";
|
|
504
|
+
readonly streaming: "no";
|
|
505
|
+
readonly pagination: false;
|
|
506
|
+
readonly pathParams: readonly [{
|
|
507
|
+
readonly name: "agent_id";
|
|
508
|
+
readonly sdkName: "agent_id";
|
|
509
|
+
}, {
|
|
510
|
+
readonly name: "external_user_id";
|
|
511
|
+
readonly sdkName: "external_user_id";
|
|
512
|
+
}];
|
|
513
|
+
readonly query: readonly [{
|
|
514
|
+
readonly name: "confirm";
|
|
515
|
+
readonly type: "string";
|
|
516
|
+
readonly required: true;
|
|
517
|
+
readonly description: "Must exactly equal the external_user_id path parameter to confirm destructive deletion.";
|
|
518
|
+
}];
|
|
519
|
+
}, {
|
|
520
|
+
readonly resource: "agent.agents.endUsers";
|
|
521
|
+
readonly method: "retrieve";
|
|
522
|
+
readonly summary: "Get End User";
|
|
523
|
+
readonly description: "Inspect one end user and their twenty most recently updated sessions.\n\nUse external_user_id from listing or your host application. Users without session or issuance history return 404, including preemptively blocked users. End-user credentials and inaccessible or personal agents return 404.";
|
|
524
|
+
readonly http: "GET";
|
|
525
|
+
readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}";
|
|
526
|
+
readonly streaming: "no";
|
|
527
|
+
readonly pagination: false;
|
|
528
|
+
readonly pathParams: readonly [{
|
|
529
|
+
readonly name: "agent_id";
|
|
530
|
+
readonly sdkName: "agent_id";
|
|
531
|
+
}, {
|
|
532
|
+
readonly name: "external_user_id";
|
|
533
|
+
readonly sdkName: "external_user_id";
|
|
534
|
+
}];
|
|
535
|
+
readonly query: readonly [];
|
|
536
|
+
}, {
|
|
537
|
+
readonly resource: "agent.agents.endUsers.block";
|
|
538
|
+
readonly method: "create";
|
|
539
|
+
readonly summary: "Block End User";
|
|
540
|
+
readonly description: "Block token issuance and session creation, then revoke existing tokens for an end user.\n\nMay block a user before any history exists; timestamps are then null and counts and cost are zero. Requires an embed policy, otherwise returns 409 with setup guidance. Deduplicates the policy blocklist and retains its 1000-user maximum. If revocation returns 502, the user remains blocked; retry to finish revocation. Repeats keep the user blocked and revoke any remaining grants. End-user credentials and inaccessible or personal agents return 404.";
|
|
541
|
+
readonly http: "POST";
|
|
542
|
+
readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}/block";
|
|
543
|
+
readonly streaming: "no";
|
|
544
|
+
readonly pagination: false;
|
|
545
|
+
readonly pathParams: readonly [{
|
|
546
|
+
readonly name: "agent_id";
|
|
547
|
+
readonly sdkName: "agent_id";
|
|
548
|
+
}, {
|
|
549
|
+
readonly name: "external_user_id";
|
|
550
|
+
readonly sdkName: "external_user_id";
|
|
551
|
+
}];
|
|
552
|
+
readonly query: readonly [];
|
|
553
|
+
}, {
|
|
554
|
+
readonly resource: "agent.agents.endUsers";
|
|
555
|
+
readonly method: "retrieveDeletion";
|
|
556
|
+
readonly summary: "Get end-user deletion";
|
|
557
|
+
readonly description: "Poll the latest deletion task for an end user, including after the user data has been removed.\n\nUse the same agent_id and external_user_id as the confirmed DELETE. Status is pending, snapshotting, deleting, done or failed. Counts are empty until a verified snapshot exists. A failed task remains blocked and resumes when DELETE is retried with matching confirmation. snapshot_key is an operator recovery reference retained for seven days, not a public download URL. End-user credentials, inaccessible or personal agents, and missing tasks return 404. This read does not create a task or charge usage.";
|
|
558
|
+
readonly http: "GET";
|
|
559
|
+
readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}/deletion";
|
|
560
|
+
readonly streaming: "no";
|
|
561
|
+
readonly pagination: false;
|
|
562
|
+
readonly pathParams: readonly [{
|
|
563
|
+
readonly name: "agent_id";
|
|
564
|
+
readonly sdkName: "agent_id";
|
|
565
|
+
}, {
|
|
566
|
+
readonly name: "external_user_id";
|
|
567
|
+
readonly sdkName: "external_user_id";
|
|
568
|
+
}];
|
|
569
|
+
readonly query: readonly [];
|
|
570
|
+
}, {
|
|
571
|
+
readonly resource: "agent.agents.endUsers.revokeTokens";
|
|
572
|
+
readonly method: "create";
|
|
573
|
+
readonly summary: "Revoke End User Tokens";
|
|
574
|
+
readonly description: "Revoke all issued tokens for an end user and terminate their open embed streams.\n\nRevokes credentials before marking grants revoked. Upstream failure returns 502 without changing grant revocation timestamps. Returns the count of newly revoked grants; a repeat without new grants returns zero. Does not block future issuance. End-user credentials and inaccessible or personal agents return 404.";
|
|
575
|
+
readonly http: "POST";
|
|
576
|
+
readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}/revoke_tokens";
|
|
577
|
+
readonly streaming: "no";
|
|
578
|
+
readonly pagination: false;
|
|
579
|
+
readonly pathParams: readonly [{
|
|
580
|
+
readonly name: "agent_id";
|
|
581
|
+
readonly sdkName: "agent_id";
|
|
582
|
+
}, {
|
|
583
|
+
readonly name: "external_user_id";
|
|
584
|
+
readonly sdkName: "external_user_id";
|
|
585
|
+
}];
|
|
586
|
+
readonly query: readonly [];
|
|
587
|
+
}, {
|
|
588
|
+
readonly resource: "agent.agents.endUsers.unblock";
|
|
589
|
+
readonly method: "create";
|
|
590
|
+
readonly summary: "Unblock End User";
|
|
591
|
+
readonly description: "Allow an end user to receive new tokens and create new sessions again.\n\nRemoves the user from the blocklist; previously revoked tokens stay revoked. Idempotent. Requires an embed policy, otherwise returns 409 with setup guidance. Returns null timestamps and zero counts and cost when no session or issuance history exists. End-user credentials and inaccessible or personal agents return 404.";
|
|
592
|
+
readonly http: "POST";
|
|
593
|
+
readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}/unblock";
|
|
594
|
+
readonly streaming: "no";
|
|
595
|
+
readonly pagination: false;
|
|
596
|
+
readonly pathParams: readonly [{
|
|
597
|
+
readonly name: "agent_id";
|
|
598
|
+
readonly sdkName: "agent_id";
|
|
599
|
+
}, {
|
|
600
|
+
readonly name: "external_user_id";
|
|
601
|
+
readonly sdkName: "external_user_id";
|
|
602
|
+
}];
|
|
603
|
+
readonly query: readonly [];
|
|
604
|
+
}, {
|
|
605
|
+
readonly resource: "agent.agents.unarchive";
|
|
606
|
+
readonly method: "create";
|
|
607
|
+
readonly summary: "Unarchive Agent";
|
|
608
|
+
readonly description: "Restore an archived agent without creating a configuration version. Already active agents are unchanged. Missing or inaccessible agents return 404. Use the returned agent id to create new sessions.";
|
|
609
|
+
readonly http: "POST";
|
|
610
|
+
readonly path: "/agent/v1/agents/{agent_id}/unarchive";
|
|
611
|
+
readonly streaming: "no";
|
|
612
|
+
readonly pagination: false;
|
|
613
|
+
readonly pathParams: readonly [{
|
|
614
|
+
readonly name: "agent_id";
|
|
615
|
+
readonly sdkName: "agent_id";
|
|
616
|
+
}];
|
|
617
|
+
readonly query: readonly [];
|
|
287
618
|
}, {
|
|
288
619
|
readonly resource: "agent.agents.versions";
|
|
289
620
|
readonly method: "list";
|
|
@@ -308,6 +639,23 @@ export declare const operations: readonly [{
|
|
|
308
639
|
readonly required: false;
|
|
309
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.";
|
|
310
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 [];
|
|
311
659
|
}, {
|
|
312
660
|
readonly resource: "agent.computers";
|
|
313
661
|
readonly method: "list";
|
|
@@ -446,7 +794,7 @@ export declare const operations: readonly [{
|
|
|
446
794
|
readonly resource: "agent.computers";
|
|
447
795
|
readonly method: "connect";
|
|
448
796
|
readonly summary: "Connect computer";
|
|
449
|
-
readonly description: "Resume the computer and issue a sandbox connection.\n\nOwn-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.";
|
|
797
|
+
readonly description: "Resume the computer and issue a sandbox connection.\n\nOwn-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id, plus the machine tier the computer is on now (light or heavy) and the lease that keeps it there (lease_id, lease_expires_at; lease_id is null when no lease exists). Keep the lease while the connection stays open: renew it about every 20 seconds (POST .../leases/{lease_id}/renew) and release it on close (DELETE .../leases/{lease_id}). An unrenewed lease simply expires, and the full machine is reclaimed only after that. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.\n\nConnect to a computer with a caller-held lease. Omit the body or send {} to request light: the lightweight shell, or the heavy instance while it is running. Send {\"need\":\"heavy\"} to request full Linux for interactive programs; files are synchronized before the heavy connection is returned with tier heavy. Renew the lease while using the connection and release it with DELETE when finished.";
|
|
450
798
|
readonly http: "POST";
|
|
451
799
|
readonly path: "/agent/v1/computers/{computer_id}/connect";
|
|
452
800
|
readonly streaming: "no";
|
|
@@ -456,6 +804,16 @@ export declare const operations: readonly [{
|
|
|
456
804
|
readonly sdkName: "computer_id";
|
|
457
805
|
}];
|
|
458
806
|
readonly query: readonly [];
|
|
807
|
+
readonly body: {
|
|
808
|
+
readonly required: false;
|
|
809
|
+
readonly fields: readonly [{
|
|
810
|
+
readonly name: "need";
|
|
811
|
+
readonly type: "string";
|
|
812
|
+
readonly enum: readonly ["light", "heavy"];
|
|
813
|
+
readonly required: false;
|
|
814
|
+
readonly description: "Defaults to light. light uses the lightweight shell, or the heavy instance while it is running. heavy requests a full Linux computer for interactive programs; heavy running time counts toward the daily budget in seconds.";
|
|
815
|
+
}];
|
|
816
|
+
};
|
|
459
817
|
}, {
|
|
460
818
|
readonly resource: "agent.computers.files";
|
|
461
819
|
readonly method: "list";
|
|
@@ -494,6 +852,40 @@ export declare const operations: readonly [{
|
|
|
494
852
|
readonly required: true;
|
|
495
853
|
readonly description: "Absolute path of the file whose content to download, as returned in the path field of computers.files.list.";
|
|
496
854
|
}];
|
|
855
|
+
}, {
|
|
856
|
+
readonly resource: "agent.computers.leases";
|
|
857
|
+
readonly method: "delete";
|
|
858
|
+
readonly summary: "Release computer lease";
|
|
859
|
+
readonly description: "Give the lease back when a connection closes so the full machine can be reclaimed without waiting for it to expire.\n\nOwn-face extension. Idempotent: an unknown or already released lease succeeds as well. Foreign or absent computers return 404.";
|
|
860
|
+
readonly http: "DELETE";
|
|
861
|
+
readonly path: "/agent/v1/computers/{computer_id}/leases/{lease_id}";
|
|
862
|
+
readonly streaming: "no";
|
|
863
|
+
readonly pagination: false;
|
|
864
|
+
readonly pathParams: readonly [{
|
|
865
|
+
readonly name: "computer_id";
|
|
866
|
+
readonly sdkName: "computer_id";
|
|
867
|
+
}, {
|
|
868
|
+
readonly name: "lease_id";
|
|
869
|
+
readonly sdkName: "lease_id";
|
|
870
|
+
}];
|
|
871
|
+
readonly query: readonly [];
|
|
872
|
+
}, {
|
|
873
|
+
readonly resource: "agent.computers.leases.renew";
|
|
874
|
+
readonly method: "create";
|
|
875
|
+
readonly summary: "Renew computer lease";
|
|
876
|
+
readonly description: "Extend the lease a connection holds so the full machine stays in service while the connection is open.\n\nOwn-face extension. A lease that is no longer valid (released, expired, or the computer moved to another machine) returns 409 LEASE_STALE; call connect again for a new connection and lease. Foreign or absent computers return 404.";
|
|
877
|
+
readonly http: "POST";
|
|
878
|
+
readonly path: "/agent/v1/computers/{computer_id}/leases/{lease_id}/renew";
|
|
879
|
+
readonly streaming: "no";
|
|
880
|
+
readonly pagination: false;
|
|
881
|
+
readonly pathParams: readonly [{
|
|
882
|
+
readonly name: "computer_id";
|
|
883
|
+
readonly sdkName: "computer_id";
|
|
884
|
+
}, {
|
|
885
|
+
readonly name: "lease_id";
|
|
886
|
+
readonly sdkName: "lease_id";
|
|
887
|
+
}];
|
|
888
|
+
readonly query: readonly [];
|
|
497
889
|
}, {
|
|
498
890
|
readonly resource: "agent.deploymentRuns";
|
|
499
891
|
readonly method: "list";
|
|
@@ -833,6 +1225,37 @@ export declare const operations: readonly [{
|
|
|
833
1225
|
readonly sdkName: "deployment_id";
|
|
834
1226
|
}];
|
|
835
1227
|
readonly query: readonly [];
|
|
1228
|
+
}, {
|
|
1229
|
+
readonly resource: "agent.embed";
|
|
1230
|
+
readonly method: "retrieveAppearance";
|
|
1231
|
+
readonly summary: "Read chat appearance";
|
|
1232
|
+
readonly description: "Load saved appearance for an iframe or Hosted chat page. Supply an end-user embed token as Bearer authorization, or a console-issued publishable key in Praxis-Publishable-Key before anonymous token issuance. The credential selects the agent; identity_number and agent_id query parameters are rejected with 400. Missing appearance returns an empty object. Kit option names retain camelCase. Responses are private and cacheable for 60 seconds. Component hosts configure Kit in their own code instead.";
|
|
1233
|
+
readonly http: "GET";
|
|
1234
|
+
readonly path: "/agent/v1/embed/appearance";
|
|
1235
|
+
readonly streaming: "no";
|
|
1236
|
+
readonly pagination: false;
|
|
1237
|
+
readonly pathParams: readonly [];
|
|
1238
|
+
readonly query: readonly [];
|
|
1239
|
+
}, {
|
|
1240
|
+
readonly resource: "agent.embed.exchange";
|
|
1241
|
+
readonly method: "create";
|
|
1242
|
+
readonly summary: "Exchange Hosted Code";
|
|
1243
|
+
readonly description: "Redeem a single-use hosted link credential for an end-user token.\n\nRead code from the c fragment parameter of hosted_url returned by embed token creation with hosted true, then remove the fragment before exchanging. No Authorization header is required; the code authenticates this request. The code expires after 60 seconds and is consumed atomically on exchange, so concurrent attempts have only one winner. Expired, used and unknown codes return the same 404 body. Keep the token in memory and return to the host website for a fresh link when it expires; exchange cannot refresh it. Requests are IP limited per minute using the anonymous entrypoint budget (default 20). Example body is {\"code\":\"<code from hosted_url>\"}.";
|
|
1244
|
+
readonly http: "POST";
|
|
1245
|
+
readonly path: "/agent/v1/embed/exchange";
|
|
1246
|
+
readonly streaming: "no";
|
|
1247
|
+
readonly pagination: false;
|
|
1248
|
+
readonly pathParams: readonly [];
|
|
1249
|
+
readonly query: readonly [];
|
|
1250
|
+
readonly body: {
|
|
1251
|
+
readonly required: true;
|
|
1252
|
+
readonly fields: readonly [{
|
|
1253
|
+
readonly name: "code";
|
|
1254
|
+
readonly type: "string";
|
|
1255
|
+
readonly required: true;
|
|
1256
|
+
readonly description: "Single-use credential from the c fragment parameter of hosted_url returned by embed token creation. Valid for 60 seconds.";
|
|
1257
|
+
}];
|
|
1258
|
+
};
|
|
836
1259
|
}, {
|
|
837
1260
|
readonly resource: "agent.embedTokens";
|
|
838
1261
|
readonly method: "list";
|
|
@@ -868,7 +1291,7 @@ export declare const operations: readonly [{
|
|
|
868
1291
|
readonly resource: "agent.embedTokens";
|
|
869
1292
|
readonly method: "create";
|
|
870
1293
|
readonly summary: "Create Embed Token";
|
|
871
|
-
readonly description: "Issue a short-lived credential on your backend for an end user of a service agent.\n\nRequires an active service agent in your organization with an embed policy. Pins the requested version or the latest version and snapshots the policy environment, vaults and resources; metadata comes from the request. Blocked users cannot receive tokens. Keep your API key on the backend and pass only the returned token to the frontend. Every call creates a new grant; issuance is not idempotent.
|
|
1294
|
+
readonly description: "Issue a short-lived credential on your backend for an end user of a service agent.\n\nRequires an active service agent in your organization with an embed policy. Pins the requested version or the latest version and snapshots the policy environment, vaults and resources; metadata comes from the request. Blocked users cannot receive tokens. Keep your API key on the backend and pass only the returned token to the frontend. Every call creates a new grant; issuance is not idempotent. Set hosted to true to also receive hosted_url; redirect the user there within 60 seconds. The agent must have an identity_number. The URL fragment contains a single-use exchange credential, not the token. Omit hosted or set false for ordinary token issuance.";
|
|
872
1295
|
readonly http: "POST";
|
|
873
1296
|
readonly path: "/agent/v1/embed_tokens";
|
|
874
1297
|
readonly streaming: "no";
|
|
@@ -878,6 +1301,11 @@ export declare const operations: readonly [{
|
|
|
878
1301
|
readonly body: {
|
|
879
1302
|
readonly required: true;
|
|
880
1303
|
readonly fields: readonly [{
|
|
1304
|
+
readonly name: "hosted";
|
|
1305
|
+
readonly type: "boolean";
|
|
1306
|
+
readonly required: false;
|
|
1307
|
+
readonly description: "Set true to also return a hosted chat URL with a single-use credential valid for 60 seconds. Defaults to false; the agent must have an identity_number.";
|
|
1308
|
+
}, {
|
|
881
1309
|
readonly name: "agent";
|
|
882
1310
|
readonly type: "string";
|
|
883
1311
|
readonly required: true;
|
|
@@ -926,6 +1354,31 @@ export declare const operations: readonly [{
|
|
|
926
1354
|
readonly description: "Host metadata preserved verbatim; at most 16 keys of 1–64 characters and string values of at most 512 characters. Defaults to an empty object.";
|
|
927
1355
|
}];
|
|
928
1356
|
};
|
|
1357
|
+
}, {
|
|
1358
|
+
readonly resource: "agent.embedTokens.anonymous";
|
|
1359
|
+
readonly method: "create";
|
|
1360
|
+
readonly summary: "Issue anonymous visitor token";
|
|
1361
|
+
readonly description: "Obtain a short-lived embedding token for a visitor without an account using the agent owner's publishable key.\n\nNo Authorization header is required. Send the browser Origin allowed by the agent policy. Save a returned visitor_secret and reuse it for refreshes; only new visitors receive one. Unknown secrets create new visitors, and extra fields including visitor_id return 400. Issuance uses the key creator's organization membership, the key session budget and the smaller of the policy TTL maximum and 3600 seconds. IP requests are limited per minute (default 20); UTC daily session and spending caps are checked across the key's primary sessions created that day. Token issuance itself does not create a session or charge usage; subsequent sessions bill the host organization. Example body: {\"publishable_key\":\"pk_praxis_example\"}.";
|
|
1362
|
+
readonly http: "POST";
|
|
1363
|
+
readonly path: "/agent/v1/embed_tokens/anonymous";
|
|
1364
|
+
readonly streaming: "no";
|
|
1365
|
+
readonly pagination: false;
|
|
1366
|
+
readonly pathParams: readonly [];
|
|
1367
|
+
readonly query: readonly [];
|
|
1368
|
+
readonly body: {
|
|
1369
|
+
readonly required: true;
|
|
1370
|
+
readonly fields: readonly [{
|
|
1371
|
+
readonly name: "publishable_key";
|
|
1372
|
+
readonly type: "string";
|
|
1373
|
+
readonly required: true;
|
|
1374
|
+
readonly description: "Public key created by the service agent owner; safe to include in browser code.";
|
|
1375
|
+
}, {
|
|
1376
|
+
readonly name: "visitor_secret";
|
|
1377
|
+
readonly type: "string";
|
|
1378
|
+
readonly required: false;
|
|
1379
|
+
readonly description: "Secret returned by a previous anonymous issuance for this key. Omit for a new visitor; an unknown secret creates a new visitor.";
|
|
1380
|
+
}];
|
|
1381
|
+
};
|
|
929
1382
|
}, {
|
|
930
1383
|
readonly resource: "agent.embedTokens.revoke";
|
|
931
1384
|
readonly method: "create";
|
|
@@ -1159,12 +1612,23 @@ export declare const operations: readonly [{
|
|
|
1159
1612
|
readonly type: "string";
|
|
1160
1613
|
readonly required: false;
|
|
1161
1614
|
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.";
|
|
1615
|
+
}, {
|
|
1616
|
+
readonly name: "external_user_id";
|
|
1617
|
+
readonly type: "string";
|
|
1618
|
+
readonly required: false;
|
|
1619
|
+
readonly description: "Filter by an exact end-user identifier (1–128 characters: A-Z, a-z, 0-9, underscore, dot, colon, at sign or hyphen). Keep this filter unchanged when following page.";
|
|
1620
|
+
}, {
|
|
1621
|
+
readonly name: "source";
|
|
1622
|
+
readonly type: "string";
|
|
1623
|
+
readonly enum: readonly ["kit", "iframe", "hosted", "api", "automation"];
|
|
1624
|
+
readonly required: false;
|
|
1625
|
+
readonly description: "Filter by session origin: kit, iframe, hosted, api or automation. Keep this filter unchanged when following page.";
|
|
1162
1626
|
}];
|
|
1163
1627
|
}, {
|
|
1164
1628
|
readonly resource: "agent.sessions";
|
|
1165
1629
|
readonly method: "create";
|
|
1166
1630
|
readonly summary: "Create session";
|
|
1167
|
-
readonly description: "Create a session: one conversation with an agent
|
|
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.";
|
|
1168
1632
|
readonly http: "POST";
|
|
1169
1633
|
readonly path: "/agent/v1/sessions";
|
|
1170
1634
|
readonly streaming: "no";
|
|
@@ -1182,7 +1646,7 @@ export declare const operations: readonly [{
|
|
|
1182
1646
|
readonly name: "environment_id";
|
|
1183
1647
|
readonly type: "string";
|
|
1184
1648
|
readonly required: false;
|
|
1185
|
-
readonly description: "
|
|
1649
|
+
readonly description: "Execution environment id from agent.environments.list or agent.environments.create. For a service agent, omission selects the built-in light environment and returns session.environment_id=light; explicit null allocates no machine and makes machine tools, including codemode and bash, unavailable. Personal agents use their selected Computer.";
|
|
1186
1650
|
}, {
|
|
1187
1651
|
readonly name: "budget";
|
|
1188
1652
|
readonly type: "object";
|
|
@@ -1243,6 +1707,20 @@ export declare const operations: readonly [{
|
|
|
1243
1707
|
readonly description: "Praxis extension: explicit session thinking effort; null inherits the pinned agent default, then the model default. none disables thinking only when model.thinking.can_disable is true. Unsupported efforts return 400 invalid_request_error.";
|
|
1244
1708
|
}];
|
|
1245
1709
|
};
|
|
1710
|
+
}, {
|
|
1711
|
+
readonly resource: "agent.sessions";
|
|
1712
|
+
readonly method: "delete";
|
|
1713
|
+
readonly summary: "Delete session";
|
|
1714
|
+
readonly description: "Delete an idle or terminated session and its event history after saving a deletion snapshot. Supply the session id from creation or listing. Running sessions return 409 INVALID_STATE: interrupt first or wait until idle or terminated. Afterwards retrieval and event listing return 404 and lists omit the session. Example: DELETE /agent/v1/sessions/sesn_example.";
|
|
1715
|
+
readonly http: "DELETE";
|
|
1716
|
+
readonly path: "/agent/v1/sessions/{session_id}";
|
|
1717
|
+
readonly streaming: "no";
|
|
1718
|
+
readonly pagination: false;
|
|
1719
|
+
readonly pathParams: readonly [{
|
|
1720
|
+
readonly name: "session_id";
|
|
1721
|
+
readonly sdkName: "session_id";
|
|
1722
|
+
}];
|
|
1723
|
+
readonly query: readonly [];
|
|
1246
1724
|
}, {
|
|
1247
1725
|
readonly resource: "agent.sessions";
|
|
1248
1726
|
readonly method: "retrieve";
|
|
@@ -1455,7 +1933,7 @@ export declare const operations: readonly [{
|
|
|
1455
1933
|
readonly resource: "agent.sessions.events";
|
|
1456
1934
|
readonly method: "list";
|
|
1457
1935
|
readonly summary: "List session events";
|
|
1458
|
-
readonly description: "Read the event history of a session as a page of events, oldest first by default (order=desc for newest first). Use it after sending a message to collect the reply, to find tool calls that wait for approval (session.status_idle with stop_reason requires_action lists their event_ids), or to audit a run; to follow a running session live use sessions.events.stream instead. Filter by types and by a created_at range on processed_at; pages hold at most 100 events (default 20) and next_page continues. A failed run emits session.error before session.status_terminated. Native history also includes user.steer, user.withdraw, system.notification, session.forked, session.goal_changed and session.goal_verification; these are not accepted by the /anthropic/v1 event-type filter.";
|
|
1936
|
+
readonly description: "Read the event history of a session as a page of events, oldest first by default (order=desc for newest first). Use it after sending a message to collect the reply, to find tool calls that wait for approval or client custom tool results (session.status_idle with stop_reason requires_action lists their event_ids), or to audit a run; to follow a running session live use sessions.events.stream instead. Filter by types and by a created_at range on processed_at; pages hold at most 100 events (default 20) and next_page continues. A failed run emits session.error before session.status_terminated. Native history also includes user.steer, user.withdraw, system.notification, session.forked, session.goal_changed and session.goal_verification; these are not accepted by the /anthropic/v1 event-type filter.";
|
|
1459
1937
|
readonly http: "GET";
|
|
1460
1938
|
readonly path: "/agent/v1/sessions/{session_id}/events";
|
|
1461
1939
|
readonly streaming: "no";
|
|
@@ -1511,7 +1989,7 @@ export declare const operations: readonly [{
|
|
|
1511
1989
|
readonly resource: "agent.sessions.events";
|
|
1512
1990
|
readonly method: "send";
|
|
1513
1991
|
readonly summary: "Send session events";
|
|
1514
|
-
readonly description: "Send events to a session: user.message (exactly one nonempty text block), user.interrupt, user.tool_confirmation to allow or deny a pending tool call, user.steer to inject a queued user.message into a turn that is still running, and user.withdraw to retract a queued message. The response only acknowledges the inputs; read replies with sessions.events.list or sessions.events.stream. A message sent while the session waits for tool approval is queued (processed_at null) and runs in order after the approval is resolved. Archived sessions reject new messages. To approve, read a pending agent.tool_use or agent.mcp_tool_use event and send {type: \"user.tool_confirmation\", tool_use_id: <that event id>, result: \"allow\"} (or deny); include session_thread_id for a child approval. Native confirmations also accept updated_permissions, answers and annotations, which /anthropic/v1 rejects.";
|
|
1992
|
+
readonly description: "Attach optional praxis_context={items:[{name,value}]} to user.message for untrusted page context on this turn only (maximum 32 items, 4096 UTF-8 JSON bytes). /anthropic/v1 rejects this field. Send events to a session: user.message (exactly one nonempty text block), user.interrupt, user.tool_confirmation to allow or deny a pending tool call, user.custom_tool_result to return a custom tool result, user.steer to inject a queued user.message into a turn that is still running, and user.withdraw to retract a queued message. The response only acknowledges the inputs; read replies with sessions.events.list or sessions.events.stream. A message sent while the session waits for tool approval is queued (processed_at null) and runs in order after the approval is resolved. Archived sessions reject new messages. To approve, read a pending agent.tool_use or agent.mcp_tool_use event and send {type: \"user.tool_confirmation\", tool_use_id: <that event id>, result: \"allow\"} (or deny); include session_thread_id for a child approval. Native confirmations also accept updated_permissions, answers and annotations, which /anthropic/v1 rejects. Both faces accept user.custom_tool_result with custom_tool_use_id from agent.custom_tool_use.id or the requires_action stop_reason.event_ids. Unlike Anthropic, result content accepts only text blocks (omit it for an empty array). Omitted or null is_error means false. The server routes child calls by id; session_thread_id is rejected in this input. Unknown call ids return 400; duplicate results or calls no longer waiting return 409.";
|
|
1515
1993
|
readonly http: "POST";
|
|
1516
1994
|
readonly path: "/agent/v1/sessions/{session_id}/events";
|
|
1517
1995
|
readonly streaming: "no";
|
|
@@ -1861,6 +2339,187 @@ export declare const operations: readonly [{
|
|
|
1861
2339
|
readonly required: false;
|
|
1862
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.";
|
|
1863
2341
|
}];
|
|
2342
|
+
}, {
|
|
2343
|
+
readonly resource: "agent.skills";
|
|
2344
|
+
readonly method: "list";
|
|
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.";
|
|
2347
|
+
readonly http: "GET";
|
|
2348
|
+
readonly path: "/agent/v1/skills";
|
|
2349
|
+
readonly streaming: "no";
|
|
2350
|
+
readonly pagination: false;
|
|
2351
|
+
readonly pathParams: 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
|
+
}];
|
|
2368
|
+
}, {
|
|
2369
|
+
readonly resource: "agent.skills";
|
|
2370
|
+
readonly method: "create";
|
|
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.";
|
|
2373
|
+
readonly http: "POST";
|
|
2374
|
+
readonly path: "/agent/v1/skills";
|
|
2375
|
+
readonly streaming: "no";
|
|
2376
|
+
readonly pagination: false;
|
|
2377
|
+
readonly multipart: true;
|
|
2378
|
+
readonly pathParams: readonly [];
|
|
2379
|
+
readonly query: readonly [];
|
|
2380
|
+
readonly body: {
|
|
2381
|
+
readonly required: true;
|
|
2382
|
+
readonly fields: readonly [{
|
|
2383
|
+
readonly name: "files";
|
|
2384
|
+
readonly type: "array";
|
|
2385
|
+
readonly itemType: "string";
|
|
2386
|
+
readonly required: true;
|
|
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.";
|
|
2393
|
+
}];
|
|
2394
|
+
};
|
|
2395
|
+
}, {
|
|
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}";
|
|
2402
|
+
readonly streaming: "no";
|
|
2403
|
+
readonly pagination: false;
|
|
2404
|
+
readonly pathParams: readonly [{
|
|
2405
|
+
readonly name: "skill_id";
|
|
2406
|
+
readonly sdkName: "skill_id";
|
|
2407
|
+
}];
|
|
2408
|
+
readonly query: readonly [];
|
|
2409
|
+
}, {
|
|
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}";
|
|
2416
|
+
readonly streaming: "no";
|
|
2417
|
+
readonly pagination: false;
|
|
2418
|
+
readonly pathParams: readonly [{
|
|
2419
|
+
readonly name: "skill_id";
|
|
2420
|
+
readonly sdkName: "skill_id";
|
|
2421
|
+
}];
|
|
2422
|
+
readonly query: readonly [];
|
|
2423
|
+
}, {
|
|
2424
|
+
readonly resource: "agent.skills.versions";
|
|
2425
|
+
readonly method: "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.";
|
|
2428
|
+
readonly http: "GET";
|
|
2429
|
+
readonly path: "/agent/v1/skills/{skill_id}/versions";
|
|
2430
|
+
readonly streaming: "no";
|
|
2431
|
+
readonly pagination: false;
|
|
2432
|
+
readonly pathParams: readonly [{
|
|
2433
|
+
readonly name: "skill_id";
|
|
2434
|
+
readonly sdkName: "skill_id";
|
|
2435
|
+
}];
|
|
2436
|
+
readonly query: readonly [{
|
|
2437
|
+
readonly name: "limit";
|
|
2438
|
+
readonly type: "number";
|
|
2439
|
+
readonly required: false;
|
|
2440
|
+
readonly description: "Number of items per page.";
|
|
2441
|
+
}, {
|
|
2442
|
+
readonly name: "page";
|
|
2443
|
+
readonly type: "string";
|
|
2444
|
+
readonly required: false;
|
|
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.";
|
|
2446
|
+
}];
|
|
2447
|
+
}, {
|
|
2448
|
+
readonly resource: "agent.skills.versions";
|
|
2449
|
+
readonly method: "create";
|
|
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.";
|
|
2452
|
+
readonly http: "POST";
|
|
2453
|
+
readonly path: "/agent/v1/skills/{skill_id}/versions";
|
|
2454
|
+
readonly streaming: "no";
|
|
2455
|
+
readonly pagination: false;
|
|
2456
|
+
readonly multipart: true;
|
|
2457
|
+
readonly pathParams: readonly [{
|
|
2458
|
+
readonly name: "skill_id";
|
|
2459
|
+
readonly sdkName: "skill_id";
|
|
2460
|
+
}];
|
|
2461
|
+
readonly query: readonly [];
|
|
2462
|
+
readonly body: {
|
|
2463
|
+
readonly required: true;
|
|
2464
|
+
readonly fields: readonly [{
|
|
2465
|
+
readonly name: "files";
|
|
2466
|
+
readonly type: "array";
|
|
2467
|
+
readonly itemType: "string";
|
|
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 [];
|
|
1864
2523
|
}, {
|
|
1865
2524
|
readonly resource: "agent.toolsets";
|
|
1866
2525
|
readonly method: "list";
|
|
@@ -2452,6 +3111,23 @@ export declare const operations: readonly [{
|
|
|
2452
3111
|
readonly sdkName: "version_id";
|
|
2453
3112
|
}];
|
|
2454
3113
|
readonly query: readonly [];
|
|
3114
|
+
}, {
|
|
3115
|
+
readonly resource: "application.workers.versions.assets";
|
|
3116
|
+
readonly method: "retrieveManifest";
|
|
3117
|
+
readonly summary: "Get version asset manifest";
|
|
3118
|
+
readonly description: "Read the retained asset paths, content hashes and byte sizes of a version for publication planning. This read creates no session or version. A version without assets returns an empty manifest; unavailable artifacts and foreign resources return 404.";
|
|
3119
|
+
readonly http: "GET";
|
|
3120
|
+
readonly path: "/application/v1/workers/{worker_id}/versions/{version_id}/assets/manifest";
|
|
3121
|
+
readonly streaming: "no";
|
|
3122
|
+
readonly pagination: false;
|
|
3123
|
+
readonly pathParams: readonly [{
|
|
3124
|
+
readonly name: "worker_id";
|
|
3125
|
+
readonly sdkName: "worker_id";
|
|
3126
|
+
}, {
|
|
3127
|
+
readonly name: "version_id";
|
|
3128
|
+
readonly sdkName: "version_id";
|
|
3129
|
+
}];
|
|
3130
|
+
readonly query: readonly [];
|
|
2455
3131
|
}, {
|
|
2456
3132
|
readonly resource: "automation.actions";
|
|
2457
3133
|
readonly method: "list";
|
|
@@ -2535,12 +3211,12 @@ export declare const operations: readonly [{
|
|
|
2535
3211
|
readonly name: "namespace";
|
|
2536
3212
|
readonly type: "string";
|
|
2537
3213
|
readonly required: true;
|
|
2538
|
-
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}.";
|
|
2539
3215
|
}, {
|
|
2540
3216
|
readonly name: "name";
|
|
2541
3217
|
readonly type: "string";
|
|
2542
3218
|
readonly required: true;
|
|
2543
|
-
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}.";
|
|
2544
3220
|
}, {
|
|
2545
3221
|
readonly name: "description";
|
|
2546
3222
|
readonly type: "string";
|
|
@@ -2592,8 +3268,8 @@ export declare const operations: readonly [{
|
|
|
2592
3268
|
}, {
|
|
2593
3269
|
readonly resource: "automation.actions";
|
|
2594
3270
|
readonly method: "retrieve";
|
|
2595
|
-
readonly summary: "Get an
|
|
2596
|
-
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.";
|
|
2597
3273
|
readonly http: "GET";
|
|
2598
3274
|
readonly path: "/automation/v1/actions/{ns}/{name}";
|
|
2599
3275
|
readonly streaming: "no";
|
|
@@ -3037,8 +3713,8 @@ export declare const operations: readonly [{
|
|
|
3037
3713
|
}, {
|
|
3038
3714
|
readonly resource: "automation.runs";
|
|
3039
3715
|
readonly method: "create";
|
|
3040
|
-
readonly summary: "
|
|
3041
|
-
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.";
|
|
3042
3718
|
readonly http: "POST";
|
|
3043
3719
|
readonly path: "/automation/v1/runs";
|
|
3044
3720
|
readonly streaming: "no";
|
|
@@ -3421,7 +4097,7 @@ export declare const operations: readonly [{
|
|
|
3421
4097
|
readonly resource: "automation.scripts";
|
|
3422
4098
|
readonly method: "create";
|
|
3423
4099
|
readonly summary: "Create a script";
|
|
3424
|
-
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.";
|
|
3425
4101
|
readonly http: "POST";
|
|
3426
4102
|
readonly path: "/automation/v1/scripts";
|
|
3427
4103
|
readonly streaming: "no";
|
|
@@ -3434,12 +4110,12 @@ export declare const operations: readonly [{
|
|
|
3434
4110
|
readonly name: "namespace";
|
|
3435
4111
|
readonly type: "string";
|
|
3436
4112
|
readonly required: true;
|
|
3437
|
-
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}.";
|
|
3438
4114
|
}, {
|
|
3439
4115
|
readonly name: "name";
|
|
3440
4116
|
readonly type: "string";
|
|
3441
4117
|
readonly required: true;
|
|
3442
|
-
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}.";
|
|
3443
4119
|
}, {
|
|
3444
4120
|
readonly name: "description";
|
|
3445
4121
|
readonly type: "string";
|
|
@@ -3478,7 +4154,7 @@ export declare const operations: readonly [{
|
|
|
3478
4154
|
readonly resource: "automation.scripts";
|
|
3479
4155
|
readonly method: "update";
|
|
3480
4156
|
readonly summary: "Update a script draft";
|
|
3481
|
-
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.";
|
|
3482
4158
|
readonly http: "PATCH";
|
|
3483
4159
|
readonly path: "/automation/v1/scripts/{ns}/{name}";
|
|
3484
4160
|
readonly streaming: "no";
|
|
@@ -4237,7 +4913,7 @@ export declare const operations: readonly [{
|
|
|
4237
4913
|
readonly resource: "automation.workflows";
|
|
4238
4914
|
readonly method: "create";
|
|
4239
4915
|
readonly summary: "Create a workflow";
|
|
4240
|
-
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.";
|
|
4241
4917
|
readonly http: "POST";
|
|
4242
4918
|
readonly path: "/automation/v1/workflows";
|
|
4243
4919
|
readonly streaming: "no";
|
|
@@ -4250,12 +4926,12 @@ export declare const operations: readonly [{
|
|
|
4250
4926
|
readonly name: "namespace";
|
|
4251
4927
|
readonly type: "string";
|
|
4252
4928
|
readonly required: true;
|
|
4253
|
-
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}.";
|
|
4254
4930
|
}, {
|
|
4255
4931
|
readonly name: "name";
|
|
4256
4932
|
readonly type: "string";
|
|
4257
4933
|
readonly required: true;
|
|
4258
|
-
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}.";
|
|
4259
4935
|
}, {
|
|
4260
4936
|
readonly name: "description";
|
|
4261
4937
|
readonly type: "string";
|
|
@@ -5193,7 +5869,7 @@ export declare const operations: readonly [{
|
|
|
5193
5869
|
readonly name: "{column}";
|
|
5194
5870
|
readonly type: "string";
|
|
5195
5871
|
readonly required: false;
|
|
5196
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
5872
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5197
5873
|
}, {
|
|
5198
5874
|
readonly name: "and";
|
|
5199
5875
|
readonly type: "string";
|
|
@@ -5233,7 +5909,7 @@ export declare const operations: readonly [{
|
|
|
5233
5909
|
readonly name: "on_conflict";
|
|
5234
5910
|
readonly type: "string";
|
|
5235
5911
|
readonly required: false;
|
|
5236
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5912
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5237
5913
|
}, {
|
|
5238
5914
|
readonly name: "columns";
|
|
5239
5915
|
readonly type: "string";
|
|
@@ -5244,7 +5920,7 @@ export declare const operations: readonly [{
|
|
|
5244
5920
|
readonly resource: "database.databases.rest";
|
|
5245
5921
|
readonly method: "retrieve";
|
|
5246
5922
|
readonly summary: "Select rows";
|
|
5247
|
-
readonly description: "Read matching rows with filters, selected columns and ordering. Returns at most 1000 rows per request, including when limit is omitted. Content-Range reports the actual returned interval and the total when count is requested. PATCH and DELETE are not subject to this read cap. Unlike Supabase, casts, aggregates, spread and join modifiers are unsupported. Each table supports up to 1,000,000 rows. Query budget: 8,000 ms with a shared 3,000,000-row safety ceiling. Create indexes on filtered or sorted fields, or narrow the request when it exceeds its budget. Synchronous SQLite aggregates use candidate-row throughput estimates before execution; deployed Workers freeze clocks during synchronous CPU work, so the timer is not a guaranteed server-side interrupt. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Error table: QUERY_CANCELED / PostgREST 57014 is HTTP 500, retryable=false: Query timed out: index filtered or sorted fields, or narrow the range. DATABASE_INVALID_STATE is HTTP 409 for operations on a deleting database. Cleared or nonexistent databases return DATABASE_NOT_FOUND / HTTP 404. The count is an HTTP Content-Range response header, not a JSON property.
|
|
5923
|
+
readonly description: "Read matching rows with filters, selected columns and ordering. Returns at most 1000 rows per request, including when limit is omitted. Content-Range reports the actual returned interval and the total when count is requested. PATCH and DELETE are not subject to this read cap. Unlike Supabase, casts, aggregates, spread and join modifiers are unsupported. Each table supports up to 1,000,000 rows. Query budget: 8,000 ms with a shared 3,000,000-row safety ceiling. Create indexes on filtered or sorted fields, or narrow the request when it exceeds its budget. Synchronous SQLite aggregates use candidate-row throughput estimates before execution; deployed Workers freeze clocks during synchronous CPU work, so the timer is not a guaranteed server-side interrupt. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Error table: QUERY_CANCELED / PostgREST 57014 is HTTP 500, retryable=false: Query timed out: index filtered or sorted fields, or narrow the range. DATABASE_INVALID_STATE is HTTP 409 for operations on a deleting database. Cleared or nonexistent databases return DATABASE_NOT_FOUND / HTTP 404. The count is an HTTP Content-Range response header, not a JSON property. Use praxis.database.count in the SDK or codemode to return { count: number | null }; a page length is not a total unless you know all matches fit in that page.";
|
|
5248
5924
|
readonly http: "GET";
|
|
5249
5925
|
readonly path: "/database/v1/databases/{database_id}/rest/{table}";
|
|
5250
5926
|
readonly streaming: "no";
|
|
@@ -5265,7 +5941,7 @@ export declare const operations: readonly [{
|
|
|
5265
5941
|
readonly name: "{column}";
|
|
5266
5942
|
readonly type: "string";
|
|
5267
5943
|
readonly required: false;
|
|
5268
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
5944
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5269
5945
|
}, {
|
|
5270
5946
|
readonly name: "and";
|
|
5271
5947
|
readonly type: "string";
|
|
@@ -5305,7 +5981,7 @@ export declare const operations: readonly [{
|
|
|
5305
5981
|
readonly name: "on_conflict";
|
|
5306
5982
|
readonly type: "string";
|
|
5307
5983
|
readonly required: false;
|
|
5308
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5984
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5309
5985
|
}, {
|
|
5310
5986
|
readonly name: "columns";
|
|
5311
5987
|
readonly type: "string";
|
|
@@ -5316,7 +5992,7 @@ export declare const operations: readonly [{
|
|
|
5316
5992
|
readonly resource: "database.databases.rest";
|
|
5317
5993
|
readonly method: "head";
|
|
5318
5994
|
readonly summary: "Count rows";
|
|
5319
|
-
readonly description: "Inspect the HTTP row count and range without retrieving row data; send Prefer: count=exact for a filtered count. Returns no body and does not fetch or serialize row data. A known count determines the interval using limit/offset or Range with a default and maximum page size of 1000. Without a count preference, or when the selected count mode cannot supply a total, Content-Range is */*. Singular Accept still validates page cardinality. Unlike Supabase, planned and estimated counts do not use PostgreSQL planner estimates. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode.
|
|
5995
|
+
readonly description: "Inspect the HTTP row count and range without retrieving row data; send Prefer: count=exact for a filtered count. Returns no body and does not fetch or serialize row data. A known count determines the interval using limit/offset or Range with a default and maximum page size of 1000. Without a count preference, or when the selected count mode cannot supply a total, Content-Range is */*. Singular Accept still validates page cardinality. Unlike Supabase, planned and estimated counts do not use PostgreSQL planner estimates. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Use praxis.database.count in the SDK or codemode to return { count: number | null } from this header without retrieving rows.";
|
|
5320
5996
|
readonly http: "HEAD";
|
|
5321
5997
|
readonly path: "/database/v1/databases/{database_id}/rest/{table}";
|
|
5322
5998
|
readonly streaming: "no";
|
|
@@ -5337,7 +6013,7 @@ export declare const operations: readonly [{
|
|
|
5337
6013
|
readonly name: "{column}";
|
|
5338
6014
|
readonly type: "string";
|
|
5339
6015
|
readonly required: false;
|
|
5340
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
6016
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5341
6017
|
}, {
|
|
5342
6018
|
readonly name: "and";
|
|
5343
6019
|
readonly type: "string";
|
|
@@ -5377,7 +6053,7 @@ export declare const operations: readonly [{
|
|
|
5377
6053
|
readonly name: "on_conflict";
|
|
5378
6054
|
readonly type: "string";
|
|
5379
6055
|
readonly required: false;
|
|
5380
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
6056
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5381
6057
|
}, {
|
|
5382
6058
|
readonly name: "columns";
|
|
5383
6059
|
readonly type: "string";
|
|
@@ -5409,7 +6085,7 @@ export declare const operations: readonly [{
|
|
|
5409
6085
|
readonly name: "{column}";
|
|
5410
6086
|
readonly type: "string";
|
|
5411
6087
|
readonly required: false;
|
|
5412
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
6088
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5413
6089
|
}, {
|
|
5414
6090
|
readonly name: "and";
|
|
5415
6091
|
readonly type: "string";
|
|
@@ -5449,7 +6125,7 @@ export declare const operations: readonly [{
|
|
|
5449
6125
|
readonly name: "on_conflict";
|
|
5450
6126
|
readonly type: "string";
|
|
5451
6127
|
readonly required: false;
|
|
5452
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
6128
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5453
6129
|
}, {
|
|
5454
6130
|
readonly name: "columns";
|
|
5455
6131
|
readonly type: "string";
|
|
@@ -5464,7 +6140,7 @@ export declare const operations: readonly [{
|
|
|
5464
6140
|
readonly resource: "database.databases.rest";
|
|
5465
6141
|
readonly method: "create";
|
|
5466
6142
|
readonly summary: "Insert rows";
|
|
5467
|
-
readonly description: "Insert rows into an existing table after defining its fields; at most 500 rows per request. Each request is atomic: any failure rolls back the entire batch. There are no transactions across requests.\nRows are filled to the union of their keys with null; send Prefer: missing=default to use field defaults for missing keys.\nThe default is return=minimal: success returns HTTP 201 with an empty body. Send Prefer: return=representation to return the inserted rows. Unlike Supabase, upsert conflicts can target only id or one unique field, not a composite key. Each table supports up to 1,000,000 rows.";
|
|
6143
|
+
readonly description: "Insert rows into an existing table after defining its fields; at most 500 rows per request. Each request is atomic: any failure rolls back the entire batch. There are no transactions across requests.\nRows are filled to the union of their keys with null; send Prefer: missing=default to use field defaults for missing keys.\nThe default is return=minimal: success returns HTTP 201 with an empty body. Send Prefer: return=representation to return the inserted rows. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. Unlike Supabase, upsert conflicts can target only id or one unique field, not a composite key. Each table supports up to 1,000,000 rows.";
|
|
5468
6144
|
readonly http: "POST";
|
|
5469
6145
|
readonly path: "/database/v1/databases/{database_id}/rest/{table}";
|
|
5470
6146
|
readonly streaming: "no";
|
|
@@ -5485,7 +6161,7 @@ export declare const operations: readonly [{
|
|
|
5485
6161
|
readonly name: "{column}";
|
|
5486
6162
|
readonly type: "string";
|
|
5487
6163
|
readonly required: false;
|
|
5488
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
6164
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5489
6165
|
}, {
|
|
5490
6166
|
readonly name: "and";
|
|
5491
6167
|
readonly type: "string";
|
|
@@ -5525,7 +6201,7 @@ export declare const operations: readonly [{
|
|
|
5525
6201
|
readonly name: "on_conflict";
|
|
5526
6202
|
readonly type: "string";
|
|
5527
6203
|
readonly required: false;
|
|
5528
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
6204
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5529
6205
|
}, {
|
|
5530
6206
|
readonly name: "columns";
|
|
5531
6207
|
readonly type: "string";
|
|
@@ -5568,7 +6244,7 @@ export declare const operations: readonly [{
|
|
|
5568
6244
|
readonly resource: "database.databases.tables";
|
|
5569
6245
|
readonly method: "create";
|
|
5570
6246
|
readonly summary: "Create table";
|
|
5571
|
-
readonly description: "Creates a table together with its initial fields in one call and returns it (HTTP 201) with generated tbl_ and fld_ ids. name must match ^[a-z_][a-z0-9_]{0,62}$ and be unused in this database (duplicate: 409 UNIQUE_VIOLATION). fields is required and may be an empty array; fields can also be added later with databaseAddField. Limits: 50 tables per database, 64 fields per table, and 16 indexed or unique fields per table; exceeding one returns 400 LIMIT_EXCEEDED. Every row also has a system id column, which is not declared as a field. Insert data afterwards with databaseInsert. Unlike Supabase, define schema with this table API and the field APIs; PostgreSQL DDL and SQL migration files cannot be submitted. Each table supports up to 1,000,000 rows.";
|
|
6247
|
+
readonly description: "Creates a table together with its initial fields in one call and returns it (HTTP 201) with generated tbl_ and fld_ ids. name must match ^[a-z_][a-z0-9_]{0,62}$ and be unused in this database (duplicate: 409 UNIQUE_VIOLATION). fields is required and may be an empty array; fields can also be added later with databaseAddField. Limits: 50 tables per database, 64 fields per table, and 16 indexed or unique fields per table; exceeding one returns 400 LIMIT_EXCEEDED. Fields default to indexed:false. Set indexed:true explicitly for fields used in filters or ordering. Only indexed:true or unique:true consumes one of the 16 indexed-or-unique field slots; a field with both consumes one slot. Unique fields still consume a slot even with indexed:false. Existing fields are unchanged. Minimal field example: {\"name\":\"notes\",\"type\":\"string\",\"indexed\":false}. Every row also has a system id column, which is not declared as a field. Insert data afterwards with databaseInsert. Unlike Supabase, define schema with this table API and the field APIs; PostgreSQL DDL and SQL migration files cannot be submitted. Each table supports up to 1,000,000 rows.";
|
|
5572
6248
|
readonly http: "POST";
|
|
5573
6249
|
readonly path: "/database/v1/databases/{database_id}/tables";
|
|
5574
6250
|
readonly streaming: "no";
|
|
@@ -5667,7 +6343,7 @@ export declare const operations: readonly [{
|
|
|
5667
6343
|
readonly resource: "database.databases.tables.fields";
|
|
5668
6344
|
readonly method: "create";
|
|
5669
6345
|
readonly summary: "Add field";
|
|
5670
|
-
readonly description: "Adds one field to an existing table and returns the updated table (HTTP 201). Required inputs are name (lowercase letters, digits and underscores; id and names starting with _ are reserved) and type (string, integer, number, boolean, datetime, json or link); json needs options.schema and link needs options.linked_table_id and options.multiple. Adding a required field to a table that already has rows needs a default, otherwise the call fails with 400 VALIDATION_FAILED; a default is written into every existing row.
|
|
6346
|
+
readonly description: "Adds one field to an existing table and returns the updated table (HTTP 201). Required inputs are name (lowercase letters, digits and underscores; id and names starting with _ are reserved) and type (string, integer, number, boolean, datetime, json or link); json needs options.schema and link needs options.linked_table_id and options.multiple. Adding a required field to a table that already has rows needs a default, otherwise the call fails with 400 VALIDATION_FAILED; a default is written into every existing row. Fields default to indexed:false. Set indexed:true explicitly for fields used in filters or ordering. Only indexed:true or unique:true consumes one of the 16 indexed-or-unique field slots; a field with both consumes one slot. Unique fields still consume a slot even with indexed:false. Existing fields are unchanged. Minimal field example: {\"name\":\"notes\",\"type\":\"string\",\"indexed\":false}. JSON and link fields cannot be indexed. Limits: 64 fields and 16 indexed or unique fields per table (400 LIMIT_EXCEEDED). Unlike Supabase, schema evolution uses field definitions rather than ALTER TABLE statements or SQL migrations.";
|
|
5671
6347
|
readonly http: "POST";
|
|
5672
6348
|
readonly path: "/database/v1/databases/{database_id}/tables/{table}/fields";
|
|
5673
6349
|
readonly streaming: "no";
|
|
@@ -5804,7 +6480,7 @@ export declare const operations: readonly [{
|
|
|
5804
6480
|
readonly resource: "file.files";
|
|
5805
6481
|
readonly method: "create";
|
|
5806
6482
|
readonly summary: "Upload file";
|
|
5807
|
-
readonly description: "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most
|
|
6483
|
+
readonly description: "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data, assistants and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–2592000), or praxis[expires_in_seconds] (3600–7776000), never both. Without expiry, the file persists until deleted.";
|
|
5808
6484
|
readonly http: "POST";
|
|
5809
6485
|
readonly path: "/file/v1/files";
|
|
5810
6486
|
readonly streaming: "no";
|
|
@@ -5818,7 +6494,7 @@ export declare const operations: readonly [{
|
|
|
5818
6494
|
readonly name: "file";
|
|
5819
6495
|
readonly type: "string";
|
|
5820
6496
|
readonly required: true;
|
|
5821
|
-
readonly description: "File bytes in one multipart file part, not a filename or file ID. The file must be nonempty and at most
|
|
6497
|
+
readonly description: "File bytes in one multipart file part, not a filename or file ID. The file must be nonempty and at most 100000000 bytes; its content determines the MIME type.";
|
|
5822
6498
|
}, {
|
|
5823
6499
|
readonly name: "purpose";
|
|
5824
6500
|
readonly type: "string";
|
|
@@ -5855,7 +6531,7 @@ export declare const operations: readonly [{
|
|
|
5855
6531
|
readonly resource: "file.files";
|
|
5856
6532
|
readonly method: "retrieve";
|
|
5857
6533
|
readonly summary: "Retrieve file";
|
|
5858
|
-
readonly description: "Retrieve metadata for a live file owned by your tenant. Use its
|
|
6534
|
+
readonly description: "Retrieve metadata for a live file owned by your tenant. Use its file- ID from upload or list. Missing, deleted, expired and other-tenant files return 404; use the content endpoint to download the bytes.";
|
|
5859
6535
|
readonly http: "GET";
|
|
5860
6536
|
readonly path: "/file/v1/files/{file_id}";
|
|
5861
6537
|
readonly streaming: "no";
|
|
@@ -5869,7 +6545,7 @@ export declare const operations: readonly [{
|
|
|
5869
6545
|
readonly resource: "file.files";
|
|
5870
6546
|
readonly method: "retrieveContent";
|
|
5871
6547
|
readonly summary: "Retrieve file content";
|
|
5872
|
-
readonly description: "Download the original bytes of a live file owned by your tenant. Supply its
|
|
6548
|
+
readonly description: "Download the original bytes of a live file owned by your tenant. Supply its file- ID from upload or list. A single byte Range can return a partial response; a range outside the file returns 416. Missing, deleted, expired and other-tenant files return 404.";
|
|
5873
6549
|
readonly http: "GET";
|
|
5874
6550
|
readonly path: "/file/v1/files/{file_id}/content";
|
|
5875
6551
|
readonly streaming: "no";
|
|
@@ -5880,43 +6556,161 @@ export declare const operations: readonly [{
|
|
|
5880
6556
|
}];
|
|
5881
6557
|
readonly query: readonly [];
|
|
5882
6558
|
}, {
|
|
5883
|
-
readonly resource: "
|
|
5884
|
-
readonly method: "
|
|
5885
|
-
readonly summary: "
|
|
5886
|
-
readonly description: "
|
|
5887
|
-
readonly http: "
|
|
5888
|
-
readonly path: "/
|
|
6559
|
+
readonly resource: "file.uploads";
|
|
6560
|
+
readonly method: "create";
|
|
6561
|
+
readonly summary: "Create an upload";
|
|
6562
|
+
readonly description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data, assistants and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.";
|
|
6563
|
+
readonly http: "POST";
|
|
6564
|
+
readonly path: "/file/v1/uploads";
|
|
5889
6565
|
readonly streaming: "no";
|
|
5890
6566
|
readonly pagination: false;
|
|
5891
6567
|
readonly pathParams: readonly [];
|
|
5892
|
-
readonly query: readonly [
|
|
5893
|
-
|
|
5894
|
-
readonly
|
|
5895
|
-
readonly
|
|
5896
|
-
|
|
5897
|
-
|
|
5898
|
-
|
|
5899
|
-
|
|
5900
|
-
|
|
5901
|
-
|
|
5902
|
-
|
|
5903
|
-
|
|
5904
|
-
|
|
5905
|
-
|
|
5906
|
-
|
|
5907
|
-
|
|
5908
|
-
|
|
5909
|
-
|
|
5910
|
-
|
|
5911
|
-
|
|
5912
|
-
|
|
5913
|
-
|
|
5914
|
-
|
|
5915
|
-
|
|
5916
|
-
|
|
5917
|
-
|
|
5918
|
-
|
|
5919
|
-
|
|
6568
|
+
readonly query: readonly [];
|
|
6569
|
+
readonly body: {
|
|
6570
|
+
readonly required: true;
|
|
6571
|
+
readonly fields: readonly [{
|
|
6572
|
+
readonly name: "bytes";
|
|
6573
|
+
readonly type: "integer";
|
|
6574
|
+
readonly required: true;
|
|
6575
|
+
readonly description: "Exact complete file length in bytes, from 1 through 2147483648 (2 GiB); the sum of completed parts must match.";
|
|
6576
|
+
}, {
|
|
6577
|
+
readonly name: "filename";
|
|
6578
|
+
readonly type: "string";
|
|
6579
|
+
readonly required: true;
|
|
6580
|
+
readonly description: "Filename for the resulting file, at most 255 UTF-8 bytes.";
|
|
6581
|
+
}, {
|
|
6582
|
+
readonly name: "mime_type";
|
|
6583
|
+
readonly type: "string";
|
|
6584
|
+
readonly required: true;
|
|
6585
|
+
readonly description: "Declared MIME type; validated against the assembled content.";
|
|
6586
|
+
}, {
|
|
6587
|
+
readonly name: "purpose";
|
|
6588
|
+
readonly type: "string";
|
|
6589
|
+
readonly enum: readonly ["user_data", "assistants", "vision"];
|
|
6590
|
+
readonly required: true;
|
|
6591
|
+
readonly description: "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images.";
|
|
6592
|
+
}, {
|
|
6593
|
+
readonly name: "expires_after";
|
|
6594
|
+
readonly type: "object";
|
|
6595
|
+
readonly required: false;
|
|
6596
|
+
readonly description: "Optional expiry policy for the resulting file; omission retains the file until deletion.";
|
|
6597
|
+
}, {
|
|
6598
|
+
readonly name: "part_size";
|
|
6599
|
+
readonly type: "integer";
|
|
6600
|
+
readonly required: false;
|
|
6601
|
+
readonly description: "Optional fixed part size in bytes, 5242880–64000000. Requires part_number on every part; retries of identical bytes at the same number return the same part. Omit to use arbitrary-sized parts.";
|
|
6602
|
+
}];
|
|
6603
|
+
};
|
|
6604
|
+
}, {
|
|
6605
|
+
readonly resource: "file.uploads";
|
|
6606
|
+
readonly method: "cancel";
|
|
6607
|
+
readonly summary: "Cancel an upload";
|
|
6608
|
+
readonly description: "Cancel an unfinished upload using upload_id from create and release its reserved storage. Further parts and completion are rejected. Cancelling an already cancelled upload returns the same terminal result; a completed upload cannot be cancelled. Delete its resulting file instead.";
|
|
6609
|
+
readonly http: "POST";
|
|
6610
|
+
readonly path: "/file/v1/uploads/{upload_id}/cancel";
|
|
6611
|
+
readonly streaming: "no";
|
|
6612
|
+
readonly pagination: false;
|
|
6613
|
+
readonly pathParams: readonly [{
|
|
6614
|
+
readonly name: "upload_id";
|
|
6615
|
+
readonly sdkName: "upload_id";
|
|
6616
|
+
}];
|
|
6617
|
+
readonly query: readonly [];
|
|
6618
|
+
}, {
|
|
6619
|
+
readonly resource: "file.uploads";
|
|
6620
|
+
readonly method: "complete";
|
|
6621
|
+
readonly summary: "Complete an upload";
|
|
6622
|
+
readonly description: "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.";
|
|
6623
|
+
readonly http: "POST";
|
|
6624
|
+
readonly path: "/file/v1/uploads/{upload_id}/complete";
|
|
6625
|
+
readonly streaming: "no";
|
|
6626
|
+
readonly pagination: false;
|
|
6627
|
+
readonly pathParams: readonly [{
|
|
6628
|
+
readonly name: "upload_id";
|
|
6629
|
+
readonly sdkName: "upload_id";
|
|
6630
|
+
}];
|
|
6631
|
+
readonly query: readonly [];
|
|
6632
|
+
readonly body: {
|
|
6633
|
+
readonly required: true;
|
|
6634
|
+
readonly fields: readonly [{
|
|
6635
|
+
readonly name: "part_ids";
|
|
6636
|
+
readonly type: "array";
|
|
6637
|
+
readonly itemType: "string";
|
|
6638
|
+
readonly required: true;
|
|
6639
|
+
readonly description: "All part IDs in concatenation order, without duplicates. Fixed-size uploads require increasing part_number order.";
|
|
6640
|
+
}, {
|
|
6641
|
+
readonly name: "md5";
|
|
6642
|
+
readonly type: "string";
|
|
6643
|
+
readonly required: false;
|
|
6644
|
+
readonly description: "Optional whole-file MD5 as 32 hexadecimal characters; verified after assembly.";
|
|
6645
|
+
}];
|
|
6646
|
+
};
|
|
6647
|
+
}, {
|
|
6648
|
+
readonly resource: "file.uploads.parts";
|
|
6649
|
+
readonly method: "create";
|
|
6650
|
+
readonly summary: "Add an upload part";
|
|
6651
|
+
readonly description: "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.";
|
|
6652
|
+
readonly http: "POST";
|
|
6653
|
+
readonly path: "/file/v1/uploads/{upload_id}/parts";
|
|
6654
|
+
readonly streaming: "no";
|
|
6655
|
+
readonly pagination: false;
|
|
6656
|
+
readonly multipart: true;
|
|
6657
|
+
readonly pathParams: readonly [{
|
|
6658
|
+
readonly name: "upload_id";
|
|
6659
|
+
readonly sdkName: "upload_id";
|
|
6660
|
+
}];
|
|
6661
|
+
readonly query: readonly [{
|
|
6662
|
+
readonly name: "part_number";
|
|
6663
|
+
readonly type: "integer";
|
|
6664
|
+
readonly required: false;
|
|
6665
|
+
readonly description: "Required when create set part_size; 1 through ceil(bytes / part_size). Ignored for general uploads.";
|
|
6666
|
+
}];
|
|
6667
|
+
readonly body: {
|
|
6668
|
+
readonly required: true;
|
|
6669
|
+
readonly fields: readonly [{
|
|
6670
|
+
readonly name: "data";
|
|
6671
|
+
readonly type: "string";
|
|
6672
|
+
readonly required: true;
|
|
6673
|
+
readonly description: "Raw bytes of this part, nonempty and at most 64000000 bytes.";
|
|
6674
|
+
}];
|
|
6675
|
+
};
|
|
6676
|
+
}, {
|
|
6677
|
+
readonly resource: "knowledge.vectorStores";
|
|
6678
|
+
readonly method: "list";
|
|
6679
|
+
readonly summary: "List knowledge bases";
|
|
6680
|
+
readonly description: "Lists knowledge bases visible to the caller, newest first by default. Use last_id as after to read the next page; for example, ?limit=20.";
|
|
6681
|
+
readonly http: "GET";
|
|
6682
|
+
readonly path: "/knowledge/v1/vector_stores";
|
|
6683
|
+
readonly streaming: "no";
|
|
6684
|
+
readonly pagination: false;
|
|
6685
|
+
readonly pathParams: readonly [];
|
|
6686
|
+
readonly query: readonly [{
|
|
6687
|
+
readonly name: "status";
|
|
6688
|
+
readonly type: "string";
|
|
6689
|
+
readonly enum: readonly ["active", "deleting"];
|
|
6690
|
+
readonly required: false;
|
|
6691
|
+
readonly description: "active selects active stores; deleting selects soft-deleted stores awaiting purge. Omission excludes soft-deleted stores.";
|
|
6692
|
+
}, {
|
|
6693
|
+
readonly name: "after";
|
|
6694
|
+
readonly type: "string";
|
|
6695
|
+
readonly required: false;
|
|
6696
|
+
readonly description: "Cursor ID from the previous page.";
|
|
6697
|
+
}, {
|
|
6698
|
+
readonly name: "before";
|
|
6699
|
+
readonly type: "string";
|
|
6700
|
+
readonly required: false;
|
|
6701
|
+
readonly description: "Return items before this ID.";
|
|
6702
|
+
}, {
|
|
6703
|
+
readonly name: "limit";
|
|
6704
|
+
readonly type: "integer";
|
|
6705
|
+
readonly required: false;
|
|
6706
|
+
readonly description: "Page size.";
|
|
6707
|
+
}, {
|
|
6708
|
+
readonly name: "order";
|
|
6709
|
+
readonly type: "string";
|
|
6710
|
+
readonly enum: readonly ["asc", "desc"];
|
|
6711
|
+
readonly required: false;
|
|
6712
|
+
readonly description: "Order by creation time; defaults to desc for stores/files and asc by index for segments.";
|
|
6713
|
+
}];
|
|
5920
6714
|
}, {
|
|
5921
6715
|
readonly resource: "knowledge.vectorStores";
|
|
5922
6716
|
readonly method: "create";
|
|
@@ -9105,6 +9899,37 @@ export declare const operations: readonly [{
|
|
|
9105
9899
|
readonly sdkName: "id";
|
|
9106
9900
|
}];
|
|
9107
9901
|
readonly query: readonly [];
|
|
9902
|
+
}, {
|
|
9903
|
+
readonly resource: "organization.feedback";
|
|
9904
|
+
readonly method: "list";
|
|
9905
|
+
readonly summary: "List your organization's feedback";
|
|
9906
|
+
readonly description: "Feedback submitted by your organization, newest first, with phase and unread state. Filter by phase and search titles and message text (case-insensitive). Page with next_page. Requires a valid API key, Console session, or machine token of the organization.";
|
|
9907
|
+
readonly http: "GET";
|
|
9908
|
+
readonly path: "/organization/v1/feedback";
|
|
9909
|
+
readonly streaming: "no";
|
|
9910
|
+
readonly pagination: false;
|
|
9911
|
+
readonly pathParams: readonly [];
|
|
9912
|
+
readonly query: readonly [{
|
|
9913
|
+
readonly name: "phase";
|
|
9914
|
+
readonly type: "string";
|
|
9915
|
+
readonly required: false;
|
|
9916
|
+
readonly description: "Only feedback in these phases: a comma-separated list of open, awaiting_customer, in_progress, resolved or closed, for example open,in_progress; see the phase field of a feedback for what each means.";
|
|
9917
|
+
}, {
|
|
9918
|
+
readonly name: "query";
|
|
9919
|
+
readonly type: "string";
|
|
9920
|
+
readonly required: false;
|
|
9921
|
+
readonly description: "Case-insensitive text matched against titles and message bodies.";
|
|
9922
|
+
}, {
|
|
9923
|
+
readonly name: "limit";
|
|
9924
|
+
readonly type: "integer";
|
|
9925
|
+
readonly required: false;
|
|
9926
|
+
readonly description: "Items per page, 1 to 100.";
|
|
9927
|
+
}, {
|
|
9928
|
+
readonly name: "page";
|
|
9929
|
+
readonly type: "string";
|
|
9930
|
+
readonly required: false;
|
|
9931
|
+
readonly description: "Opaque cursor from next_page of the previous response.";
|
|
9932
|
+
}];
|
|
9108
9933
|
}, {
|
|
9109
9934
|
readonly resource: "organization.feedback";
|
|
9110
9935
|
readonly method: "create";
|
|
@@ -9122,7 +9947,7 @@ export declare const operations: readonly [{
|
|
|
9122
9947
|
readonly name: "message";
|
|
9123
9948
|
readonly type: "string";
|
|
9124
9949
|
readonly required: true;
|
|
9125
|
-
readonly description: "Problem description
|
|
9950
|
+
readonly description: "Problem description, at most 4096 Unicode code points; may be empty only when contexts.praxis.error.message is a non-empty string.";
|
|
9126
9951
|
}, {
|
|
9127
9952
|
readonly name: "contact_email";
|
|
9128
9953
|
readonly type: "string";
|
|
@@ -9143,6 +9968,16 @@ export declare const operations: readonly [{
|
|
|
9143
9968
|
readonly type: "string";
|
|
9144
9969
|
readonly required: false;
|
|
9145
9970
|
readonly description: "X-Request-Id from the failed response or the related error event ID.";
|
|
9971
|
+
}, {
|
|
9972
|
+
readonly name: "title";
|
|
9973
|
+
readonly type: "string";
|
|
9974
|
+
readonly required: false;
|
|
9975
|
+
readonly description: "Short summary shown in the feedback list; at most 200 Unicode code points.";
|
|
9976
|
+
}, {
|
|
9977
|
+
readonly name: "type";
|
|
9978
|
+
readonly type: "string";
|
|
9979
|
+
readonly required: false;
|
|
9980
|
+
readonly description: "Feedback type key enabled in the help settings, such as issue, suggestion, billing or other. Unknown or disabled keys are rejected with INVALID_PARAMS.";
|
|
9146
9981
|
}, {
|
|
9147
9982
|
readonly name: "tags";
|
|
9148
9983
|
readonly type: "object";
|
|
@@ -9167,6 +10002,84 @@ export declare const operations: readonly [{
|
|
|
9167
10002
|
readonly description: "Up to five attachments; decoded bytes must not exceed 10 MiB per attachment or 20 MiB in total.";
|
|
9168
10003
|
}];
|
|
9169
10004
|
};
|
|
10005
|
+
}, {
|
|
10006
|
+
readonly resource: "organization.feedback.counts";
|
|
10007
|
+
readonly method: "list";
|
|
10008
|
+
readonly summary: "Count your organization's feedback by phase";
|
|
10009
|
+
readonly description: "How many of your organization's feedback are in each phase, for status tabs. Counts never include another organization's feedback.";
|
|
10010
|
+
readonly http: "GET";
|
|
10011
|
+
readonly path: "/organization/v1/feedback/counts";
|
|
10012
|
+
readonly streaming: "no";
|
|
10013
|
+
readonly pagination: false;
|
|
10014
|
+
readonly pathParams: readonly [];
|
|
10015
|
+
readonly query: readonly [];
|
|
10016
|
+
}, {
|
|
10017
|
+
readonly resource: "organization.feedback";
|
|
10018
|
+
readonly method: "retrieve";
|
|
10019
|
+
readonly summary: "Get one of your organization's feedback";
|
|
10020
|
+
readonly description: "Read one feedback submitted by your organization with its current phase and first-response timing. Another organization's feedback answers 404 FEEDBACK_NOT_FOUND exactly like a missing one.";
|
|
10021
|
+
readonly http: "GET";
|
|
10022
|
+
readonly path: "/organization/v1/feedback/{id}";
|
|
10023
|
+
readonly streaming: "no";
|
|
10024
|
+
readonly pagination: false;
|
|
10025
|
+
readonly pathParams: readonly [{
|
|
10026
|
+
readonly name: "id";
|
|
10027
|
+
readonly sdkName: "id";
|
|
10028
|
+
}];
|
|
10029
|
+
readonly query: readonly [];
|
|
10030
|
+
}, {
|
|
10031
|
+
readonly resource: "organization.feedback.messages";
|
|
10032
|
+
readonly method: "list";
|
|
10033
|
+
readonly summary: "List the messages of a feedback";
|
|
10034
|
+
readonly description: "The conversation of one feedback in time order: your messages, support replies and system events. Internal support notes are never returned. Page with next_page.";
|
|
10035
|
+
readonly http: "GET";
|
|
10036
|
+
readonly path: "/organization/v1/feedback/{id}/messages";
|
|
10037
|
+
readonly streaming: "no";
|
|
10038
|
+
readonly pagination: false;
|
|
10039
|
+
readonly pathParams: readonly [{
|
|
10040
|
+
readonly name: "id";
|
|
10041
|
+
readonly sdkName: "id";
|
|
10042
|
+
}];
|
|
10043
|
+
readonly query: readonly [{
|
|
10044
|
+
readonly name: "limit";
|
|
10045
|
+
readonly type: "integer";
|
|
10046
|
+
readonly required: false;
|
|
10047
|
+
readonly description: "Items per page, 1 to 100.";
|
|
10048
|
+
}, {
|
|
10049
|
+
readonly name: "page";
|
|
10050
|
+
readonly type: "string";
|
|
10051
|
+
readonly required: false;
|
|
10052
|
+
readonly description: "Opaque cursor from next_page of the previous response.";
|
|
10053
|
+
}];
|
|
10054
|
+
}, {
|
|
10055
|
+
readonly resource: "organization.feedback.messages";
|
|
10056
|
+
readonly method: "create";
|
|
10057
|
+
readonly summary: "Reply on a feedback";
|
|
10058
|
+
readonly description: "Add your message to a feedback conversation, for example to answer a question from support. A reply while the phase is awaiting_customer moves it to in_progress and notifies support.";
|
|
10059
|
+
readonly http: "POST";
|
|
10060
|
+
readonly path: "/organization/v1/feedback/{id}/messages";
|
|
10061
|
+
readonly streaming: "no";
|
|
10062
|
+
readonly pagination: false;
|
|
10063
|
+
readonly pathParams: readonly [{
|
|
10064
|
+
readonly name: "id";
|
|
10065
|
+
readonly sdkName: "id";
|
|
10066
|
+
}];
|
|
10067
|
+
readonly query: readonly [];
|
|
10068
|
+
readonly body: {
|
|
10069
|
+
readonly required: true;
|
|
10070
|
+
readonly fields: readonly [{
|
|
10071
|
+
readonly name: "body";
|
|
10072
|
+
readonly type: "string";
|
|
10073
|
+
readonly required: true;
|
|
10074
|
+
readonly description: "Markdown text; at most 4096 Unicode code points.";
|
|
10075
|
+
}, {
|
|
10076
|
+
readonly name: "attachments";
|
|
10077
|
+
readonly type: "array";
|
|
10078
|
+
readonly itemType: "object";
|
|
10079
|
+
readonly required: false;
|
|
10080
|
+
readonly description: "Up to five attachments; decoded bytes must not exceed 10 MiB each or 20 MiB in total.";
|
|
10081
|
+
}];
|
|
10082
|
+
};
|
|
9170
10083
|
}, {
|
|
9171
10084
|
readonly resource: "organization.usage";
|
|
9172
10085
|
readonly method: "list";
|
|
@@ -9269,7 +10182,7 @@ export declare const operations: readonly [{
|
|
|
9269
10182
|
readonly resource: "sandbox.sandboxes";
|
|
9270
10183
|
readonly method: "create";
|
|
9271
10184
|
readonly summary: "Create sandbox (v2)";
|
|
9272
|
-
readonly description: "
|
|
10185
|
+
readonly description: "Create a sandbox from the template. All system communication with the sandbox is secured.";
|
|
9273
10186
|
readonly http: "POST";
|
|
9274
10187
|
readonly path: "/sandbox/v1/sandboxes";
|
|
9275
10188
|
readonly streaming: "no";
|
|
@@ -9282,7 +10195,7 @@ export declare const operations: readonly [{
|
|
|
9282
10195
|
readonly name: "templateID";
|
|
9283
10196
|
readonly type: "string";
|
|
9284
10197
|
readonly required: true;
|
|
9285
|
-
readonly description: "
|
|
10198
|
+
readonly description: "Identifier of the required template";
|
|
9286
10199
|
}, {
|
|
9287
10200
|
readonly name: "timeout";
|
|
9288
10201
|
readonly type: "integer";
|
|
@@ -9396,7 +10309,7 @@ export declare const operations: readonly [{
|
|
|
9396
10309
|
readonly resource: "sandbox.sandboxes";
|
|
9397
10310
|
readonly method: "connect";
|
|
9398
10311
|
readonly summary: "Connect sandbox (v2)";
|
|
9399
|
-
readonly description: "
|
|
10312
|
+
readonly description: "Returns sandbox details. If the sandbox is paused, it will be resumed. TTL is only extended. The request body is optional; an omitted timeout defaults to 300 seconds.";
|
|
9400
10313
|
readonly http: "POST";
|
|
9401
10314
|
readonly path: "/sandbox/v1/sandboxes/{sandboxID}/connect";
|
|
9402
10315
|
readonly streaming: "no";
|
|
@@ -9517,7 +10430,7 @@ export declare const operations: readonly [{
|
|
|
9517
10430
|
readonly resource: "sandbox.sandboxes.metrics";
|
|
9518
10431
|
readonly method: "list";
|
|
9519
10432
|
readonly summary: "Sandbox metrics";
|
|
9520
|
-
readonly description: "Read CPU, memory and disk usage over
|
|
10433
|
+
readonly description: "Read CPU, memory and disk usage samples of a sandbox over a time window. Use it to size a sandbox or find out why it is slow. start and end are Unix timestamps in seconds; without them the recent samples are returned. An unknown id answers 404.";
|
|
9521
10434
|
readonly http: "GET";
|
|
9522
10435
|
readonly path: "/sandbox/v1/sandboxes/{sandboxID}/metrics";
|
|
9523
10436
|
readonly streaming: "no";
|
|
@@ -9586,7 +10499,7 @@ export declare const operations: readonly [{
|
|
|
9586
10499
|
readonly resource: "sandbox.sandboxes";
|
|
9587
10500
|
readonly method: "pause";
|
|
9588
10501
|
readonly summary: "Pause sandbox";
|
|
9589
|
-
readonly description: "
|
|
10502
|
+
readonly description: "Pause a running sandbox, keeping its files and memory so that connectSandbox can resume it later. Use it to stop paying for compute without losing state; to discard the sandbox use killSandbox. Success answers 204. A sandbox that is not running answers 409.";
|
|
9590
10503
|
readonly http: "POST";
|
|
9591
10504
|
readonly path: "/sandbox/v1/sandboxes/{sandboxID}/pause";
|
|
9592
10505
|
readonly streaming: "no";
|
|
@@ -9902,7 +10815,7 @@ export declare const operations: readonly [{
|
|
|
9902
10815
|
readonly resource: "sandbox.templates";
|
|
9903
10816
|
readonly method: "list";
|
|
9904
10817
|
readonly summary: "List templates (v2)";
|
|
9905
|
-
readonly description: "
|
|
10818
|
+
readonly description: "List the templates you can create sandboxes from. Use it to pick the template id or alias for createSandbox. `base` is the default template that createSandbox uses when templateID is omitted. limit is 1 to 100 (default 100); send the cursor from the response back as nextToken to continue.";
|
|
9906
10819
|
readonly http: "GET";
|
|
9907
10820
|
readonly path: "/sandbox/v1/templates";
|
|
9908
10821
|
readonly streaming: "no";
|
|
@@ -10377,6 +11290,1161 @@ export declare const operations: readonly [{
|
|
|
10377
11290
|
readonly description: "Whether to filter out adult or unsafe content from results. Not supported for `fast` or `ultra-fast` search depths.";
|
|
10378
11291
|
}];
|
|
10379
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
|
+
}];
|
|
10380
12448
|
}, {
|
|
10381
12449
|
readonly resource: "vault.authorizations";
|
|
10382
12450
|
readonly method: "create";
|