@deepraxis/sdk 0.1.1-dev.d775f1e → 0.1.1-dev.e5614a0
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 +315 -1
- package/README.md +1 -1
- package/dist/automation.d.ts +61 -0
- package/dist/core/client.d.ts +11 -1
- package/dist/core/client.js +13 -0
- package/dist/core/transport.d.ts +9 -0
- package/dist/core/transport.js +13 -2
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +659 -31
- package/dist/generated/sdk.gen.js +2517 -519
- package/dist/generated/types.gen.d.ts +38175 -27560
- package/dist/helpers/application-build.d.ts +10 -0
- package/dist/helpers/application-build.js +98 -0
- package/dist/helpers/application-publish.d.ts +8 -0
- package/dist/helpers/application-publish.js +26 -9
- package/dist/helpers/browser-connect.d.ts +78 -0
- package/dist/helpers/browser-connect.js +161 -0
- package/dist/helpers/browser-decisions.d.ts +44 -0
- package/dist/helpers/browser-decisions.js +84 -0
- package/dist/helpers/browser-documentation.d.ts +2 -0
- package/dist/helpers/browser-documentation.js +47 -0
- package/dist/helpers/file-upload.d.ts +2 -2
- package/dist/helpers/sandbox-templates.d.ts +121 -0
- package/dist/helpers/sandbox-templates.js +60 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.js +3 -0
- package/dist/operations.generated.d.ts +3195 -131
- package/dist/operations.generated.js +3966 -146
- package/dist/resources.generated.d.ts +455 -39
- package/dist/resources.generated.js +190 -1
- package/package.json +1 -1
|
@@ -2,7 +2,7 @@ export declare const operations: readonly [{
|
|
|
2
2
|
readonly resource: "agent.agents";
|
|
3
3
|
readonly method: "list";
|
|
4
4
|
readonly summary: "List agents";
|
|
5
|
-
readonly description: "List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=personal for durable-computer agents
|
|
5
|
+
readonly description: "List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=general or kind=personal for durable-computer agents, kind=service for per-session environments, or kind=assume for external MCP clients. Pass next_page from the response as page to read the next page; a null next_page means the end.";
|
|
6
6
|
readonly http: "GET";
|
|
7
7
|
readonly path: "/agent/v1/agents";
|
|
8
8
|
readonly streaming: "no";
|
|
@@ -37,7 +37,7 @@ export declare const operations: readonly [{
|
|
|
37
37
|
}, {
|
|
38
38
|
readonly name: "kind";
|
|
39
39
|
readonly type: "string";
|
|
40
|
-
readonly enum: readonly ["personal", "service"];
|
|
40
|
+
readonly enum: readonly ["general", "personal", "service", "assume"];
|
|
41
41
|
readonly required: false;
|
|
42
42
|
readonly description: "Filter agents by their immutable kind, including agents created before kind was recorded.";
|
|
43
43
|
}];
|
|
@@ -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. skills attaches uploaded custom skills as [{type: \"custom\", skill_id, version?}] (skill_id from skills.create or skills.list; at most 20, no repeated skill_id). Omit version, or send \"latest\", to use the skill's newest version when a session starts. type anthropic returns 400. 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. model and every models.allowed entry must be a catalog model that can run an agent: an unknown id returns 400 \"model <id> is not in the model catalog\" and an embedding, image or speech model returns 400 \"model <id> cannot run an agent\". name is a label, not a unique key: 1 to 256 characters after trimming, no NUL or line breaks. avatar is trimmed, must not contain spaces or point at a loopback, private or internal host, and its scheme is stored in lowercase. script and workflow binding ids are stored in lowercase, the form automation matches; bindings together with environment_id null return 400 because bindings need a machine. Example: {\"name\":\"helper\",\"model\":{\"id\":\"deepseek-flash\"},\"tools\":[{\"type\":\"agent_toolset_20260401\"}]}.";
|
|
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. skills attaches uploaded custom skills as [{type: \"custom\", skill_id, version?}] (skill_id from skills.create or skills.list; at most 20, no repeated skill_id). Omit version, or send \"latest\", to use the skill's newest version when a session starts. type anthropic returns 400. 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. model and every models.allowed entry must be a catalog model that can run an agent: an unknown id returns 400 \"model <id> is not in the model catalog\" and an embedding, image or speech model returns 400 \"model <id> cannot run an agent\". name is a label, not a unique key: 1 to 256 characters after trimming, no NUL or line breaks. avatar is trimmed, must not contain spaces or point at a loopback, private or internal host, and its scheme is stored in lowercase. script and workflow binding ids are stored in lowercase, the form automation matches; bindings together with environment_id null return 400 because bindings need a machine. Example: {\"name\":\"helper\",\"model\":{\"id\":\"deepseek-flash\"},\"tools\":[{\"type\":\"agent_toolset_20260401\"}]}. For kind assume, provide name without model, models, subagent_model, subagents or multiagent; omit computer_id to register a new computer named after the agent without starting an instance, or provide an existing computer_id; vault_ids are accepted, bindings and environment_id are refused. Drive assume agents over MCP at /agent/v1/agents/{id}/mcp.";
|
|
49
49
|
readonly http: "POST";
|
|
50
50
|
readonly path: "/agent/v1/agents";
|
|
51
51
|
readonly streaming: "no";
|
|
@@ -57,8 +57,8 @@ export declare const operations: readonly [{
|
|
|
57
57
|
readonly fields: readonly [{
|
|
58
58
|
readonly name: "model";
|
|
59
59
|
readonly type: "object";
|
|
60
|
-
readonly required:
|
|
61
|
-
readonly description: "A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected.";
|
|
60
|
+
readonly required: false;
|
|
61
|
+
readonly description: "A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected. Forbidden and omitted on assume agents.";
|
|
62
62
|
}, {
|
|
63
63
|
readonly name: "name";
|
|
64
64
|
readonly type: "string";
|
|
@@ -107,13 +107,13 @@ export declare const operations: readonly [{
|
|
|
107
107
|
readonly type: "array";
|
|
108
108
|
readonly itemType: "object";
|
|
109
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. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.";
|
|
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; general and 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. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.";
|
|
111
111
|
}, {
|
|
112
112
|
readonly name: "kind";
|
|
113
113
|
readonly type: "string";
|
|
114
|
-
readonly enum: readonly ["personal", "service"];
|
|
114
|
+
readonly enum: readonly ["general", "personal", "service", "assume"];
|
|
115
115
|
readonly required: false;
|
|
116
|
-
readonly description: "Immutable agent kind. personal
|
|
116
|
+
readonly description: "Immutable agent kind. general and personal require computer_id; service cannot bind a computer. Omit on create to infer from computer_id (general with a computer, service without). On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error. Assume agents use a durable computer driven over MCP without a conversation model; model, models, subagent_model, subagents and multiagent are forbidden and omitted.";
|
|
117
117
|
}, {
|
|
118
118
|
readonly name: "computer_id";
|
|
119
119
|
readonly type: "string";
|
|
@@ -145,7 +145,7 @@ export declare const operations: readonly [{
|
|
|
145
145
|
readonly name: "settings";
|
|
146
146
|
readonly type: "object";
|
|
147
147
|
readonly required: false;
|
|
148
|
-
readonly description: "
|
|
148
|
+
readonly description: "Agent runtime settings follow Claude Code managed settings. Praxis freezes output-style selection for each new session; inline output_styles extend file-based styles. Omit settings to keep saved settings; null clears them.";
|
|
149
149
|
}, {
|
|
150
150
|
readonly name: "models";
|
|
151
151
|
readonly type: "object";
|
|
@@ -155,7 +155,7 @@ export declare const operations: readonly [{
|
|
|
155
155
|
readonly name: "avatar";
|
|
156
156
|
readonly type: "string";
|
|
157
157
|
readonly required: false;
|
|
158
|
-
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.
|
|
158
|
+
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. General, personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
159
159
|
}, {
|
|
160
160
|
readonly name: "environment_id";
|
|
161
161
|
readonly type: "string";
|
|
@@ -173,6 +173,12 @@ export declare const operations: readonly [{
|
|
|
173
173
|
readonly enum: readonly ["minimal", "data-editor", "full"];
|
|
174
174
|
readonly required: false;
|
|
175
175
|
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.";
|
|
176
|
+
}, {
|
|
177
|
+
readonly name: "output_styles";
|
|
178
|
+
readonly type: "array";
|
|
179
|
+
readonly itemType: "object";
|
|
180
|
+
readonly required: false;
|
|
181
|
+
readonly description: "Inline custom output styles, including for agents without a computer. Omit to keep the saved list; null or [] clears it. Same-name precedence is inline, project files, personal files, then plugins. Selection is settings.outputStyle; styles apply to main conversations and are frozen per session.";
|
|
176
182
|
}];
|
|
177
183
|
};
|
|
178
184
|
}, {
|
|
@@ -187,7 +193,7 @@ export declare const operations: readonly [{
|
|
|
187
193
|
readonly pathParams: readonly [{
|
|
188
194
|
readonly name: "agent_id";
|
|
189
195
|
readonly sdkName: "agent_id";
|
|
190
|
-
readonly description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name.";
|
|
196
|
+
readonly description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
191
197
|
}];
|
|
192
198
|
readonly query: readonly [{
|
|
193
199
|
readonly name: "version";
|
|
@@ -199,7 +205,7 @@ export declare const operations: readonly [{
|
|
|
199
205
|
readonly resource: "agent.agents";
|
|
200
206
|
readonly method: "update";
|
|
201
207
|
readonly summary: "Update agent";
|
|
202
|
-
readonly description: "Save configuration changes as a new immutable version. Send latest_version from a default retrieve or update response as the request version for optimistic concurrency; a stale value returns 409. apply defaults to true and makes the new version effective; apply false saves without changing active_version. The response contains the effective configuration, with version equal to active_version and latest_version naming the newest saved version. An unchanged configuration, including a note-only update, is a no-op returning 200 and the current effective version without creating or activating a version. version_note records up to 280 characters only when a configuration change creates a new version; null is equivalent to omission. Use agents.versions.apply to activate an existing saved 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. tools: [] removes every tool, while tools: null returns 400 (tools cannot be null; send [] to remove every tool). On update, omit skills to keep them, send an array to replace them, or send [] or null to clear them. skills attaches uploaded custom skills as [{type: \"custom\", skill_id, version?}] (skill_id from skills.create or skills.list; at most 20, no repeated skill_id). Omit version, or send \"latest\", to use the skill's newest version when a session starts. type anthropic returns 400.";
|
|
208
|
+
readonly description: "Save configuration changes as a new immutable version. Send latest_version from a default retrieve or update response as the request version for optimistic concurrency; a stale value returns 409. apply defaults to true and makes the new version effective; apply false saves without changing active_version. The response contains the effective configuration, with version equal to active_version and latest_version naming the newest saved version. An unchanged configuration, including a note-only update, is a no-op returning 200 and the current effective version without creating or activating a version. version_note records up to 280 characters only when a configuration change creates a new version; null is equivalent to omission. Use agents.versions.apply to activate an existing saved 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. tools: [] removes every tool, while tools: null returns 400 (tools cannot be null; send [] to remove every tool). On update, omit skills to keep them, send an array to replace them, or send [] or null to clear them. skills attaches uploaded custom skills as [{type: \"custom\", skill_id, version?}] (skill_id from skills.create or skills.list; at most 20, no repeated skill_id). Omit version, or send \"latest\", to use the skill's newest version when a session starts. type anthropic returns 400. Assume agents reject model, models, subagent_model, subagents and multiagent on every update; other fields follow the general agent rules, with vault_ids also accepted.";
|
|
203
209
|
readonly http: "POST";
|
|
204
210
|
readonly path: "/agent/v1/agents/{agent_id}";
|
|
205
211
|
readonly streaming: "no";
|
|
@@ -207,7 +213,7 @@ export declare const operations: readonly [{
|
|
|
207
213
|
readonly pathParams: readonly [{
|
|
208
214
|
readonly name: "agent_id";
|
|
209
215
|
readonly sdkName: "agent_id";
|
|
210
|
-
readonly description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name.";
|
|
216
|
+
readonly description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
211
217
|
}];
|
|
212
218
|
readonly query: readonly [];
|
|
213
219
|
readonly body: {
|
|
@@ -232,7 +238,7 @@ export declare const operations: readonly [{
|
|
|
232
238
|
readonly name: "model";
|
|
233
239
|
readonly type: "object";
|
|
234
240
|
readonly required: false;
|
|
235
|
-
readonly description: "A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected.";
|
|
241
|
+
readonly description: "A model id from the Praxis model catalog (`praxis.model.models.list`), or a `model_config` object for additional configuration control. Unlike Anthropic, Claude model ids other than those in the catalog are rejected. Forbidden and omitted on assume agents.";
|
|
236
242
|
}, {
|
|
237
243
|
readonly name: "multiagent";
|
|
238
244
|
readonly type: "object";
|
|
@@ -284,9 +290,9 @@ export declare const operations: readonly [{
|
|
|
284
290
|
}, {
|
|
285
291
|
readonly name: "kind";
|
|
286
292
|
readonly type: "string";
|
|
287
|
-
readonly enum: readonly ["personal", "service"];
|
|
293
|
+
readonly enum: readonly ["general", "personal", "service", "assume"];
|
|
288
294
|
readonly required: false;
|
|
289
|
-
readonly description: "Immutable agent kind. personal
|
|
295
|
+
readonly description: "Immutable agent kind. general and personal require computer_id; service cannot bind a computer. Omit on create to infer from computer_id (general with a computer, service without). On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error. Assume agents use a durable computer driven over MCP without a conversation model; model, models, subagent_model, subagents and multiagent are forbidden and omitted.";
|
|
290
296
|
}, {
|
|
291
297
|
readonly name: "computer_id";
|
|
292
298
|
readonly type: "string";
|
|
@@ -318,7 +324,7 @@ export declare const operations: readonly [{
|
|
|
318
324
|
readonly name: "settings";
|
|
319
325
|
readonly type: "object";
|
|
320
326
|
readonly required: false;
|
|
321
|
-
readonly description: "
|
|
327
|
+
readonly description: "Agent runtime settings follow Claude Code managed settings. Praxis freezes output-style selection for each new session; inline output_styles extend file-based styles. Omit settings to keep saved settings; null clears them.";
|
|
322
328
|
}, {
|
|
323
329
|
readonly name: "models";
|
|
324
330
|
readonly type: "object";
|
|
@@ -328,7 +334,7 @@ export declare const operations: readonly [{
|
|
|
328
334
|
readonly name: "avatar";
|
|
329
335
|
readonly type: "string";
|
|
330
336
|
readonly required: false;
|
|
331
|
-
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.
|
|
337
|
+
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. General, personal and service agents accept it. /agent/v1 only; /anthropic neither accepts nor returns it.";
|
|
332
338
|
}, {
|
|
333
339
|
readonly name: "environment_id";
|
|
334
340
|
readonly type: "string";
|
|
@@ -346,6 +352,12 @@ export declare const operations: readonly [{
|
|
|
346
352
|
readonly enum: readonly ["minimal", "data-editor", "full"];
|
|
347
353
|
readonly required: false;
|
|
348
354
|
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.";
|
|
355
|
+
}, {
|
|
356
|
+
readonly name: "output_styles";
|
|
357
|
+
readonly type: "array";
|
|
358
|
+
readonly itemType: "object";
|
|
359
|
+
readonly required: false;
|
|
360
|
+
readonly description: "Inline custom output styles, including for agents without a computer. Omit to keep the saved list; null or [] clears it. Same-name precedence is inline, project files, personal files, then plugins. Selection is settings.outputStyle; styles apply to main conversations and are frozen per session.";
|
|
349
361
|
}];
|
|
350
362
|
};
|
|
351
363
|
}, {
|
|
@@ -360,7 +372,7 @@ export declare const operations: readonly [{
|
|
|
360
372
|
readonly pathParams: readonly [{
|
|
361
373
|
readonly name: "agent_id";
|
|
362
374
|
readonly sdkName: "agent_id";
|
|
363
|
-
readonly description: "Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for.";
|
|
375
|
+
readonly description: "Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
364
376
|
}];
|
|
365
377
|
readonly query: readonly [];
|
|
366
378
|
}, {
|
|
@@ -375,7 +387,7 @@ export declare const operations: readonly [{
|
|
|
375
387
|
readonly pathParams: readonly [{
|
|
376
388
|
readonly name: "agent_id";
|
|
377
389
|
readonly sdkName: "agent_id";
|
|
378
|
-
readonly description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name.";
|
|
390
|
+
readonly description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
379
391
|
}];
|
|
380
392
|
readonly query: readonly [];
|
|
381
393
|
}, {
|
|
@@ -390,7 +402,7 @@ export declare const operations: readonly [{
|
|
|
390
402
|
readonly pathParams: readonly [{
|
|
391
403
|
readonly name: "agent_id";
|
|
392
404
|
readonly sdkName: "agent_id";
|
|
393
|
-
readonly description: "Active service agent id from agent creation or listing.";
|
|
405
|
+
readonly description: "Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
394
406
|
}];
|
|
395
407
|
readonly query: readonly [{
|
|
396
408
|
readonly name: "limit";
|
|
@@ -431,7 +443,7 @@ export declare const operations: readonly [{
|
|
|
431
443
|
readonly pathParams: readonly [{
|
|
432
444
|
readonly name: "agent_id";
|
|
433
445
|
readonly sdkName: "agent_id";
|
|
434
|
-
readonly description: "Service agent id (agent_…) or its short identity number, from agent creation or listing.";
|
|
446
|
+
readonly description: "Service agent id (agent_…) or its short identity number, from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
435
447
|
}];
|
|
436
448
|
readonly query: readonly [];
|
|
437
449
|
readonly body: {
|
|
@@ -450,7 +462,7 @@ export declare const operations: readonly [{
|
|
|
450
462
|
readonly pathParams: readonly [{
|
|
451
463
|
readonly name: "agent_id";
|
|
452
464
|
readonly sdkName: "agent_id";
|
|
453
|
-
readonly description: "Service agent id (agent_…) or its short identity number, from agent creation or listing.";
|
|
465
|
+
readonly description: "Service agent id (agent_…) or its short identity number, from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
454
466
|
}];
|
|
455
467
|
readonly query: readonly [];
|
|
456
468
|
}, {
|
|
@@ -465,7 +477,7 @@ export declare const operations: readonly [{
|
|
|
465
477
|
readonly pathParams: readonly [{
|
|
466
478
|
readonly name: "agent_id";
|
|
467
479
|
readonly sdkName: "agent_id";
|
|
468
|
-
readonly description: "Service agent id (agent_…) or its short identity number, from agent creation or listing.";
|
|
480
|
+
readonly description: "Service agent id (agent_…) or its short identity number, from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
469
481
|
}];
|
|
470
482
|
readonly query: readonly [];
|
|
471
483
|
}, {
|
|
@@ -480,7 +492,7 @@ export declare const operations: readonly [{
|
|
|
480
492
|
readonly pathParams: readonly [{
|
|
481
493
|
readonly name: "agent_id";
|
|
482
494
|
readonly sdkName: "agent_id";
|
|
483
|
-
readonly description: "Service agent id (agent_…) or its short identity number, from agent creation or listing.";
|
|
495
|
+
readonly description: "Service agent id (agent_…) or its short identity number, from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
484
496
|
}];
|
|
485
497
|
readonly query: readonly [];
|
|
486
498
|
readonly body: {
|
|
@@ -555,7 +567,7 @@ export declare const operations: readonly [{
|
|
|
555
567
|
readonly pathParams: readonly [{
|
|
556
568
|
readonly name: "agent_id";
|
|
557
569
|
readonly sdkName: "agent_id";
|
|
558
|
-
readonly description: "Active service agent id from agent creation or listing.";
|
|
570
|
+
readonly description: "Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
559
571
|
}, {
|
|
560
572
|
readonly name: "customer_id";
|
|
561
573
|
readonly sdkName: "customer_id";
|
|
@@ -579,7 +591,7 @@ export declare const operations: readonly [{
|
|
|
579
591
|
readonly pathParams: readonly [{
|
|
580
592
|
readonly name: "agent_id";
|
|
581
593
|
readonly sdkName: "agent_id";
|
|
582
|
-
readonly description: "Active service agent id from agent creation or listing.";
|
|
594
|
+
readonly description: "Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
583
595
|
}, {
|
|
584
596
|
readonly name: "customer_id";
|
|
585
597
|
readonly sdkName: "customer_id";
|
|
@@ -598,7 +610,7 @@ export declare const operations: readonly [{
|
|
|
598
610
|
readonly pathParams: readonly [{
|
|
599
611
|
readonly name: "agent_id";
|
|
600
612
|
readonly sdkName: "agent_id";
|
|
601
|
-
readonly description: "Active service agent id from agent creation or listing.";
|
|
613
|
+
readonly description: "Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
602
614
|
}, {
|
|
603
615
|
readonly name: "customer_id";
|
|
604
616
|
readonly sdkName: "customer_id";
|
|
@@ -617,7 +629,7 @@ export declare const operations: readonly [{
|
|
|
617
629
|
readonly pathParams: readonly [{
|
|
618
630
|
readonly name: "agent_id";
|
|
619
631
|
readonly sdkName: "agent_id";
|
|
620
|
-
readonly description: "Active service agent id from agent creation or listing.";
|
|
632
|
+
readonly description: "Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
621
633
|
}, {
|
|
622
634
|
readonly name: "customer_id";
|
|
623
635
|
readonly sdkName: "customer_id";
|
|
@@ -636,7 +648,7 @@ export declare const operations: readonly [{
|
|
|
636
648
|
readonly pathParams: readonly [{
|
|
637
649
|
readonly name: "agent_id";
|
|
638
650
|
readonly sdkName: "agent_id";
|
|
639
|
-
readonly description: "Active service agent id from agent creation or listing.";
|
|
651
|
+
readonly description: "Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
640
652
|
}, {
|
|
641
653
|
readonly name: "customer_id";
|
|
642
654
|
readonly sdkName: "customer_id";
|
|
@@ -655,7 +667,7 @@ export declare const operations: readonly [{
|
|
|
655
667
|
readonly pathParams: readonly [{
|
|
656
668
|
readonly name: "agent_id";
|
|
657
669
|
readonly sdkName: "agent_id";
|
|
658
|
-
readonly description: "Active service agent id from agent creation or listing.";
|
|
670
|
+
readonly description: "Active service agent id from agent creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
659
671
|
}, {
|
|
660
672
|
readonly name: "customer_id";
|
|
661
673
|
readonly sdkName: "customer_id";
|
|
@@ -674,7 +686,7 @@ export declare const operations: readonly [{
|
|
|
674
686
|
readonly pathParams: readonly [{
|
|
675
687
|
readonly name: "agent_id";
|
|
676
688
|
readonly sdkName: "agent_id";
|
|
677
|
-
readonly description: "Agent id from creation or listing.";
|
|
689
|
+
readonly description: "Agent id from creation or listing. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
678
690
|
}];
|
|
679
691
|
readonly query: readonly [];
|
|
680
692
|
}, {
|
|
@@ -689,7 +701,7 @@ export declare const operations: readonly [{
|
|
|
689
701
|
readonly pathParams: readonly [{
|
|
690
702
|
readonly name: "agent_id";
|
|
691
703
|
readonly sdkName: "agent_id";
|
|
692
|
-
readonly description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name.";
|
|
704
|
+
readonly description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
693
705
|
}];
|
|
694
706
|
readonly query: readonly [{
|
|
695
707
|
readonly name: "limit";
|
|
@@ -714,7 +726,7 @@ export declare const operations: readonly [{
|
|
|
714
726
|
readonly pathParams: readonly [{
|
|
715
727
|
readonly name: "agent_id";
|
|
716
728
|
readonly sdkName: "agent_id";
|
|
717
|
-
readonly description: "Agent identifier from agents.create or agents.list.";
|
|
729
|
+
readonly description: "Agent identifier from agents.create or agents.list. Also accepts an 8-character identity number (0–9, A–Z); malformed, absent and foreign references return 404, and response ids always use agent_….";
|
|
718
730
|
}, {
|
|
719
731
|
readonly name: "version";
|
|
720
732
|
readonly sdkName: "version";
|
|
@@ -747,7 +759,7 @@ export declare const operations: readonly [{
|
|
|
747
759
|
readonly resource: "agent.computers";
|
|
748
760
|
readonly method: "create";
|
|
749
761
|
readonly summary: "Create Computer";
|
|
750
|
-
readonly description: "Create a durable computer: a named machine whose files outlive sessions, for personal agents.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
|
|
762
|
+
readonly description: "Create a durable computer: a named machine whose files outlive sessions, for general and personal agents.\n\nPraxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. Archived files remain readable, but new sessions cannot bind them. environment_id is an optional recipe reference; computers start with a light sandbox and expose the public SDK sandbox_id. Lists include archived computers.";
|
|
751
763
|
readonly http: "POST";
|
|
752
764
|
readonly path: "/agent/v1/computers";
|
|
753
765
|
readonly streaming: "no";
|
|
@@ -1089,7 +1101,7 @@ export declare const operations: readonly [{
|
|
|
1089
1101
|
readonly resource: "agent.deployments";
|
|
1090
1102
|
readonly method: "create";
|
|
1091
1103
|
readonly summary: "Create deployment";
|
|
1092
|
-
readonly description: "Freeze session parameters as a deployment; this operation does not open a session. Pass an agent id or versioned reference, a name, 1–50 user.message initial events and an environment_id from environments.list. Unlike Anthropic Managed Agents, /agent/v1 also accepts agent_with_overrides (model, permission_mode and cwd) and target=computer for personal agents, with environment_id omitted. Cron schedules use five POSIX fields and an IANA timezone. File resources are accepted. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. Active schedules run every minute when due; session creation errors pause the deployment. Unsupported tools, mcp_servers, system and skills overrides return 400.";
|
|
1104
|
+
readonly description: "Freeze session parameters as a deployment; this operation does not open a session. Pass an agent id or versioned reference, a name, 1–50 user.message initial events and an environment_id from environments.list. Unlike Anthropic Managed Agents, /agent/v1 also accepts agent_with_overrides (model, permission_mode and cwd) and target=computer for general and personal agents, with environment_id omitted. Cron schedules use five POSIX fields and an IANA timezone. File resources are accepted. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. Active schedules run every minute when due; session creation errors pause the deployment. Unsupported tools, mcp_servers, system and skills overrides return 400.";
|
|
1093
1105
|
readonly http: "POST";
|
|
1094
1106
|
readonly path: "/agent/v1/deployments";
|
|
1095
1107
|
readonly streaming: "no";
|
|
@@ -1155,7 +1167,7 @@ export declare const operations: readonly [{
|
|
|
1155
1167
|
readonly name: "target";
|
|
1156
1168
|
readonly type: "object";
|
|
1157
1169
|
readonly required: false;
|
|
1158
|
-
readonly description: "Execution target. environment (default) requires an existing, unarchived environment_id. computer is available only for personal agents and permits environment_id to be omitted.";
|
|
1170
|
+
readonly description: "Execution target. environment (default) requires an existing, unarchived environment_id. computer is available only for general and personal agents and permits environment_id to be omitted.";
|
|
1159
1171
|
}];
|
|
1160
1172
|
};
|
|
1161
1173
|
}, {
|
|
@@ -1247,7 +1259,7 @@ export declare const operations: readonly [{
|
|
|
1247
1259
|
readonly name: "target";
|
|
1248
1260
|
readonly type: "object";
|
|
1249
1261
|
readonly required: false;
|
|
1250
|
-
readonly description: "Execution target. environment (default) requires an existing, unarchived environment_id. computer is available only for personal agents and permits environment_id to be omitted.";
|
|
1262
|
+
readonly description: "Execution target. environment (default) requires an existing, unarchived environment_id. computer is available only for general and personal agents and permits environment_id to be omitted.";
|
|
1251
1263
|
}];
|
|
1252
1264
|
};
|
|
1253
1265
|
}, {
|
|
@@ -1536,7 +1548,7 @@ export declare const operations: readonly [{
|
|
|
1536
1548
|
readonly resource: "agent.sessions";
|
|
1537
1549
|
readonly method: "create";
|
|
1538
1550
|
readonly summary: "Create session";
|
|
1539
|
-
readonly description: "Create a session: one conversation with an agent. Pass agent as an agent id or {type:\"agent\", id, version?}; an id alone, or an object without version, pins the agent's active_version (the version chosen with agents.versions.apply, not necessarily the newest saved one). Unlike Anthropic Managed Agents, omit environment_id to use the default environment saved in the agent version (light for a new agent), unless computer_id (explicit, or the agent's default) selects a Computer; pass an environment id for a sandbox recipe. For service agents, 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. Unlike Anthropic Managed Agents, the only inline agent override is system ({type:\"agent_with_overrides\", id, system}); to change the model, tools, MCP servers or skills, save a version instead. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. budget is {type:\"limit\", max_list_cost:{amount, currency:\"USD\"}} where amount is a positive
|
|
1551
|
+
readonly description: "Create a session: one conversation with an agent. Pass agent as an agent id or {type:\"agent\", id, version?}; an id alone, or an object without version, pins the agent's active_version (the version chosen with agents.versions.apply, not necessarily the newest saved one). Unlike Anthropic Managed Agents, omit environment_id to use the default environment saved in the agent version (light for a new agent), unless computer_id (explicit, or the agent's default) selects a Computer; pass an environment id for a sandbox recipe. For service agents, 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. Unlike Anthropic Managed Agents, the only inline agent override is system ({type:\"agent_with_overrides\", id, system}); to change the model, tools, MCP servers or skills, save a version instead. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. budget is {type:\"limit\", max_list_cost:{amount, currency:\"USD\"}} where amount is a positive decimal string of US dollars with at most 2 decimal places (\"20.00\" is USD 20.00); omitted budget defaults to \"20.00\" and null removes the limit. 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. Assume agents return 400 INVALID_PARAMS; drive them over MCP at /agent/v1/agents/{id}/mcp instead.";
|
|
1540
1552
|
readonly http: "POST";
|
|
1541
1553
|
readonly path: "/agent/v1/sessions";
|
|
1542
1554
|
readonly streaming: "no";
|
|
@@ -1777,7 +1789,7 @@ export declare const operations: readonly [{
|
|
|
1777
1789
|
readonly resource: "agent.sessions";
|
|
1778
1790
|
readonly method: "compact";
|
|
1779
1791
|
readonly summary: "Compact Session (Extension)";
|
|
1780
|
-
readonly description: "Request session context compaction and retrieve an operation receipt.\n\nAvailable only on /agent/v1. The body may be omitted or {}. Optional instructions must be a string and is forwarded unchanged. Idempotency-Key is forwarded unchanged; a UUID is generated when absent. Returns { type: session_compaction, id, status, reason? }, where id is the operation ID. queued/running return 202; skipped/succeeded/failed return 200. Non-string instructions return 400 invalid_request_error. Missing or inaccessible managed sessions return 404 not_found_error.";
|
|
1792
|
+
readonly description: "Request session context compaction and retrieve an operation receipt.\n\nAvailable only on /agent/v1. The body may be omitted or {}. Optional instructions must be a string and is forwarded unchanged. Idempotency-Key is forwarded unchanged; a UUID is generated when absent. Returns { type: session_compaction, id, status, reason? }, where id is the operation ID. queued/running return 202; skipped/succeeded/failed/cancelled return 200. Non-string instructions return 400 invalid_request_error. Missing or inaccessible managed sessions return 404 not_found_error.";
|
|
1781
1793
|
readonly http: "POST";
|
|
1782
1794
|
readonly path: "/agent/v1/sessions/{session_id}/compact";
|
|
1783
1795
|
readonly streaming: "no";
|
|
@@ -1820,7 +1832,7 @@ export declare const operations: readonly [{
|
|
|
1820
1832
|
readonly resource: "agent.sessions.compactions";
|
|
1821
1833
|
readonly method: "list";
|
|
1822
1834
|
readonly summary: "List Session Compactions (Extension)";
|
|
1823
|
-
readonly description: "Read session compaction history and summaries.\n\nAvailable only on /agent/v1. Returns { data: [...] }. Each entry contains type, id, event_id, trigger, status, model, compacted_message_count, input_tokens_before, input_tokens_after, summary, error and created_at, as recorded by the service. Missing or inaccessible managed sessions return 404 not_found_error.";
|
|
1835
|
+
readonly description: "Read session compaction history and summaries.\n\nAvailable only on /agent/v1. Returns { data: [...], active }. active is the queued or running compaction ({ type: session_compaction, id, status, trigger: manual|auto|idle }), or null when none; manual work takes precedence. Each data entry contains type, id, event_id, trigger, status, model, compacted_message_count, input_tokens_before, input_tokens_after, summary, error and created_at, as recorded by the service. Missing or inaccessible managed sessions return 404 not_found_error.";
|
|
1824
1836
|
readonly http: "GET";
|
|
1825
1837
|
readonly path: "/agent/v1/sessions/{session_id}/compactions";
|
|
1826
1838
|
readonly streaming: "no";
|
|
@@ -1990,9 +2002,9 @@ export declare const operations: readonly [{
|
|
|
1990
2002
|
}];
|
|
1991
2003
|
readonly query: readonly [{
|
|
1992
2004
|
readonly name: "limit";
|
|
1993
|
-
readonly type: "
|
|
2005
|
+
readonly type: "integer";
|
|
1994
2006
|
readonly required: false;
|
|
1995
|
-
readonly description: "Number of
|
|
2007
|
+
readonly description: "Number of resources per page, from 1 to 100; defaults to 100.";
|
|
1996
2008
|
}, {
|
|
1997
2009
|
readonly name: "page";
|
|
1998
2010
|
readonly type: "string";
|
|
@@ -2852,7 +2864,7 @@ export declare const operations: readonly [{
|
|
|
2852
2864
|
readonly resource: "application.workers.grants";
|
|
2853
2865
|
readonly method: "create";
|
|
2854
2866
|
readonly summary: "Create grant";
|
|
2855
|
-
readonly description: "
|
|
2867
|
+
readonly description: "Record access to an organization-owned database or knowledge base, all organization files (files, id *), or models (models, id *, read only). Each resource and optional alias must be unique within this Worker. Foreign and missing resources both return RESOURCE_NOT_FOUND (404); an unavailable resource service returns PROVIDER_CAPACITY (503, retryable).";
|
|
2856
2868
|
readonly http: "POST";
|
|
2857
2869
|
readonly path: "/application/v1/workers/{worker_id}/grants";
|
|
2858
2870
|
readonly streaming: "no";
|
|
@@ -2869,13 +2881,18 @@ export declare const operations: readonly [{
|
|
|
2869
2881
|
readonly name: "resource";
|
|
2870
2882
|
readonly type: "object";
|
|
2871
2883
|
readonly required: true;
|
|
2872
|
-
readonly description: "Resource to grant.";
|
|
2884
|
+
readonly description: "Resource to grant. Each (type, id) may be granted once per Worker; duplicates return GRANT_CONFLICT (409).";
|
|
2885
|
+
}, {
|
|
2886
|
+
readonly name: "alias";
|
|
2887
|
+
readonly type: "string";
|
|
2888
|
+
readonly required: false;
|
|
2889
|
+
readonly description: "Optional name, unique within this Worker. Available for reuse after the grant is deleted.";
|
|
2873
2890
|
}, {
|
|
2874
2891
|
readonly name: "access";
|
|
2875
2892
|
readonly type: "string";
|
|
2876
2893
|
readonly enum: readonly ["read", "read_write"];
|
|
2877
2894
|
readonly required: true;
|
|
2878
|
-
readonly description: "Access level.";
|
|
2895
|
+
readonly description: "Access level; models accepts read only.";
|
|
2879
2896
|
}];
|
|
2880
2897
|
};
|
|
2881
2898
|
}, {
|
|
@@ -3108,7 +3125,7 @@ export declare const operations: readonly [{
|
|
|
3108
3125
|
readonly resource: "automation.actions";
|
|
3109
3126
|
readonly method: "list";
|
|
3110
3127
|
readonly summary: "List actions";
|
|
3111
|
-
readonly description: "Discover callable Actions and their ns/name references without executing them. Combine each returned namespace and name as ns/name; Action calls use the current revision and do not accept @version or @tag. Filter by name or description; results include seven-day statistics and revision summaries without implementation source. Archived actions are excluded by default.";
|
|
3128
|
+
readonly description: "Discover callable Actions and their ns/name references without executing them. Combine each returned namespace and name as ns/name; Action calls use the current revision and do not accept @version or @tag. Filter by name or description; results include seven-day statistics and revision summaries without implementation source. Archived actions are excluded by default. List items carry no input contract: get the action and read current_revision.input_schema. Call it with call(\"ns/name\", input) in a script or call: ns/name with with: in a workflow.";
|
|
3112
3129
|
readonly http: "GET";
|
|
3113
3130
|
readonly path: "/automation/v1/actions";
|
|
3114
3131
|
readonly streaming: "no";
|
|
@@ -3223,7 +3240,7 @@ export declare const operations: readonly [{
|
|
|
3223
3240
|
readonly name: "timeout_ms";
|
|
3224
3241
|
readonly type: "number";
|
|
3225
3242
|
readonly required: false;
|
|
3226
|
-
readonly description: "Positive integer milliseconds; code defaults to and is capped at
|
|
3243
|
+
readonly description: "Positive integer milliseconds; code defaults to and is capped at 300,000. container/shell are not yet available.";
|
|
3227
3244
|
}, {
|
|
3228
3245
|
readonly name: "implementation";
|
|
3229
3246
|
readonly type: "object";
|
|
@@ -3245,7 +3262,7 @@ export declare const operations: readonly [{
|
|
|
3245
3262
|
readonly resource: "automation.actions";
|
|
3246
3263
|
readonly method: "retrieve";
|
|
3247
3264
|
readonly summary: "Get an Action with its current input and output JSON Schemas";
|
|
3248
|
-
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.";
|
|
3265
|
+
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) or in a workflow step with call: ocr and with:. Input that breaks the contract returns INPUT_INVALID, with the fields in errors[]. The response ETag is the current revision ID for conditional updates.";
|
|
3249
3266
|
readonly http: "GET";
|
|
3250
3267
|
readonly path: "/automation/v1/actions/{ns}/{name}";
|
|
3251
3268
|
readonly streaming: "no";
|
|
@@ -3264,7 +3281,7 @@ export declare const operations: readonly [{
|
|
|
3264
3281
|
readonly resource: "automation.actions";
|
|
3265
3282
|
readonly method: "update";
|
|
3266
3283
|
readonly summary: "Update an action";
|
|
3267
|
-
readonly description: "Update after checking compatibility against the current and five recent revisions. Widening inputs and narrowing outputs are compatible, including length, item count, property count, type (integer/number), and multipleOf (the new input factor divides the old one; the reverse holds for outputs). dry_run=true returns only CompatResult and may omit If-Match; a supplied header is still checked, and * matches any existing representation. Normal updates require If-Match and return ActionDef with ETag; previews return no ETag. Omitted optional fields retain their existing values only for description and labels; when constructing a new revision, errors defaults to [], omitted annotations keys to false, timeout_ms to
|
|
3284
|
+
readonly description: "Update after checking compatibility against the current and five recent revisions. Widening inputs and narrowing outputs are compatible, including length, item count, property count, type (integer/number), and multipleOf (the new input factor divides the old one; the reverse holds for outputs). dry_run=true returns only CompatResult and may omit If-Match; a supplied header is still checked, and * matches any existing representation. Normal updates require If-Match and return ActionDef with ETag; previews return no ETag. Omitted optional fields retain their existing values only for description and labels; when constructing a new revision, errors defaults to [], omitted annotations keys to false, timeout_ms to 300000, and message to null. Incompatible normal updates return 422 SCHEMA_INCOMPATIBLE with issues; unchanged contents retain the existing revision.";
|
|
3268
3285
|
readonly http: "PUT";
|
|
3269
3286
|
readonly path: "/automation/v1/actions/{ns}/{name}";
|
|
3270
3287
|
readonly streaming: "no";
|
|
@@ -3321,7 +3338,7 @@ export declare const operations: readonly [{
|
|
|
3321
3338
|
readonly name: "timeout_ms";
|
|
3322
3339
|
readonly type: "number";
|
|
3323
3340
|
readonly required: false;
|
|
3324
|
-
readonly description: "Positive integer milliseconds; code defaults to and is capped at
|
|
3341
|
+
readonly description: "Positive integer milliseconds; code defaults to and is capped at 300,000. container/shell are not yet available.";
|
|
3325
3342
|
}, {
|
|
3326
3343
|
readonly name: "implementation";
|
|
3327
3344
|
readonly type: "object";
|
|
@@ -3580,6 +3597,142 @@ export declare const operations: readonly [{
|
|
|
3580
3597
|
readonly required: false;
|
|
3581
3598
|
readonly fields: readonly [];
|
|
3582
3599
|
};
|
|
3600
|
+
}, {
|
|
3601
|
+
readonly resource: "automation.humanTasks";
|
|
3602
|
+
readonly method: "list";
|
|
3603
|
+
readonly summary: "List human tasks";
|
|
3604
|
+
readonly description: "List the human tasks that praxis/approval workflow steps opened, newest first. By default it returns only open tasks assigned to the caller: their approval inbox. scope=all lists every task of the organization, and status and run_id narrow the list. Use a returned id with retrieve for details and respond to decide. Read-only: listing never changes a task.";
|
|
3605
|
+
readonly http: "GET";
|
|
3606
|
+
readonly path: "/automation/v1/human-tasks";
|
|
3607
|
+
readonly streaming: "no";
|
|
3608
|
+
readonly pagination: true;
|
|
3609
|
+
readonly pathParams: readonly [];
|
|
3610
|
+
readonly query: readonly [{
|
|
3611
|
+
readonly name: "limit";
|
|
3612
|
+
readonly type: "integer";
|
|
3613
|
+
readonly required: false;
|
|
3614
|
+
readonly description: "Page size, 1–100, default 50.";
|
|
3615
|
+
}, {
|
|
3616
|
+
readonly name: "cursor";
|
|
3617
|
+
readonly type: "string";
|
|
3618
|
+
readonly required: false;
|
|
3619
|
+
readonly description: "The next_cursor of the previous page; omit for the first page.";
|
|
3620
|
+
}, {
|
|
3621
|
+
readonly name: "status";
|
|
3622
|
+
readonly type: "array";
|
|
3623
|
+
readonly itemType: "string";
|
|
3624
|
+
readonly enum: readonly ["open", "completed", "expired", "cancelled"];
|
|
3625
|
+
readonly required: false;
|
|
3626
|
+
readonly description: "Filter by status, comma-separated: open, completed, expired, cancelled. Defaults to open.";
|
|
3627
|
+
}, {
|
|
3628
|
+
readonly name: "run_id";
|
|
3629
|
+
readonly type: "string";
|
|
3630
|
+
readonly required: false;
|
|
3631
|
+
readonly description: "Only tasks opened by this run (run_).";
|
|
3632
|
+
}, {
|
|
3633
|
+
readonly name: "scope";
|
|
3634
|
+
readonly type: "string";
|
|
3635
|
+
readonly enum: readonly ["assigned", "all"];
|
|
3636
|
+
readonly required: false;
|
|
3637
|
+
readonly description: "assigned (default) lists only tasks assigned to the caller; all lists every task of the organization.";
|
|
3638
|
+
}];
|
|
3639
|
+
}, {
|
|
3640
|
+
readonly resource: "automation.humanTasks";
|
|
3641
|
+
readonly method: "retrieve";
|
|
3642
|
+
readonly summary: "Retrieve a human task";
|
|
3643
|
+
readonly description: "Read one human task - title, Markdown body, context, actions, form, assignees, mode, due time, responses and outcome - so an assignee can choose an action and fill the form. Read-only; the Console approval page /automation/tasks/{id} reads the same resource.";
|
|
3644
|
+
readonly http: "GET";
|
|
3645
|
+
readonly path: "/automation/v1/human-tasks/{id}";
|
|
3646
|
+
readonly streaming: "no";
|
|
3647
|
+
readonly pagination: false;
|
|
3648
|
+
readonly pathParams: readonly [{
|
|
3649
|
+
readonly name: "id";
|
|
3650
|
+
readonly sdkName: "id";
|
|
3651
|
+
readonly description: "Human task ID (htask_), from the list or the run's waits.";
|
|
3652
|
+
}];
|
|
3653
|
+
readonly query: readonly [];
|
|
3654
|
+
}, {
|
|
3655
|
+
readonly resource: "automation.humanTasks";
|
|
3656
|
+
readonly method: "cancel";
|
|
3657
|
+
readonly summary: "Cancel a human task";
|
|
3658
|
+
readonly description: "Cancel an open human task; only the person who started the run or an organization API key may cancel. The task becomes cancelled and the waiting workflow step raises a runtime error with code HUMAN_TASK_CANCELLED, which try/catch can catch. Open tasks are cancelled automatically when their run ends, so this call is not needed then.";
|
|
3659
|
+
readonly http: "POST";
|
|
3660
|
+
readonly path: "/automation/v1/human-tasks/{id}/cancel";
|
|
3661
|
+
readonly streaming: "no";
|
|
3662
|
+
readonly pagination: false;
|
|
3663
|
+
readonly pathParams: readonly [{
|
|
3664
|
+
readonly name: "id";
|
|
3665
|
+
readonly sdkName: "id";
|
|
3666
|
+
readonly description: "Human task ID (htask_).";
|
|
3667
|
+
}];
|
|
3668
|
+
readonly query: readonly [];
|
|
3669
|
+
readonly body: {
|
|
3670
|
+
readonly required: false;
|
|
3671
|
+
readonly fields: readonly [{
|
|
3672
|
+
readonly name: "reason";
|
|
3673
|
+
readonly type: "string";
|
|
3674
|
+
readonly required: false;
|
|
3675
|
+
readonly description: "Optional cancellation reason, at most 500 characters.";
|
|
3676
|
+
}];
|
|
3677
|
+
};
|
|
3678
|
+
}, {
|
|
3679
|
+
readonly resource: "automation.humanTasks";
|
|
3680
|
+
readonly method: "delegate";
|
|
3681
|
+
readonly summary: "Delegate a human task";
|
|
3682
|
+
readonly description: "An assignee who has not responded hands their place to another user (to_user), replacing their entry in assignees.users in place, so sequential order is kept. The new user cannot already be an assignee, nor the initiator unless self-approval is allowed. The task must still be open.";
|
|
3683
|
+
readonly http: "POST";
|
|
3684
|
+
readonly path: "/automation/v1/human-tasks/{id}/delegate";
|
|
3685
|
+
readonly streaming: "no";
|
|
3686
|
+
readonly pagination: false;
|
|
3687
|
+
readonly pathParams: readonly [{
|
|
3688
|
+
readonly name: "id";
|
|
3689
|
+
readonly sdkName: "id";
|
|
3690
|
+
readonly description: "Human task ID (htask_).";
|
|
3691
|
+
}];
|
|
3692
|
+
readonly query: readonly [];
|
|
3693
|
+
readonly body: {
|
|
3694
|
+
readonly required: true;
|
|
3695
|
+
readonly fields: readonly [{
|
|
3696
|
+
readonly name: "to_user";
|
|
3697
|
+
readonly type: "string";
|
|
3698
|
+
readonly required: true;
|
|
3699
|
+
readonly description: "User ID taking over; cannot already be an assignee, nor the initiator unless self-approval is allowed.";
|
|
3700
|
+
}];
|
|
3701
|
+
};
|
|
3702
|
+
}, {
|
|
3703
|
+
readonly resource: "automation.humanTasks";
|
|
3704
|
+
readonly method: "respond";
|
|
3705
|
+
readonly summary: "Respond to a human task";
|
|
3706
|
+
readonly description: "Submit an action (action_id), form values (values) and a comment as the calling user. Depending on the task's mode the response either decides it (status becomes completed, outcome is set, and the waiting workflow resumes with outcome as the step output) or is recorded while other assignees are awaited. When two assignees respond at once, exactly one decides and the other gets TASK_CLOSED. An agent may respond only if the workflow set allow_agent_decision. Send an Idempotency-Key to retry safely.";
|
|
3707
|
+
readonly http: "POST";
|
|
3708
|
+
readonly path: "/automation/v1/human-tasks/{id}/respond";
|
|
3709
|
+
readonly streaming: "no";
|
|
3710
|
+
readonly pagination: false;
|
|
3711
|
+
readonly pathParams: readonly [{
|
|
3712
|
+
readonly name: "id";
|
|
3713
|
+
readonly sdkName: "id";
|
|
3714
|
+
readonly description: "Human task ID (htask_).";
|
|
3715
|
+
}];
|
|
3716
|
+
readonly query: readonly [];
|
|
3717
|
+
readonly body: {
|
|
3718
|
+
readonly required: true;
|
|
3719
|
+
readonly fields: readonly [{
|
|
3720
|
+
readonly name: "action_id";
|
|
3721
|
+
readonly type: "string";
|
|
3722
|
+
readonly required: true;
|
|
3723
|
+
readonly description: "The chosen action ID from the task's actions, for example approve.";
|
|
3724
|
+
}, {
|
|
3725
|
+
readonly name: "values";
|
|
3726
|
+
readonly type: "object";
|
|
3727
|
+
readonly required: false;
|
|
3728
|
+
readonly description: "Any JSON object whose keys are strings and whose values are any JSON value.";
|
|
3729
|
+
}, {
|
|
3730
|
+
readonly name: "comment";
|
|
3731
|
+
readonly type: "string";
|
|
3732
|
+
readonly required: false;
|
|
3733
|
+
readonly description: "Comment of at most 4000 characters; required when the action has require_comment true.";
|
|
3734
|
+
}];
|
|
3735
|
+
};
|
|
3583
3736
|
}, {
|
|
3584
3737
|
readonly resource: "automation.resolve";
|
|
3585
3738
|
readonly method: "retrieve";
|
|
@@ -3711,7 +3864,7 @@ export declare const operations: readonly [{
|
|
|
3711
3864
|
readonly resource: "automation.runs";
|
|
3712
3865
|
readonly method: "create";
|
|
3713
3866
|
readonly summary: "Run a published target or execute draft source";
|
|
3714
|
-
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
|
|
3867
|
+
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 5 min (run-sandbox after 6 h); scripts have a 30 min wall-clock limit and a 30 s CPU limit; workflows default to 24 h and allow up to 30 days. Each run can start at most 1,000 child runs, with at most 100 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. With language=yaml, source is a workflow YAML: the run input is . in the first step, and the shape is described in create workflow. Error details are in errors[] (pointer, detail, hint). 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.";
|
|
3715
3868
|
readonly http: "POST";
|
|
3716
3869
|
readonly path: "/automation/v1/runs";
|
|
3717
3870
|
readonly streaming: "no";
|
|
@@ -4108,7 +4261,7 @@ export declare const operations: readonly [{
|
|
|
4108
4261
|
readonly resource: "automation.scripts";
|
|
4109
4262
|
readonly method: "create";
|
|
4110
4263
|
readonly summary: "Create a script";
|
|
4111
|
-
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.";
|
|
4264
|
+
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. The return value is limited to 1 MiB: write large results to a file with call(\"write-file\", ...) and return the file ID. A call error carries errors[] (pointer, detail, hint); String(e) is only the summary. 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.";
|
|
4112
4265
|
readonly http: "POST";
|
|
4113
4266
|
readonly path: "/automation/v1/scripts";
|
|
4114
4267
|
readonly streaming: "no";
|
|
@@ -4321,6 +4474,80 @@ export declare const operations: readonly [{
|
|
|
4321
4474
|
readonly required: false;
|
|
4322
4475
|
readonly fields: readonly [];
|
|
4323
4476
|
};
|
|
4477
|
+
}, {
|
|
4478
|
+
readonly resource: "automation.scripts.vaults";
|
|
4479
|
+
readonly method: "list";
|
|
4480
|
+
readonly summary: "List script vault bindings";
|
|
4481
|
+
readonly description: "Inspect the whole vaults attached to a saved script, including archived definitions, without reading secret values. Obtain ns and name from automation.scripts.list. Bindings belong to the definition rather than a published version. When vault or secret metadata cannot be read, the binding remains visible with secrets: [] and secrets_unavailable: true.";
|
|
4482
|
+
readonly http: "GET";
|
|
4483
|
+
readonly path: "/automation/v1/scripts/{ns}/{name}/vaults";
|
|
4484
|
+
readonly streaming: "no";
|
|
4485
|
+
readonly pagination: false;
|
|
4486
|
+
readonly pathParams: readonly [{
|
|
4487
|
+
readonly name: "ns";
|
|
4488
|
+
readonly sdkName: "ns";
|
|
4489
|
+
readonly description: "Namespace from automation.scripts.list or create; identifies the saved script, independently of versions.";
|
|
4490
|
+
}, {
|
|
4491
|
+
readonly name: "name";
|
|
4492
|
+
readonly sdkName: "name";
|
|
4493
|
+
readonly description: "Resource name from automation.scripts.list or create; combine with ns to identify the saved script.";
|
|
4494
|
+
}];
|
|
4495
|
+
readonly query: readonly [];
|
|
4496
|
+
}, {
|
|
4497
|
+
readonly resource: "automation.scripts.vaults";
|
|
4498
|
+
readonly method: "delete";
|
|
4499
|
+
readonly summary: "Delete a script vault binding";
|
|
4500
|
+
readonly description: "Remove the vault assignment from this saved script without deleting the vault or its secrets. Obtain aliases from automation.scripts.vaults.list. Repeating deletion of an absent alias on an existing definition succeeds. Bindings also disappear when the definition is permanently deleted, while archival retains them.";
|
|
4501
|
+
readonly http: "DELETE";
|
|
4502
|
+
readonly path: "/automation/v1/scripts/{ns}/{name}/vaults/{alias}";
|
|
4503
|
+
readonly streaming: "no";
|
|
4504
|
+
readonly pagination: false;
|
|
4505
|
+
readonly pathParams: readonly [{
|
|
4506
|
+
readonly name: "ns";
|
|
4507
|
+
readonly sdkName: "ns";
|
|
4508
|
+
readonly description: "Namespace from automation.scripts.list or create; identifies the saved script, independently of versions.";
|
|
4509
|
+
}, {
|
|
4510
|
+
readonly name: "name";
|
|
4511
|
+
readonly sdkName: "name";
|
|
4512
|
+
readonly description: "Resource name from automation.scripts.list or create; combine with ns to identify the saved script.";
|
|
4513
|
+
}, {
|
|
4514
|
+
readonly name: "alias";
|
|
4515
|
+
readonly sdkName: "alias";
|
|
4516
|
+
readonly description: "Binding alias chosen by the caller: 1–40 lowercase letters, digits or hyphens, beginning with a letter.";
|
|
4517
|
+
}];
|
|
4518
|
+
readonly query: readonly [];
|
|
4519
|
+
}, {
|
|
4520
|
+
readonly resource: "automation.scripts.vaults";
|
|
4521
|
+
readonly method: "set";
|
|
4522
|
+
readonly summary: "Set a script vault binding";
|
|
4523
|
+
readonly description: "Attach an entire active vault in your organization to a saved script, or replace the vault at an existing alias. Obtain the vault ID or display name from praxis.vault.vaults.list; ambiguous names require an ID. Bindings are independent of published versions and survive archival. The same vault cannot be assigned to two aliases on one definition. Repeating the same assignment is idempotent. Example body: {\"vault\":\"Production\"}.";
|
|
4524
|
+
readonly http: "PUT";
|
|
4525
|
+
readonly path: "/automation/v1/scripts/{ns}/{name}/vaults/{alias}";
|
|
4526
|
+
readonly streaming: "no";
|
|
4527
|
+
readonly pagination: false;
|
|
4528
|
+
readonly pathParams: readonly [{
|
|
4529
|
+
readonly name: "ns";
|
|
4530
|
+
readonly sdkName: "ns";
|
|
4531
|
+
readonly description: "Namespace from automation.scripts.list or create; identifies the saved script, independently of versions.";
|
|
4532
|
+
}, {
|
|
4533
|
+
readonly name: "name";
|
|
4534
|
+
readonly sdkName: "name";
|
|
4535
|
+
readonly description: "Resource name from automation.scripts.list or create; combine with ns to identify the saved script.";
|
|
4536
|
+
}, {
|
|
4537
|
+
readonly name: "alias";
|
|
4538
|
+
readonly sdkName: "alias";
|
|
4539
|
+
readonly description: "Binding alias chosen by the caller: 1–40 lowercase letters, digits or hyphens, beginning with a letter.";
|
|
4540
|
+
}];
|
|
4541
|
+
readonly query: readonly [];
|
|
4542
|
+
readonly body: {
|
|
4543
|
+
readonly required: true;
|
|
4544
|
+
readonly fields: readonly [{
|
|
4545
|
+
readonly name: "vault";
|
|
4546
|
+
readonly type: "string";
|
|
4547
|
+
readonly required: true;
|
|
4548
|
+
readonly description: "Active vault ID or exact display name from praxis.vault.vaults.list in your organization. Use an ID if display names are duplicated.";
|
|
4549
|
+
}];
|
|
4550
|
+
};
|
|
4324
4551
|
}, {
|
|
4325
4552
|
readonly resource: "automation.scripts.versions";
|
|
4326
4553
|
readonly method: "list";
|
|
@@ -4873,7 +5100,7 @@ export declare const operations: readonly [{
|
|
|
4873
5100
|
readonly resource: "automation.validate";
|
|
4874
5101
|
readonly method: "create";
|
|
4875
5102
|
readonly summary: "Validate a definition";
|
|
4876
|
-
readonly description: "Check source without executing it when you need diagnostics, inferred schemas or references. This is optional before praxis.automation.runs.create, which also validates source before execution. Actions, scripts and workflows are supported; results include validity without saving. Invalid source is reported with valid=false. Script/action output schemas are inferred from return types: Promise unwrapping, Record, intersections and Date. Unknown types yield an empty schema and a warning in warnings. Source diagnostics use /source or /implementation/source with 1-based line/column. For kind=action the same admission checks as action creation apply (no external imports, platform operations only as direct call(praxis/<api>.<op>, input) calls, no agent or automation calls), so source that validates is not rejected at creation.";
|
|
5103
|
+
readonly description: "Check source without executing it when you need diagnostics, inferred schemas or references. This is optional before praxis.automation.runs.create, which also validates source before execution. Actions, scripts and workflows are supported; results include validity without saving. Invalid source is reported with valid=false. Script/action output schemas are inferred from return types: Promise unwrapping, Record, intersections and Date. Unknown types yield an empty schema and a warning in warnings. Source diagnostics use /source or /implementation/source with 1-based line/column. For kind=action the same admission checks as action creation apply (no external imports, platform operations only as direct call(praxis/<api>.<op>, input) calls, no agent or automation calls), so source that validates is not rejected at creation. For kind=workflow the YAML needs document (dsl, namespace, name, version) and do; each problem is one entry in errors[] (pointer, detail, hint), so read the first one. A listen outside the supported subset (to.all, inside a fork) and emit are not reported here and fail with DEFINITION_INVALID only when a run is created. Workflow syntax reference: https://deepraxis.com/docs/developers/automation/reference/workflow-syntax.";
|
|
4877
5104
|
readonly http: "POST";
|
|
4878
5105
|
readonly path: "/automation/v1/validate";
|
|
4879
5106
|
readonly streaming: "no";
|
|
@@ -4958,7 +5185,7 @@ export declare const operations: readonly [{
|
|
|
4958
5185
|
readonly resource: "automation.workflows";
|
|
4959
5186
|
readonly method: "create";
|
|
4960
5187
|
readonly summary: "Create a workflow";
|
|
4961
|
-
readonly description: "Save a YAML workflow as an editable draft
|
|
5188
|
+
readonly description: "Workflow syntax reference: https://deepraxis.com/docs/developers/automation/reference/workflow-syntax. Save a YAML workflow as an editable draft; this does not validate, publish or run it, so check it with validate (kind=workflow) first. Minimal draft: document with dsl (\"1.0.3\"), namespace, name and version, plus a do list of steps, for example document: {dsl: \"1.0.3\", namespace: demo, name: add, version: \"1.0.0\"} and do: [{first: {call: demo/add-one, with: {n: \"${ .n }\"}}}]. call: <ns/name> calls an Action directly (bare name for built-ins such as ocr) and with is the Action input; the input contract is at current_revision.input_schema in the get-action response. run: starts a saved script or child workflow. The run input is . in the first step, and expressions are jq written as a whole ${ ... } string. Limits: Action 5 min (run-sandbox 6 h), workflow 24 h by default and 30 days at most, payload 1 MiB. Test the draft by sending its source and language=yaml to praxis.automation.runs.create. To pause for a person, call praxis/approval (it opens a human task; the step output is the decision); agents answer with praxis.automation.humanTasks.respond on behalf of their user. Guide: /docs/developers/automation/guides/approvals Guide: /docs/developers/automation/guides/write-workflow. Error details are in the errors[] of the response (pointer, detail, hint). 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. 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.";
|
|
4962
5189
|
readonly http: "POST";
|
|
4963
5190
|
readonly path: "/automation/v1/workflows";
|
|
4964
5191
|
readonly streaming: "no";
|
|
@@ -5017,7 +5244,7 @@ export declare const operations: readonly [{
|
|
|
5017
5244
|
readonly resource: "automation.workflows";
|
|
5018
5245
|
readonly method: "update";
|
|
5019
5246
|
readonly summary: "Update a workflow draft";
|
|
5020
|
-
readonly description: "Update description, labels or draft with the current draft revision in If-Match. Even metadata-only updates create a new draft revision.";
|
|
5247
|
+
readonly description: "Update description, labels or draft with the current draft revision in If-Match, taken from draft.revision in the get-workflow response. Even metadata-only updates create a new draft revision. A mismatch returns 412 PRECONDITION_FAILED; read the draft again, merge and retry. The draft is not validated here, so check it with validate (kind=workflow) before publishing. Error details are in errors[]. See the workflow syntax reference at https://deepraxis.com/docs/developers/automation/reference/workflow-syntax.";
|
|
5021
5248
|
readonly http: "PATCH";
|
|
5022
5249
|
readonly path: "/automation/v1/workflows/{ns}/{name}";
|
|
5023
5250
|
readonly streaming: "no";
|
|
@@ -5171,6 +5398,80 @@ export declare const operations: readonly [{
|
|
|
5171
5398
|
readonly required: false;
|
|
5172
5399
|
readonly fields: readonly [];
|
|
5173
5400
|
};
|
|
5401
|
+
}, {
|
|
5402
|
+
readonly resource: "automation.workflows.vaults";
|
|
5403
|
+
readonly method: "list";
|
|
5404
|
+
readonly summary: "List workflow vault bindings";
|
|
5405
|
+
readonly description: "Inspect the whole vaults attached to a saved workflow, including archived definitions, without reading secret values. Obtain ns and name from automation.workflows.list. Bindings belong to the definition rather than a published version. When vault or secret metadata cannot be read, the binding remains visible with secrets: [] and secrets_unavailable: true.";
|
|
5406
|
+
readonly http: "GET";
|
|
5407
|
+
readonly path: "/automation/v1/workflows/{ns}/{name}/vaults";
|
|
5408
|
+
readonly streaming: "no";
|
|
5409
|
+
readonly pagination: false;
|
|
5410
|
+
readonly pathParams: readonly [{
|
|
5411
|
+
readonly name: "ns";
|
|
5412
|
+
readonly sdkName: "ns";
|
|
5413
|
+
readonly description: "Namespace from automation.workflows.list or create; identifies the saved workflow, independently of versions.";
|
|
5414
|
+
}, {
|
|
5415
|
+
readonly name: "name";
|
|
5416
|
+
readonly sdkName: "name";
|
|
5417
|
+
readonly description: "Resource name from automation.workflows.list or create; combine with ns to identify the saved workflow.";
|
|
5418
|
+
}];
|
|
5419
|
+
readonly query: readonly [];
|
|
5420
|
+
}, {
|
|
5421
|
+
readonly resource: "automation.workflows.vaults";
|
|
5422
|
+
readonly method: "delete";
|
|
5423
|
+
readonly summary: "Delete a workflow vault binding";
|
|
5424
|
+
readonly description: "Remove the vault assignment from this saved workflow without deleting the vault or its secrets. Obtain aliases from automation.workflows.vaults.list. Repeating deletion of an absent alias on an existing definition succeeds. Bindings also disappear when the definition is permanently deleted, while archival retains them.";
|
|
5425
|
+
readonly http: "DELETE";
|
|
5426
|
+
readonly path: "/automation/v1/workflows/{ns}/{name}/vaults/{alias}";
|
|
5427
|
+
readonly streaming: "no";
|
|
5428
|
+
readonly pagination: false;
|
|
5429
|
+
readonly pathParams: readonly [{
|
|
5430
|
+
readonly name: "ns";
|
|
5431
|
+
readonly sdkName: "ns";
|
|
5432
|
+
readonly description: "Namespace from automation.workflows.list or create; identifies the saved workflow, independently of versions.";
|
|
5433
|
+
}, {
|
|
5434
|
+
readonly name: "name";
|
|
5435
|
+
readonly sdkName: "name";
|
|
5436
|
+
readonly description: "Resource name from automation.workflows.list or create; combine with ns to identify the saved workflow.";
|
|
5437
|
+
}, {
|
|
5438
|
+
readonly name: "alias";
|
|
5439
|
+
readonly sdkName: "alias";
|
|
5440
|
+
readonly description: "Binding alias chosen by the caller: 1–40 lowercase letters, digits or hyphens, beginning with a letter.";
|
|
5441
|
+
}];
|
|
5442
|
+
readonly query: readonly [];
|
|
5443
|
+
}, {
|
|
5444
|
+
readonly resource: "automation.workflows.vaults";
|
|
5445
|
+
readonly method: "set";
|
|
5446
|
+
readonly summary: "Set a workflow vault binding";
|
|
5447
|
+
readonly description: "Attach an entire active vault in your organization to a saved workflow, or replace the vault at an existing alias. Obtain the vault ID or display name from praxis.vault.vaults.list; ambiguous names require an ID. Bindings are independent of published versions and survive archival. The same vault cannot be assigned to two aliases on one definition. Repeating the same assignment is idempotent. Example body: {\"vault\":\"Production\"}.";
|
|
5448
|
+
readonly http: "PUT";
|
|
5449
|
+
readonly path: "/automation/v1/workflows/{ns}/{name}/vaults/{alias}";
|
|
5450
|
+
readonly streaming: "no";
|
|
5451
|
+
readonly pagination: false;
|
|
5452
|
+
readonly pathParams: readonly [{
|
|
5453
|
+
readonly name: "ns";
|
|
5454
|
+
readonly sdkName: "ns";
|
|
5455
|
+
readonly description: "Namespace from automation.workflows.list or create; identifies the saved workflow, independently of versions.";
|
|
5456
|
+
}, {
|
|
5457
|
+
readonly name: "name";
|
|
5458
|
+
readonly sdkName: "name";
|
|
5459
|
+
readonly description: "Resource name from automation.workflows.list or create; combine with ns to identify the saved workflow.";
|
|
5460
|
+
}, {
|
|
5461
|
+
readonly name: "alias";
|
|
5462
|
+
readonly sdkName: "alias";
|
|
5463
|
+
readonly description: "Binding alias chosen by the caller: 1–40 lowercase letters, digits or hyphens, beginning with a letter.";
|
|
5464
|
+
}];
|
|
5465
|
+
readonly query: readonly [];
|
|
5466
|
+
readonly body: {
|
|
5467
|
+
readonly required: true;
|
|
5468
|
+
readonly fields: readonly [{
|
|
5469
|
+
readonly name: "vault";
|
|
5470
|
+
readonly type: "string";
|
|
5471
|
+
readonly required: true;
|
|
5472
|
+
readonly description: "Active vault ID or exact display name from praxis.vault.vaults.list in your organization. Use an ID if display names are duplicated.";
|
|
5473
|
+
}];
|
|
5474
|
+
};
|
|
5174
5475
|
}, {
|
|
5175
5476
|
readonly resource: "automation.workflows.versions";
|
|
5176
5477
|
readonly method: "list";
|
|
@@ -5211,7 +5512,7 @@ export declare const operations: readonly [{
|
|
|
5211
5512
|
readonly method: "create";
|
|
5212
5513
|
readonly aliases: readonly ["publish"];
|
|
5213
5514
|
readonly summary: "Publish a workflow version";
|
|
5214
|
-
readonly description: "Publish a saved definition from its draft or an ad hoc run as a reusable version for named runs or triggers, validating the definition and locking dependencies. To test unpublished code, use praxis.automation.runs.create with source and language instead. Use draft.revision from create or retrieve as expected_draft_revision. The draft must match expected_draft_revision; an ad hoc run requires from_run and expected_source_sha256. The same version and contents return the existing version; different contents return VERSION_EXISTS, prereleases require an explicit tag (not latest, URL-safe characters only, not a version or range; violations return TAG_REQUIRED or TAG_INVALID with the complete rules in hint), and invalid definitions return DEFINITION_INVALID. Stable releases automatically advance latest only above the highest existing stable version; workflows becoming latest synchronize their declared schedule. String and object run.workflow/run.script references share version resolution and dependency locking. Publishing removes +build metadata from the version number.";
|
|
5515
|
+
readonly description: "Publish a saved definition from its draft or an ad hoc run as a reusable version for named runs or triggers, validating the definition and locking dependencies. To test unpublished code, use praxis.automation.runs.create with source and language instead. Use draft.revision from create or retrieve as expected_draft_revision. The draft must match expected_draft_revision; an ad hoc run requires from_run and expected_source_sha256. The same version and contents return the existing version; different contents return VERSION_EXISTS, prereleases require an explicit tag (not latest, URL-safe characters only, not a version or range; violations return TAG_REQUIRED or TAG_INVALID with the complete rules in hint), and invalid definitions return DEFINITION_INVALID. Stable releases automatically advance latest only above the highest existing stable version; workflows becoming latest synchronize their declared schedule. String and object run.workflow/run.script references share version resolution and dependency locking. Publishing removes +build metadata from the version number. For a workflow, document namespace, name and version must equal the publish target, otherwise DEFINITION_IDENTITY_MISMATCH; where a DEFINITION_INVALID failure sits is listed in errors[] (pointer, detail, hint).";
|
|
5215
5516
|
readonly http: "POST";
|
|
5216
5517
|
readonly path: "/automation/v1/workflows/{ns}/{name}/versions";
|
|
5217
5518
|
readonly streaming: "no";
|
|
@@ -5767,94 +6068,2361 @@ export declare const operations: readonly [{
|
|
|
5767
6068
|
}];
|
|
5768
6069
|
};
|
|
5769
6070
|
}, {
|
|
5770
|
-
readonly resource: "
|
|
6071
|
+
readonly resource: "canvas.canvases";
|
|
5771
6072
|
readonly method: "list";
|
|
5772
|
-
readonly summary: "List
|
|
5773
|
-
readonly description: "
|
|
6073
|
+
readonly summary: "List canvases";
|
|
6074
|
+
readonly description: "Discover canvases in the API key's organization and obtain ids for retrieval or editing. Results are ordered by updated_at from newest to oldest. limit is 1–100 and defaults to 50; omit cursor for the first page, then copy next_cursor into the next request until it is null. Deleted canvases are unavailable.";
|
|
5774
6075
|
readonly http: "GET";
|
|
5775
|
-
readonly path: "/
|
|
6076
|
+
readonly path: "/canvas/v1/canvases";
|
|
5776
6077
|
readonly streaming: "no";
|
|
5777
6078
|
readonly pagination: true;
|
|
5778
6079
|
readonly pathParams: readonly [];
|
|
5779
6080
|
readonly query: readonly [{
|
|
5780
|
-
readonly name: "cursor";
|
|
5781
|
-
readonly type: "string";
|
|
5782
|
-
readonly required: false;
|
|
5783
|
-
readonly description: "Opaque next_cursor from the previous page.";
|
|
5784
|
-
}, {
|
|
5785
6081
|
readonly name: "limit";
|
|
5786
6082
|
readonly type: "integer";
|
|
5787
6083
|
readonly required: false;
|
|
5788
|
-
readonly description: "
|
|
6084
|
+
readonly description: "Maximum canvases to return per page, from 1 to 100; defaults to 50 when omitted.";
|
|
5789
6085
|
}, {
|
|
5790
|
-
readonly name: "
|
|
5791
|
-
readonly type: "
|
|
6086
|
+
readonly name: "cursor";
|
|
6087
|
+
readonly type: "string";
|
|
5792
6088
|
readonly required: false;
|
|
5793
|
-
readonly description: "
|
|
6089
|
+
readonly description: "Opaque next_cursor from the preceding list response; omit for the first page and stop when next_cursor is null.";
|
|
5794
6090
|
}, {
|
|
5795
|
-
readonly name: "
|
|
6091
|
+
readonly name: "collection_id";
|
|
5796
6092
|
readonly type: "string";
|
|
5797
|
-
readonly enum: readonly ["active", "deleting"];
|
|
5798
6093
|
readonly required: false;
|
|
5799
|
-
readonly description: "Filter
|
|
6094
|
+
readonly description: "Filter to a collection id from collections.list, or the literal none for uncategorized canvases. Omit to list all canvases; keep the same filter when following next_cursor.";
|
|
5800
6095
|
}];
|
|
5801
6096
|
}, {
|
|
5802
|
-
readonly resource: "
|
|
6097
|
+
readonly resource: "canvas.canvases";
|
|
5803
6098
|
readonly method: "create";
|
|
5804
|
-
readonly summary: "Create
|
|
5805
|
-
readonly description: "
|
|
6099
|
+
readonly summary: "Create canvas";
|
|
6100
|
+
readonly description: "Create a blank design canvas in the API key's organization before drawing with praxis.canvas.canvases.execute. Send an optional name of at most 200 characters; omitting name uses Untitled. Each successful call creates a new canvas and returns its id and viewer_url with HTTP 201; save the id for subsequent reads, edits and deletion.";
|
|
5806
6101
|
readonly http: "POST";
|
|
5807
|
-
readonly path: "/
|
|
6102
|
+
readonly path: "/canvas/v1/canvases";
|
|
5808
6103
|
readonly streaming: "no";
|
|
5809
6104
|
readonly pagination: false;
|
|
5810
6105
|
readonly pathParams: readonly [];
|
|
5811
6106
|
readonly query: readonly [];
|
|
5812
6107
|
readonly body: {
|
|
5813
|
-
readonly required:
|
|
6108
|
+
readonly required: false;
|
|
5814
6109
|
readonly fields: readonly [{
|
|
5815
6110
|
readonly name: "name";
|
|
5816
6111
|
readonly type: "string";
|
|
5817
|
-
readonly required: true;
|
|
5818
|
-
readonly description: "Display name for the database: 1–64 visible characters after trimming; control characters are rejected. It is not an identifier, so later calls still use the returned id.";
|
|
5819
|
-
}, {
|
|
5820
|
-
readonly name: "labels";
|
|
5821
|
-
readonly type: "object";
|
|
5822
6112
|
readonly required: false;
|
|
5823
|
-
readonly description: "
|
|
6113
|
+
readonly description: "Display name for the new canvas, at most 200 characters; omission uses Untitled.";
|
|
5824
6114
|
}];
|
|
5825
6115
|
};
|
|
5826
6116
|
}, {
|
|
5827
|
-
readonly resource: "
|
|
6117
|
+
readonly resource: "canvas.canvases";
|
|
5828
6118
|
readonly method: "delete";
|
|
5829
|
-
readonly summary: "Delete
|
|
5830
|
-
readonly description: "
|
|
6119
|
+
readonly summary: "Delete canvas";
|
|
6120
|
+
readonly description: "Permanently delete a canvas and its design content when it is no longer needed. Obtain canvas_id from create or list and confirm the target before calling; deletion cannot be undone. HTTP 200 confirms deletion with deleted=true. Subsequent access returns CANVAS_NOT_FOUND, as it does for a missing canvas or one outside the API key's organization.";
|
|
5831
6121
|
readonly http: "DELETE";
|
|
5832
|
-
readonly path: "/
|
|
6122
|
+
readonly path: "/canvas/v1/canvases/{canvas_id}";
|
|
5833
6123
|
readonly streaming: "no";
|
|
5834
6124
|
readonly pagination: false;
|
|
5835
6125
|
readonly pathParams: readonly [{
|
|
5836
|
-
readonly name: "
|
|
5837
|
-
readonly sdkName: "
|
|
5838
|
-
readonly description: "
|
|
6126
|
+
readonly name: "canvas_id";
|
|
6127
|
+
readonly sdkName: "canvas_id";
|
|
6128
|
+
readonly description: "Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted.";
|
|
5839
6129
|
}];
|
|
5840
6130
|
readonly query: readonly [];
|
|
5841
6131
|
}, {
|
|
5842
|
-
readonly resource: "
|
|
6132
|
+
readonly resource: "canvas.canvases";
|
|
5843
6133
|
readonly method: "retrieve";
|
|
5844
|
-
readonly summary: "
|
|
5845
|
-
readonly description: "
|
|
6134
|
+
readonly summary: "Retrieve canvas";
|
|
6135
|
+
readonly description: "Inspect the current canvas before editing, like Pencil get_app_state. The response adds top-level node summaries in canvas order and reusable component ids to the canvas metadata. Use these ids in nodes.list, images.list or an execute script; use the returned version as expected_version to detect concurrent edits. Read full node content with nodes.list rather than guessing fields from these summaries.";
|
|
5846
6136
|
readonly http: "GET";
|
|
5847
|
-
readonly path: "/
|
|
6137
|
+
readonly path: "/canvas/v1/canvases/{canvas_id}";
|
|
5848
6138
|
readonly streaming: "no";
|
|
5849
6139
|
readonly pagination: false;
|
|
5850
6140
|
readonly pathParams: readonly [{
|
|
5851
|
-
readonly name: "
|
|
5852
|
-
readonly sdkName: "
|
|
5853
|
-
readonly description: "
|
|
6141
|
+
readonly name: "canvas_id";
|
|
6142
|
+
readonly sdkName: "canvas_id";
|
|
6143
|
+
readonly description: "Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted.";
|
|
5854
6144
|
}];
|
|
5855
6145
|
readonly query: readonly [];
|
|
5856
6146
|
}, {
|
|
5857
|
-
readonly resource: "
|
|
6147
|
+
readonly resource: "canvas.canvases";
|
|
6148
|
+
readonly method: "update";
|
|
6149
|
+
readonly summary: "Update canvas";
|
|
6150
|
+
readonly description: "Rename a canvas or move it to a collection without editing its design content. Use a canvas id from canvases.list and a collection id from collections.list. Send collection_id=null to make it uncategorized; omit either field to preserve its current value. A canvas belongs to at most one collection. The destination must belong to your organization. Renaming keeps the canvas version unchanged.";
|
|
6151
|
+
readonly http: "PATCH";
|
|
6152
|
+
readonly path: "/canvas/v1/canvases/{canvas_id}";
|
|
6153
|
+
readonly streaming: "no";
|
|
6154
|
+
readonly pagination: false;
|
|
6155
|
+
readonly pathParams: readonly [{
|
|
6156
|
+
readonly name: "canvas_id";
|
|
6157
|
+
readonly sdkName: "canvas_id";
|
|
6158
|
+
readonly description: "Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted.";
|
|
6159
|
+
}];
|
|
6160
|
+
readonly query: readonly [];
|
|
6161
|
+
readonly body: {
|
|
6162
|
+
readonly required: true;
|
|
6163
|
+
readonly fields: readonly [{
|
|
6164
|
+
readonly name: "name";
|
|
6165
|
+
readonly type: "string";
|
|
6166
|
+
readonly required: false;
|
|
6167
|
+
readonly description: "New canvas display name; surrounding whitespace is trimmed, blank names use Untitled, and omission preserves the current name.";
|
|
6168
|
+
}, {
|
|
6169
|
+
readonly name: "collection_id";
|
|
6170
|
+
readonly type: "string";
|
|
6171
|
+
readonly required: false;
|
|
6172
|
+
readonly description: "Move to this collection id from collections.list; null removes the canvas from its collection. Omission preserves the current assignment.";
|
|
6173
|
+
}];
|
|
6174
|
+
};
|
|
6175
|
+
}, {
|
|
6176
|
+
readonly resource: "canvas.canvases.images";
|
|
6177
|
+
readonly method: "list";
|
|
6178
|
+
readonly summary: "Render canvas nodes";
|
|
6179
|
+
readonly description: "Render 1–4 nodes to inspect the visual result of a design edit. Use ids from retrieve, execute.created or execute.screenshots; scale defaults to 1 and accepts 0.25–4, and png is the only supported format. Unlike Figma, images contains inline data:image/png;base64,... URLs, not hosted image URLs; a null entry means no image is available for that id. Use nodes.list for editable node content instead of pixels.";
|
|
6180
|
+
readonly http: "GET";
|
|
6181
|
+
readonly path: "/canvas/v1/canvases/{canvas_id}/images";
|
|
6182
|
+
readonly streaming: "no";
|
|
6183
|
+
readonly pagination: false;
|
|
6184
|
+
readonly pathParams: readonly [{
|
|
6185
|
+
readonly name: "canvas_id";
|
|
6186
|
+
readonly sdkName: "canvas_id";
|
|
6187
|
+
readonly description: "Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted.";
|
|
6188
|
+
}];
|
|
6189
|
+
readonly query: readonly [{
|
|
6190
|
+
readonly name: "version";
|
|
6191
|
+
readonly type: "string";
|
|
6192
|
+
readonly required: false;
|
|
6193
|
+
readonly description: "Decimal version from versions.list, or its earliest_restorable_version, for a read-only historical snapshot; omit to read current state. Unavailable versions return VERSION_NOT_FOUND.";
|
|
6194
|
+
}, {
|
|
6195
|
+
readonly name: "ids";
|
|
6196
|
+
readonly type: "string";
|
|
6197
|
+
readonly required: true;
|
|
6198
|
+
readonly description: "Comma-separated list of 1–4 node ids to render, from retrieve, execute.created or execute.screenshots.";
|
|
6199
|
+
}, {
|
|
6200
|
+
readonly name: "scale";
|
|
6201
|
+
readonly type: "number";
|
|
6202
|
+
readonly required: false;
|
|
6203
|
+
readonly description: "Output pixel scale relative to canvas dimensions, from 0.25 to 4 inclusive; defaults to 1 when omitted.";
|
|
6204
|
+
}, {
|
|
6205
|
+
readonly name: "format";
|
|
6206
|
+
readonly type: "string";
|
|
6207
|
+
readonly enum: readonly ["png"];
|
|
6208
|
+
readonly required: false;
|
|
6209
|
+
readonly description: "Image encoding; png produces a PNG data URL and is the only supported value. Omit to use png.";
|
|
6210
|
+
}];
|
|
6211
|
+
}, {
|
|
6212
|
+
readonly resource: "canvas.canvases.nodes";
|
|
6213
|
+
readonly method: "list";
|
|
6214
|
+
readonly summary: "Read canvas nodes";
|
|
6215
|
+
readonly description: "Read node documents for inspection before changing individual nodes. Supply 1–100 comma-separated node ids from retrieve or execute, or instance paths such as a/b. depth is an integer at least 0; omit it for complete subtrees. Each requested id maps to a document wrapper or null if absent. Unlike Figma, document contains a Pencil .pen 2.21 node, not a Figma node. For top-level summaries use canvases.retrieve; for pixels use images.list.";
|
|
6216
|
+
readonly http: "GET";
|
|
6217
|
+
readonly path: "/canvas/v1/canvases/{canvas_id}/nodes";
|
|
6218
|
+
readonly streaming: "no";
|
|
6219
|
+
readonly pagination: false;
|
|
6220
|
+
readonly pathParams: readonly [{
|
|
6221
|
+
readonly name: "canvas_id";
|
|
6222
|
+
readonly sdkName: "canvas_id";
|
|
6223
|
+
readonly description: "Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted.";
|
|
6224
|
+
}];
|
|
6225
|
+
readonly query: readonly [{
|
|
6226
|
+
readonly name: "version";
|
|
6227
|
+
readonly type: "string";
|
|
6228
|
+
readonly required: false;
|
|
6229
|
+
readonly description: "Decimal version from versions.list, or its earliest_restorable_version, for a read-only historical snapshot; omit to read current state. Unavailable versions return VERSION_NOT_FOUND.";
|
|
6230
|
+
}, {
|
|
6231
|
+
readonly name: "ids";
|
|
6232
|
+
readonly type: "string";
|
|
6233
|
+
readonly required: true;
|
|
6234
|
+
readonly description: "Comma-separated list of 1–100 node ids from retrieve or execute, or instance paths such as a/b; missing ids map to null.";
|
|
6235
|
+
}, {
|
|
6236
|
+
readonly name: "depth";
|
|
6237
|
+
readonly type: "integer";
|
|
6238
|
+
readonly required: false;
|
|
6239
|
+
readonly description: "Maximum child depth below each requested node, as an integer at least 0; 0 returns the node without descendants, and omission returns the complete subtree.";
|
|
6240
|
+
}];
|
|
6241
|
+
}, {
|
|
6242
|
+
readonly resource: "canvas.canvases.versions";
|
|
6243
|
+
readonly method: "list";
|
|
6244
|
+
readonly summary: "List canvas versions";
|
|
6245
|
+
readonly description: "Inspect retained edits before restoring a canvas or reading historical nodes and images. Supply a canvas_id from canvases.list or create. Results include successful execute, import and restore commits since history was enabled, newest first. limit is 1–100 and defaults to 30; pass next_cursor as cursor until it is null. All versions from the last 30 days are retained unless the 256 MiB history budget requires pruning; the newest 100 versions are always retained regardless of age or size. earliest_restorable_version is the oldest readable and restorable version, including the state immediately before the first retained commit; null means no history has been recorded. Listing does not change the canvas.";
|
|
6246
|
+
readonly http: "GET";
|
|
6247
|
+
readonly path: "/canvas/v1/canvases/{canvas_id}/versions";
|
|
6248
|
+
readonly streaming: "no";
|
|
6249
|
+
readonly pagination: false;
|
|
6250
|
+
readonly pathParams: readonly [{
|
|
6251
|
+
readonly name: "canvas_id";
|
|
6252
|
+
readonly sdkName: "canvas_id";
|
|
6253
|
+
readonly description: "Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted.";
|
|
6254
|
+
}];
|
|
6255
|
+
readonly query: readonly [{
|
|
6256
|
+
readonly name: "limit";
|
|
6257
|
+
readonly type: "integer";
|
|
6258
|
+
readonly required: false;
|
|
6259
|
+
readonly description: "Maximum commits to return, from 1 to 100 inclusive; omission uses 30.";
|
|
6260
|
+
}, {
|
|
6261
|
+
readonly name: "cursor";
|
|
6262
|
+
readonly type: "string";
|
|
6263
|
+
readonly required: false;
|
|
6264
|
+
readonly description: "Copy next_cursor from the preceding page to continue toward older commits; omit for the first page.";
|
|
6265
|
+
}];
|
|
6266
|
+
}, {
|
|
6267
|
+
readonly resource: "canvas.canvases";
|
|
6268
|
+
readonly method: "execute";
|
|
6269
|
+
readonly summary: "Execute canvas script";
|
|
6270
|
+
readonly description: "Draw or edit a canvas atomically with a synchronous Pencil execute script. First create a canvas with praxis.canvas.canvases.create and use its id as canvas_id; inspect an existing canvas with retrieve before modifying it. Send exactly one of script (new source) or edit_id (a failed script to patch using edits). Unlike Figma REST, :execute writes design content; nodes use Pencil .pen schema 2.21 (frame/group/rectangle/ellipse/polygon/path/text/icon/ref/note), not Figma node fields.\n\nThe root variable is document. Synchronous functions are Insert / Copy / Update / Replace / Move / Delete / SetVariables / Get / GetVariables / FindEmptySpace / Print / TakeScreenshot; globals persist for the next call. A first frame needs only this body.script:\n\n```js\nconst f = Insert(document, { type: \"frame\", name: \"Hero\", width: 1200, layout: \"vertical\", padding: 48, fill: \"#FFFFFF\" }); Insert(f, { type: \"text\", content: \"Hello\", fontSize: 32, fill: \"#111111\" }); Print(f)\n```\n\nInsert/Copy return the new node id; read the copy with Get(id) — copied descendants get new ids, so change them through Copy's third argument `descendants` keyed by the source node ids. To copy a page and change its title in the same script:\n\n```js canvas-example=\"copy-page\"\nconst page = Insert(document, {type:\"frame\",name:\"Original\",width:320,height:160,layout:\"vertical\",padding:16});\nconst title = Insert(page, {type:\"text\",name:\"Title\",content:\"Original\",fontSize:24});\nconst copy = Copy(page, document, {name:\"Copy\",x:360,descendants:{[title]:{content:\"Updated\"}}});\nPrint(copy); Print(Get(copy).children[0].content);\n```\n\nUse viewer_url to watch the result in Console. TakeScreenshot records node ids in screenshots; call images.list with those ids to fetch PNG data URLs. See the [Canvas execute reference](https://deepraxis.com/en/docs/api/native/canvas/execute) for request fields and results, and the [Canvas node reference](https://deepraxis.com/en/docs/developers/canvas/nodes) for node content.\n\nA successful write increments version by one. Optionally set expected_version to the version from retrieve or nodes.list; on 409 REVISION_CONFLICT read again, merge your intent and retry with the current version. Every script failure rolls back all writes. On 400 SCRIPT_ERROR, SCRIPT_LIMIT or OPS_REJECTED, use error.details.edit_id plus edits to repair and rerun the stored source without resending the entire script; details may include line, column and rejection. On 400 EDIT_EXPIRED the saved script is older than ten minutes: submit a corrected new script. On 429 CANVAS_BUSY, more than four calls are queued for this canvas: wait for pending calls before retrying.\n\nExecution errors include error.details.prints containing output printed before failure, with the same string-array shape and output limit as successful prints; rolled-back writes still create no version.\n";
|
|
6271
|
+
readonly http: "POST";
|
|
6272
|
+
readonly path: "/canvas/v1/canvases/{canvas_id}:execute";
|
|
6273
|
+
readonly streaming: "no";
|
|
6274
|
+
readonly pagination: false;
|
|
6275
|
+
readonly pathParams: readonly [{
|
|
6276
|
+
readonly name: "canvas_id";
|
|
6277
|
+
readonly sdkName: "canvas_id";
|
|
6278
|
+
readonly description: "Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted.";
|
|
6279
|
+
}];
|
|
6280
|
+
readonly query: readonly [];
|
|
6281
|
+
readonly body: {
|
|
6282
|
+
readonly required: true;
|
|
6283
|
+
readonly fields: readonly [{
|
|
6284
|
+
readonly name: "script";
|
|
6285
|
+
readonly type: "string";
|
|
6286
|
+
readonly required: false;
|
|
6287
|
+
readonly description: "New synchronous Pencil execute source using document as the root; provide this or edit_id, never both. See the operation's first-frame example.";
|
|
6288
|
+
}, {
|
|
6289
|
+
readonly name: "edit_id";
|
|
6290
|
+
readonly type: "string";
|
|
6291
|
+
readonly required: false;
|
|
6292
|
+
readonly description: "Saved failed-script identifier from error.details.edit_id; use with edits instead of script within ten minutes of the failure.";
|
|
6293
|
+
}, {
|
|
6294
|
+
readonly name: "edits";
|
|
6295
|
+
readonly type: "array";
|
|
6296
|
+
readonly itemType: "object";
|
|
6297
|
+
readonly required: false;
|
|
6298
|
+
readonly description: "Text replacements applied to the source identified by edit_id before rerunning; use error line, column or rejection to choose the correction.";
|
|
6299
|
+
}, {
|
|
6300
|
+
readonly name: "expected_version";
|
|
6301
|
+
readonly type: "string";
|
|
6302
|
+
readonly required: false;
|
|
6303
|
+
readonly description: "Revision from retrieve, nodes.list or the previous execute response; omit for an unguarded write. A mismatch returns 409 REVISION_CONFLICT with details.version.";
|
|
6304
|
+
}];
|
|
6305
|
+
};
|
|
6306
|
+
}, {
|
|
6307
|
+
readonly resource: "canvas.canvases";
|
|
6308
|
+
readonly method: "restore";
|
|
6309
|
+
readonly summary: "Restore canvas version";
|
|
6310
|
+
readonly description: "Recover a canvas after an unwanted edit by restoring a retained version from versions.list or its earliest_restorable_version. This replaces current nodes, variables and themes with the target state and creates one new version; history remains available, so restoring can itself be undone with another restore. Restoring the current version succeeds without creating a version. Optionally guard the write with expected_version from retrieve or nodes.list; if it is stale, inspect current state and retry with the new value. Repeating an unguarded request after another edit can create another restore version. Versions from before history was enabled or outside retention cannot be recovered. Connected viewers resync after a successful restore.";
|
|
6311
|
+
readonly http: "POST";
|
|
6312
|
+
readonly path: "/canvas/v1/canvases/{canvas_id}:restore";
|
|
6313
|
+
readonly streaming: "no";
|
|
6314
|
+
readonly pagination: false;
|
|
6315
|
+
readonly pathParams: readonly [{
|
|
6316
|
+
readonly name: "canvas_id";
|
|
6317
|
+
readonly sdkName: "canvas_id";
|
|
6318
|
+
readonly description: "Canvas id returned by create or list, in the form cvs_ followed by 16 lowercase letters or digits; a display name is not accepted.";
|
|
6319
|
+
}];
|
|
6320
|
+
readonly query: readonly [];
|
|
6321
|
+
readonly body: {
|
|
6322
|
+
readonly required: true;
|
|
6323
|
+
readonly fields: readonly [{
|
|
6324
|
+
readonly name: "version";
|
|
6325
|
+
readonly type: "string";
|
|
6326
|
+
readonly required: true;
|
|
6327
|
+
readonly description: "Historical target from versions.list or earliest_restorable_version; restoring the current version creates no new commit.";
|
|
6328
|
+
}, {
|
|
6329
|
+
readonly name: "expected_version";
|
|
6330
|
+
readonly type: "string";
|
|
6331
|
+
readonly required: false;
|
|
6332
|
+
readonly description: "Current version from retrieve or nodes.list to guard against concurrent edits; omission applies the restore to whichever version is current.";
|
|
6333
|
+
}];
|
|
6334
|
+
};
|
|
6335
|
+
}, {
|
|
6336
|
+
readonly resource: "canvas.collections";
|
|
6337
|
+
readonly method: "list";
|
|
6338
|
+
readonly summary: "List collections";
|
|
6339
|
+
readonly description: "Find collections and ids for filtering or moving canvases. All organization collections are returned in name order in one response; next_cursor is always null. canvas_count excludes deleted canvases. total_count counts all live canvases, rather than collections, and uncategorized_count counts live canvases without a collection. Use canvases.list with collection_id to read a collection or none to read uncategorized canvases.";
|
|
6340
|
+
readonly http: "GET";
|
|
6341
|
+
readonly path: "/canvas/v1/collections";
|
|
6342
|
+
readonly streaming: "no";
|
|
6343
|
+
readonly pagination: false;
|
|
6344
|
+
readonly pathParams: readonly [];
|
|
6345
|
+
readonly query: readonly [];
|
|
6346
|
+
}, {
|
|
6347
|
+
readonly resource: "canvas.collections";
|
|
6348
|
+
readonly method: "create";
|
|
6349
|
+
readonly summary: "Create collection";
|
|
6350
|
+
readonly description: "Organize canvases by creating a one-level collection in your organization. Send a name of 1–100 characters after trimming; duplicate names are allowed. Each call creates a new collection, initially containing no canvases. Use canvases.update with its id as collection_id to move existing canvases into it. Collections cannot be nested and an organization can have at most 200.";
|
|
6351
|
+
readonly http: "POST";
|
|
6352
|
+
readonly path: "/canvas/v1/collections";
|
|
6353
|
+
readonly streaming: "no";
|
|
6354
|
+
readonly pagination: false;
|
|
6355
|
+
readonly pathParams: readonly [];
|
|
6356
|
+
readonly query: readonly [];
|
|
6357
|
+
readonly body: {
|
|
6358
|
+
readonly required: true;
|
|
6359
|
+
readonly fields: readonly [{
|
|
6360
|
+
readonly name: "name";
|
|
6361
|
+
readonly type: "string";
|
|
6362
|
+
readonly required: true;
|
|
6363
|
+
readonly description: "Collection display name, 1–100 characters after trimming surrounding whitespace; duplicate names within the organization are allowed.";
|
|
6364
|
+
}];
|
|
6365
|
+
};
|
|
6366
|
+
}, {
|
|
6367
|
+
readonly resource: "canvas.collections";
|
|
6368
|
+
readonly method: "delete";
|
|
6369
|
+
readonly summary: "Delete collection";
|
|
6370
|
+
readonly description: "Remove a collection using an id from collections.list. All its canvases are preserved and become uncategorized, with collection_id set to null; read them using canvases.list with collection_id=none. The removed collection cannot be retrieved again, and repeating deletion returns COLLECTION_NOT_FOUND.";
|
|
6371
|
+
readonly http: "DELETE";
|
|
6372
|
+
readonly path: "/canvas/v1/collections/{collection_id}";
|
|
6373
|
+
readonly streaming: "no";
|
|
6374
|
+
readonly pagination: false;
|
|
6375
|
+
readonly pathParams: readonly [{
|
|
6376
|
+
readonly name: "collection_id";
|
|
6377
|
+
readonly sdkName: "collection_id";
|
|
6378
|
+
readonly description: "Collection id from collections.create or collections.list, in the form col_ followed by 16 lowercase letters or digits; a display name is not an identifier.";
|
|
6379
|
+
}];
|
|
6380
|
+
readonly query: readonly [];
|
|
6381
|
+
}, {
|
|
6382
|
+
readonly resource: "canvas.collections";
|
|
6383
|
+
readonly method: "retrieve";
|
|
6384
|
+
readonly summary: "Retrieve collection";
|
|
6385
|
+
readonly description: "Inspect one collection and its current live canvas count using an id from collections.list or collections.create. The collection must belong to the API key organization. To read its canvases, pass the same id as collection_id to canvases.list; this response contains collection metadata only.";
|
|
6386
|
+
readonly http: "GET";
|
|
6387
|
+
readonly path: "/canvas/v1/collections/{collection_id}";
|
|
6388
|
+
readonly streaming: "no";
|
|
6389
|
+
readonly pagination: false;
|
|
6390
|
+
readonly pathParams: readonly [{
|
|
6391
|
+
readonly name: "collection_id";
|
|
6392
|
+
readonly sdkName: "collection_id";
|
|
6393
|
+
readonly description: "Collection id from collections.create or collections.list, in the form col_ followed by 16 lowercase letters or digits; a display name is not an identifier.";
|
|
6394
|
+
}];
|
|
6395
|
+
readonly query: readonly [];
|
|
6396
|
+
}, {
|
|
6397
|
+
readonly resource: "canvas.collections";
|
|
6398
|
+
readonly method: "update";
|
|
6399
|
+
readonly summary: "Rename collection";
|
|
6400
|
+
readonly description: "Change the display name of a collection from collections.list without changing its id or canvas assignments. Names contain 1–100 characters after trimming and may match another collection name. This operation does not move canvases; use canvases.update with collection_id for that.";
|
|
6401
|
+
readonly http: "PATCH";
|
|
6402
|
+
readonly path: "/canvas/v1/collections/{collection_id}";
|
|
6403
|
+
readonly streaming: "no";
|
|
6404
|
+
readonly pagination: false;
|
|
6405
|
+
readonly pathParams: readonly [{
|
|
6406
|
+
readonly name: "collection_id";
|
|
6407
|
+
readonly sdkName: "collection_id";
|
|
6408
|
+
readonly description: "Collection id from collections.create or collections.list, in the form col_ followed by 16 lowercase letters or digits; a display name is not an identifier.";
|
|
6409
|
+
}];
|
|
6410
|
+
readonly query: readonly [];
|
|
6411
|
+
readonly body: {
|
|
6412
|
+
readonly required: true;
|
|
6413
|
+
readonly fields: readonly [{
|
|
6414
|
+
readonly name: "name";
|
|
6415
|
+
readonly type: "string";
|
|
6416
|
+
readonly required: true;
|
|
6417
|
+
readonly description: "Collection display name, 1–100 characters after trimming surrounding whitespace; duplicate names within the organization are allowed.";
|
|
6418
|
+
}];
|
|
6419
|
+
};
|
|
6420
|
+
}, {
|
|
6421
|
+
readonly resource: "crm.changes";
|
|
6422
|
+
readonly method: "revert";
|
|
6423
|
+
readonly summary: "Revert change set";
|
|
6424
|
+
readonly description: "Reverse property changes made by one earlier request. Unlike HubSpot, CRM exposes change-set reversal because agents need to undo a whole recorded action rather than manually reconstructing individual values. Supply the changeSetId recorded in property history. A later conflicting value prevents reversal with HTTP 409 CONFLICT; inspect current records before resolving the conflict. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
|
|
6425
|
+
readonly http: "POST";
|
|
6426
|
+
readonly path: "/crm/v1/changes/{changeSetId}:revert";
|
|
6427
|
+
readonly streaming: "no";
|
|
6428
|
+
readonly pagination: false;
|
|
6429
|
+
readonly pathParams: readonly [{
|
|
6430
|
+
readonly name: "changeSetId";
|
|
6431
|
+
readonly sdkName: "changeSetId";
|
|
6432
|
+
readonly description: "Change-set identifier recorded for the original write in property history; one request forms one change set.";
|
|
6433
|
+
}];
|
|
6434
|
+
readonly query: readonly [];
|
|
6435
|
+
}, {
|
|
6436
|
+
readonly resource: "crm.layouts";
|
|
6437
|
+
readonly method: "retrieve";
|
|
6438
|
+
readonly summary: "Retrieve record layout";
|
|
6439
|
+
readonly description: "Read the shared record-page layout for an object type from schemas.list. Unlike HubSpot, CRM exposes this presentation as an API resource so people and agents can share the same record layout instead of relying on interface-only settings. The response orders summary tiles, sidebar properties and main-column sections.";
|
|
6440
|
+
readonly http: "GET";
|
|
6441
|
+
readonly path: "/crm/v1/layouts/{objectType}";
|
|
6442
|
+
readonly streaming: "no";
|
|
6443
|
+
readonly pagination: false;
|
|
6444
|
+
readonly pathParams: readonly [{
|
|
6445
|
+
readonly name: "objectType";
|
|
6446
|
+
readonly sdkName: "objectType";
|
|
6447
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
6448
|
+
}];
|
|
6449
|
+
readonly query: readonly [];
|
|
6450
|
+
}, {
|
|
6451
|
+
readonly resource: "crm.layouts";
|
|
6452
|
+
readonly method: "update";
|
|
6453
|
+
readonly summary: "Update record layout";
|
|
6454
|
+
readonly description: "Replace the shared record-page layout for an object type from schemas.list. Unlike HubSpot, CRM exposes this presentation as an API resource so agents can configure the same record view used by people. Send the complete layout with at most three summary tiles and property names from properties.list; omitted prior sections are removed. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
|
|
6455
|
+
readonly http: "PUT";
|
|
6456
|
+
readonly path: "/crm/v1/layouts/{objectType}";
|
|
6457
|
+
readonly streaming: "no";
|
|
6458
|
+
readonly pagination: false;
|
|
6459
|
+
readonly pathParams: readonly [{
|
|
6460
|
+
readonly name: "objectType";
|
|
6461
|
+
readonly sdkName: "objectType";
|
|
6462
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
6463
|
+
}];
|
|
6464
|
+
readonly query: readonly [];
|
|
6465
|
+
readonly body: {
|
|
6466
|
+
readonly required: true;
|
|
6467
|
+
readonly fields: readonly [{
|
|
6468
|
+
readonly name: "objectType";
|
|
6469
|
+
readonly type: "string";
|
|
6470
|
+
readonly required: true;
|
|
6471
|
+
readonly description: "Object type whose record page uses this layout, matching the path parameter.";
|
|
6472
|
+
}, {
|
|
6473
|
+
readonly name: "summary";
|
|
6474
|
+
readonly type: "array";
|
|
6475
|
+
readonly itemType: "object";
|
|
6476
|
+
readonly required: true;
|
|
6477
|
+
readonly description: "Ordered statistic tiles below the record header, with at most three tiles.";
|
|
6478
|
+
}, {
|
|
6479
|
+
readonly name: "sidebar";
|
|
6480
|
+
readonly type: "array";
|
|
6481
|
+
readonly itemType: "string";
|
|
6482
|
+
readonly required: true;
|
|
6483
|
+
readonly description: "Ordered internal property names shown in the record property sidebar.";
|
|
6484
|
+
}, {
|
|
6485
|
+
readonly name: "sections";
|
|
6486
|
+
readonly type: "array";
|
|
6487
|
+
readonly itemType: "string";
|
|
6488
|
+
readonly required: true;
|
|
6489
|
+
readonly description: "Ordered main-column sections for activity, relationships, tables and property groups.";
|
|
6490
|
+
}];
|
|
6491
|
+
};
|
|
6492
|
+
}, {
|
|
6493
|
+
readonly resource: "crm.leads";
|
|
6494
|
+
readonly method: "qualify";
|
|
6495
|
+
readonly summary: "Qualify lead";
|
|
6496
|
+
readonly description: "Qualify a lead with explicit contact, company and optional deal choices in one operation. Unlike HubSpot, CRM exposes these decisions as a single action because qualification coordinates several related record edits rather than editing only the lead stage. Obtain leadId from objects.list for leads and qualifiedStageId from its pipeline; choose a won stage and satisfy its required properties. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
|
|
6497
|
+
readonly http: "POST";
|
|
6498
|
+
readonly path: "/crm/v1/leads/{leadId}:qualify";
|
|
6499
|
+
readonly streaming: "no";
|
|
6500
|
+
readonly pagination: false;
|
|
6501
|
+
readonly pathParams: readonly [{
|
|
6502
|
+
readonly name: "leadId";
|
|
6503
|
+
readonly sdkName: "leadId";
|
|
6504
|
+
readonly description: "Lead record identifier from objects.list or objects.search with objectType=leads.";
|
|
6505
|
+
}];
|
|
6506
|
+
readonly query: readonly [];
|
|
6507
|
+
readonly body: {
|
|
6508
|
+
readonly required: true;
|
|
6509
|
+
readonly fields: readonly [{
|
|
6510
|
+
readonly name: "contact";
|
|
6511
|
+
readonly type: "object";
|
|
6512
|
+
readonly required: true;
|
|
6513
|
+
readonly description: "Keep the existing contact, or merge it into the chosen contact record.";
|
|
6514
|
+
}, {
|
|
6515
|
+
readonly name: "company";
|
|
6516
|
+
readonly type: "object";
|
|
6517
|
+
readonly required: true;
|
|
6518
|
+
readonly description: "Leave company unchanged, associate an existing company, or create one with explicit properties.";
|
|
6519
|
+
}, {
|
|
6520
|
+
readonly name: "deal";
|
|
6521
|
+
readonly type: "object";
|
|
6522
|
+
readonly required: false;
|
|
6523
|
+
readonly description: "Optional deal to create as part of qualification; omit to qualify without creating a deal.";
|
|
6524
|
+
}, {
|
|
6525
|
+
readonly name: "qualifiedStageId";
|
|
6526
|
+
readonly type: "string";
|
|
6527
|
+
readonly required: true;
|
|
6528
|
+
readonly description: "Lead stage id with praxis_category=won, obtained from the leads pipeline.";
|
|
6529
|
+
}];
|
|
6530
|
+
};
|
|
6531
|
+
}, {
|
|
6532
|
+
readonly resource: "crm.objects";
|
|
6533
|
+
readonly method: "list";
|
|
6534
|
+
readonly summary: "List records";
|
|
6535
|
+
readonly description: "Browse records of one object type and obtain ids for retrieval or edits. Discover objectType with schemas.list; select properties by internal names from properties.list. Omit after for the first page, then copy paging.next.after until no next page is returned. archived defaults to false; use objects.search for property filters.";
|
|
6536
|
+
readonly http: "GET";
|
|
6537
|
+
readonly path: "/crm/v1/objects/{objectType}";
|
|
6538
|
+
readonly streaming: "no";
|
|
6539
|
+
readonly pagination: false;
|
|
6540
|
+
readonly pathParams: readonly [{
|
|
6541
|
+
readonly name: "objectType";
|
|
6542
|
+
readonly sdkName: "objectType";
|
|
6543
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
6544
|
+
}];
|
|
6545
|
+
readonly query: readonly [{
|
|
6546
|
+
readonly name: "after";
|
|
6547
|
+
readonly type: "string";
|
|
6548
|
+
readonly required: false;
|
|
6549
|
+
readonly description: "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.";
|
|
6550
|
+
}, {
|
|
6551
|
+
readonly name: "archived";
|
|
6552
|
+
readonly type: "boolean";
|
|
6553
|
+
readonly required: false;
|
|
6554
|
+
readonly description: "Whether to return only results that have been archived.";
|
|
6555
|
+
}, {
|
|
6556
|
+
readonly name: "associations";
|
|
6557
|
+
readonly type: "array";
|
|
6558
|
+
readonly itemType: "string";
|
|
6559
|
+
readonly required: false;
|
|
6560
|
+
readonly description: "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.";
|
|
6561
|
+
}, {
|
|
6562
|
+
readonly name: "limit";
|
|
6563
|
+
readonly type: "integer";
|
|
6564
|
+
readonly required: false;
|
|
6565
|
+
readonly description: "The maximum number of results to display per page.";
|
|
6566
|
+
}, {
|
|
6567
|
+
readonly name: "properties";
|
|
6568
|
+
readonly type: "array";
|
|
6569
|
+
readonly itemType: "string";
|
|
6570
|
+
readonly required: false;
|
|
6571
|
+
readonly description: "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.";
|
|
6572
|
+
}, {
|
|
6573
|
+
readonly name: "propertiesWithHistory";
|
|
6574
|
+
readonly type: "array";
|
|
6575
|
+
readonly itemType: "string";
|
|
6576
|
+
readonly required: false;
|
|
6577
|
+
readonly description: "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.";
|
|
6578
|
+
}];
|
|
6579
|
+
}, {
|
|
6580
|
+
readonly resource: "crm.objects";
|
|
6581
|
+
readonly method: "create";
|
|
6582
|
+
readonly summary: "Create record";
|
|
6583
|
+
readonly description: "Create a customer record with property values and optional initial associations. Discover objectType with schemas.list and allowed property names with properties.list; save the returned id for subsequent calls. Each call creates a record. Example for contacts: {\"properties\":{\"email\":\"person@example.com\"}}. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
|
|
6584
|
+
readonly http: "POST";
|
|
6585
|
+
readonly path: "/crm/v1/objects/{objectType}";
|
|
6586
|
+
readonly streaming: "no";
|
|
6587
|
+
readonly pagination: false;
|
|
6588
|
+
readonly pathParams: readonly [{
|
|
6589
|
+
readonly name: "objectType";
|
|
6590
|
+
readonly sdkName: "objectType";
|
|
6591
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
6592
|
+
}];
|
|
6593
|
+
readonly query: readonly [];
|
|
6594
|
+
readonly body: {
|
|
6595
|
+
readonly required: true;
|
|
6596
|
+
readonly fields: readonly [{
|
|
6597
|
+
readonly name: "associations";
|
|
6598
|
+
readonly type: "array";
|
|
6599
|
+
readonly itemType: "object";
|
|
6600
|
+
readonly required: true;
|
|
6601
|
+
readonly description: "Initial relationships to existing records; choose destination ids and association type ids before creating the record.";
|
|
6602
|
+
}, {
|
|
6603
|
+
readonly name: "properties";
|
|
6604
|
+
readonly type: "object";
|
|
6605
|
+
readonly required: true;
|
|
6606
|
+
readonly description: "Key-value pairs for setting properties for the new object.";
|
|
6607
|
+
}];
|
|
6608
|
+
};
|
|
6609
|
+
}, {
|
|
6610
|
+
readonly resource: "crm.objects.batch";
|
|
6611
|
+
readonly method: "archive";
|
|
6612
|
+
readonly summary: "Batch archive records";
|
|
6613
|
+
readonly description: "Archive known records of one object type using inputs[].id from objects.list or objects.search. Archived records leave active lists but retain their history; confirm all ids before calling. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204.";
|
|
6614
|
+
readonly http: "POST";
|
|
6615
|
+
readonly path: "/crm/v1/objects/{objectType}/batch/archive";
|
|
6616
|
+
readonly streaming: "no";
|
|
6617
|
+
readonly pagination: false;
|
|
6618
|
+
readonly pathParams: readonly [{
|
|
6619
|
+
readonly name: "objectType";
|
|
6620
|
+
readonly sdkName: "objectType";
|
|
6621
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
6622
|
+
}];
|
|
6623
|
+
readonly query: readonly [];
|
|
6624
|
+
readonly body: {
|
|
6625
|
+
readonly required: true;
|
|
6626
|
+
readonly fields: readonly [{
|
|
6627
|
+
readonly name: "inputs";
|
|
6628
|
+
readonly type: "array";
|
|
6629
|
+
readonly itemType: "object";
|
|
6630
|
+
readonly required: true;
|
|
6631
|
+
readonly description: "Records to process in this batch, each using the identifiers and properties described by its item schema.";
|
|
6632
|
+
}];
|
|
6633
|
+
};
|
|
6634
|
+
}, {
|
|
6635
|
+
readonly resource: "crm.objects.batch";
|
|
6636
|
+
readonly method: "create";
|
|
6637
|
+
readonly summary: "Batch create records";
|
|
6638
|
+
readonly description: "Create several records of one object type using inputs with properties and optional associations. Obtain property names from properties.list; each successful input creates a record, so inspect per-item errors before resubmitting failed inputs. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
|
|
6639
|
+
readonly http: "POST";
|
|
6640
|
+
readonly path: "/crm/v1/objects/{objectType}/batch/create";
|
|
6641
|
+
readonly streaming: "no";
|
|
6642
|
+
readonly pagination: false;
|
|
6643
|
+
readonly pathParams: readonly [{
|
|
6644
|
+
readonly name: "objectType";
|
|
6645
|
+
readonly sdkName: "objectType";
|
|
6646
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
6647
|
+
}];
|
|
6648
|
+
readonly query: readonly [];
|
|
6649
|
+
readonly body: {
|
|
6650
|
+
readonly required: true;
|
|
6651
|
+
readonly fields: readonly [{
|
|
6652
|
+
readonly name: "inputs";
|
|
6653
|
+
readonly type: "array";
|
|
6654
|
+
readonly itemType: "object";
|
|
6655
|
+
readonly required: true;
|
|
6656
|
+
readonly description: "Records to process in this batch, each using the identifiers and properties described by its item schema.";
|
|
6657
|
+
}];
|
|
6658
|
+
};
|
|
6659
|
+
}, {
|
|
6660
|
+
readonly resource: "crm.objects.batch";
|
|
6661
|
+
readonly method: "read";
|
|
6662
|
+
readonly summary: "Batch read records";
|
|
6663
|
+
readonly description: "Read a set of known record ids in one call; use objects.search to discover ids first. Supply inputs with ids plus requested properties; set idProperty only when the inputs use unique-property values rather than record ids.";
|
|
6664
|
+
readonly http: "POST";
|
|
6665
|
+
readonly path: "/crm/v1/objects/{objectType}/batch/read";
|
|
6666
|
+
readonly streaming: "no";
|
|
6667
|
+
readonly pagination: false;
|
|
6668
|
+
readonly pathParams: readonly [{
|
|
6669
|
+
readonly name: "objectType";
|
|
6670
|
+
readonly sdkName: "objectType";
|
|
6671
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
6672
|
+
}];
|
|
6673
|
+
readonly query: readonly [{
|
|
6674
|
+
readonly name: "archived";
|
|
6675
|
+
readonly type: "boolean";
|
|
6676
|
+
readonly required: false;
|
|
6677
|
+
readonly description: "Whether to return only results that have been archived.";
|
|
6678
|
+
}];
|
|
6679
|
+
readonly body: {
|
|
6680
|
+
readonly required: true;
|
|
6681
|
+
readonly fields: readonly [{
|
|
6682
|
+
readonly name: "idProperty";
|
|
6683
|
+
readonly type: "string";
|
|
6684
|
+
readonly required: false;
|
|
6685
|
+
readonly description: "When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.";
|
|
6686
|
+
}, {
|
|
6687
|
+
readonly name: "inputs";
|
|
6688
|
+
readonly type: "array";
|
|
6689
|
+
readonly itemType: "object";
|
|
6690
|
+
readonly required: true;
|
|
6691
|
+
readonly description: "Records to process in this batch, each using the identifiers and properties described by its item schema.";
|
|
6692
|
+
}, {
|
|
6693
|
+
readonly name: "properties";
|
|
6694
|
+
readonly type: "array";
|
|
6695
|
+
readonly itemType: "string";
|
|
6696
|
+
readonly required: true;
|
|
6697
|
+
readonly description: "Internal property names to include in each returned record; obtain them from properties.list.";
|
|
6698
|
+
}, {
|
|
6699
|
+
readonly name: "propertiesWithHistory";
|
|
6700
|
+
readonly type: "array";
|
|
6701
|
+
readonly itemType: "string";
|
|
6702
|
+
readonly required: true;
|
|
6703
|
+
readonly description: "Internal property names whose previous values should be returned with each record; use an empty array when no history is needed.";
|
|
6704
|
+
}];
|
|
6705
|
+
};
|
|
6706
|
+
}, {
|
|
6707
|
+
readonly resource: "crm.objects.batch";
|
|
6708
|
+
readonly method: "update";
|
|
6709
|
+
readonly summary: "Batch update records";
|
|
6710
|
+
readonly description: "Apply distinct property patches to existing records identified by inputs[].id. Obtain ids from objects.list or objects.search and property names from properties.list. Omitted properties retain their values; inspect results and errors for each input. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
|
|
6711
|
+
readonly http: "POST";
|
|
6712
|
+
readonly path: "/crm/v1/objects/{objectType}/batch/update";
|
|
6713
|
+
readonly streaming: "no";
|
|
6714
|
+
readonly pagination: false;
|
|
6715
|
+
readonly pathParams: readonly [{
|
|
6716
|
+
readonly name: "objectType";
|
|
6717
|
+
readonly sdkName: "objectType";
|
|
6718
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
6719
|
+
}];
|
|
6720
|
+
readonly query: readonly [];
|
|
6721
|
+
readonly body: {
|
|
6722
|
+
readonly required: true;
|
|
6723
|
+
readonly fields: readonly [{
|
|
6724
|
+
readonly name: "inputs";
|
|
6725
|
+
readonly type: "array";
|
|
6726
|
+
readonly itemType: "object";
|
|
6727
|
+
readonly required: true;
|
|
6728
|
+
readonly description: "Records to process in this batch, each using the identifiers and properties described by its item schema.";
|
|
6729
|
+
}];
|
|
6730
|
+
};
|
|
6731
|
+
}, {
|
|
6732
|
+
readonly resource: "crm.objects.batch";
|
|
6733
|
+
readonly method: "upsert";
|
|
6734
|
+
readonly summary: "Batch upsert records";
|
|
6735
|
+
readonly description: "Create records that do not yet exist or update matches using a unique property. Provide idProperty and its value in each input, plus properties; choose a property with hasUniqueValue from properties.list. Inspect each result to determine whether it was newly created. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
|
|
6736
|
+
readonly http: "POST";
|
|
6737
|
+
readonly path: "/crm/v1/objects/{objectType}/batch/upsert";
|
|
6738
|
+
readonly streaming: "no";
|
|
6739
|
+
readonly pagination: false;
|
|
6740
|
+
readonly pathParams: readonly [{
|
|
6741
|
+
readonly name: "objectType";
|
|
6742
|
+
readonly sdkName: "objectType";
|
|
6743
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
6744
|
+
}];
|
|
6745
|
+
readonly query: readonly [];
|
|
6746
|
+
readonly body: {
|
|
6747
|
+
readonly required: true;
|
|
6748
|
+
readonly fields: readonly [{
|
|
6749
|
+
readonly name: "inputs";
|
|
6750
|
+
readonly type: "array";
|
|
6751
|
+
readonly itemType: "object";
|
|
6752
|
+
readonly required: true;
|
|
6753
|
+
readonly description: "Records to process in this batch, each using the identifiers and properties described by its item schema.";
|
|
6754
|
+
}];
|
|
6755
|
+
};
|
|
6756
|
+
}, {
|
|
6757
|
+
readonly resource: "crm.objects";
|
|
6758
|
+
readonly method: "search";
|
|
6759
|
+
readonly summary: "Search records";
|
|
6760
|
+
readonly description: "Find records using text query, property filters and sort order rather than scanning a list. Obtain objectType from schemas.list and filter propertyName values from properties.list. Supply filterGroups, sorts, properties, limit and after; use empty arrays for no filters, sorts or property selection, and an empty after for the first page. Copy paging.next.after with the same query to continue. This operation reads records without changing them.";
|
|
6761
|
+
readonly http: "POST";
|
|
6762
|
+
readonly path: "/crm/v1/objects/{objectType}/search";
|
|
6763
|
+
readonly streaming: "no";
|
|
6764
|
+
readonly pagination: false;
|
|
6765
|
+
readonly pathParams: readonly [{
|
|
6766
|
+
readonly name: "objectType";
|
|
6767
|
+
readonly sdkName: "objectType";
|
|
6768
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
6769
|
+
}];
|
|
6770
|
+
readonly query: readonly [];
|
|
6771
|
+
readonly body: {
|
|
6772
|
+
readonly required: true;
|
|
6773
|
+
readonly fields: readonly [{
|
|
6774
|
+
readonly name: "after";
|
|
6775
|
+
readonly type: "string";
|
|
6776
|
+
readonly required: true;
|
|
6777
|
+
readonly description: "A paging cursor token for retrieving subsequent pages.";
|
|
6778
|
+
}, {
|
|
6779
|
+
readonly name: "filterGroups";
|
|
6780
|
+
readonly type: "array";
|
|
6781
|
+
readonly itemType: "object";
|
|
6782
|
+
readonly required: true;
|
|
6783
|
+
readonly description: "Up to 6 groups of filters defining additional query criteria.";
|
|
6784
|
+
}, {
|
|
6785
|
+
readonly name: "limit";
|
|
6786
|
+
readonly type: "integer";
|
|
6787
|
+
readonly required: true;
|
|
6788
|
+
readonly description: "The maximum results to return, up to 200 objects.";
|
|
6789
|
+
}, {
|
|
6790
|
+
readonly name: "properties";
|
|
6791
|
+
readonly type: "array";
|
|
6792
|
+
readonly itemType: "string";
|
|
6793
|
+
readonly required: true;
|
|
6794
|
+
readonly description: "Internal property names to include in each returned record; obtain them from properties.list.";
|
|
6795
|
+
}, {
|
|
6796
|
+
readonly name: "query";
|
|
6797
|
+
readonly type: "string";
|
|
6798
|
+
readonly required: false;
|
|
6799
|
+
readonly description: "The search query string, up to 3000 characters.";
|
|
6800
|
+
}, {
|
|
6801
|
+
readonly name: "sorts";
|
|
6802
|
+
readonly type: "array";
|
|
6803
|
+
readonly itemType: "string";
|
|
6804
|
+
readonly required: true;
|
|
6805
|
+
readonly description: "Property names controlling ordering; prefix a property name with a minus sign for descending order.";
|
|
6806
|
+
}];
|
|
6807
|
+
};
|
|
6808
|
+
}, {
|
|
6809
|
+
readonly resource: "crm.objects";
|
|
6810
|
+
readonly method: "archive";
|
|
6811
|
+
readonly summary: "Archive record";
|
|
6812
|
+
readonly description: "Archive a record selected from objects.list or objects.search when it should leave active results. This removes it from normal lists without deleting its history; archived=true can be used to read archived records. Confirm objectType and objectId before calling. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204.";
|
|
6813
|
+
readonly http: "DELETE";
|
|
6814
|
+
readonly path: "/crm/v1/objects/{objectType}/{objectId}";
|
|
6815
|
+
readonly streaming: "no";
|
|
6816
|
+
readonly pagination: false;
|
|
6817
|
+
readonly pathParams: readonly [{
|
|
6818
|
+
readonly name: "objectType";
|
|
6819
|
+
readonly sdkName: "objectType";
|
|
6820
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
6821
|
+
}, {
|
|
6822
|
+
readonly name: "objectId";
|
|
6823
|
+
readonly sdkName: "objectId";
|
|
6824
|
+
readonly description: "Record id from objects.list, objects.search or objects.create for this objectType.";
|
|
6825
|
+
}];
|
|
6826
|
+
readonly query: readonly [];
|
|
6827
|
+
}, {
|
|
6828
|
+
readonly resource: "crm.objects";
|
|
6829
|
+
readonly method: "retrieve";
|
|
6830
|
+
readonly summary: "Retrieve record";
|
|
6831
|
+
readonly description: "Read one record by id from objects.list, objects.search or objects.create. Select property names with properties and associated object types with associations; use idProperty only when objectId is a value of that unique property. Use archived=true to inspect an archived record.";
|
|
6832
|
+
readonly http: "GET";
|
|
6833
|
+
readonly path: "/crm/v1/objects/{objectType}/{objectId}";
|
|
6834
|
+
readonly streaming: "no";
|
|
6835
|
+
readonly pagination: false;
|
|
6836
|
+
readonly pathParams: readonly [{
|
|
6837
|
+
readonly name: "objectType";
|
|
6838
|
+
readonly sdkName: "objectType";
|
|
6839
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
6840
|
+
}, {
|
|
6841
|
+
readonly name: "objectId";
|
|
6842
|
+
readonly sdkName: "objectId";
|
|
6843
|
+
readonly description: "Record id from objects.list, objects.search or objects.create for this objectType.";
|
|
6844
|
+
}];
|
|
6845
|
+
readonly query: readonly [{
|
|
6846
|
+
readonly name: "archived";
|
|
6847
|
+
readonly type: "boolean";
|
|
6848
|
+
readonly required: false;
|
|
6849
|
+
readonly description: "Whether to return only results that have been archived.";
|
|
6850
|
+
}, {
|
|
6851
|
+
readonly name: "associations";
|
|
6852
|
+
readonly type: "array";
|
|
6853
|
+
readonly itemType: "string";
|
|
6854
|
+
readonly required: false;
|
|
6855
|
+
readonly description: "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.";
|
|
6856
|
+
}, {
|
|
6857
|
+
readonly name: "idProperty";
|
|
6858
|
+
readonly type: "string";
|
|
6859
|
+
readonly required: false;
|
|
6860
|
+
readonly description: "The name of a property whose values are unique for this object";
|
|
6861
|
+
}, {
|
|
6862
|
+
readonly name: "properties";
|
|
6863
|
+
readonly type: "array";
|
|
6864
|
+
readonly itemType: "string";
|
|
6865
|
+
readonly required: false;
|
|
6866
|
+
readonly description: "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.";
|
|
6867
|
+
}, {
|
|
6868
|
+
readonly name: "propertiesWithHistory";
|
|
6869
|
+
readonly type: "array";
|
|
6870
|
+
readonly itemType: "string";
|
|
6871
|
+
readonly required: false;
|
|
6872
|
+
readonly description: "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.";
|
|
6873
|
+
}];
|
|
6874
|
+
}, {
|
|
6875
|
+
readonly resource: "crm.objects";
|
|
6876
|
+
readonly method: "update";
|
|
6877
|
+
readonly summary: "Update record";
|
|
6878
|
+
readonly description: "Change only the supplied properties of a record selected from objects.list or objects.search. Omitted properties retain their values. Use property names from properties.list and valid stage ids from pipelines.retrieve. Stage-entry requirements must be satisfied by the resulting record; inspect 400 errors before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
|
|
6879
|
+
readonly http: "PATCH";
|
|
6880
|
+
readonly path: "/crm/v1/objects/{objectType}/{objectId}";
|
|
6881
|
+
readonly streaming: "no";
|
|
6882
|
+
readonly pagination: false;
|
|
6883
|
+
readonly pathParams: readonly [{
|
|
6884
|
+
readonly name: "objectType";
|
|
6885
|
+
readonly sdkName: "objectType";
|
|
6886
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
6887
|
+
}, {
|
|
6888
|
+
readonly name: "objectId";
|
|
6889
|
+
readonly sdkName: "objectId";
|
|
6890
|
+
readonly description: "Record id from objects.list, objects.search or objects.create for this objectType.";
|
|
6891
|
+
}];
|
|
6892
|
+
readonly query: readonly [{
|
|
6893
|
+
readonly name: "idProperty";
|
|
6894
|
+
readonly type: "string";
|
|
6895
|
+
readonly required: false;
|
|
6896
|
+
readonly description: "The name of a property whose values are unique for this object";
|
|
6897
|
+
}];
|
|
6898
|
+
readonly body: {
|
|
6899
|
+
readonly required: true;
|
|
6900
|
+
readonly fields: readonly [{
|
|
6901
|
+
readonly name: "properties";
|
|
6902
|
+
readonly type: "object";
|
|
6903
|
+
readonly required: true;
|
|
6904
|
+
readonly description: "Key value pairs representing the properties of the object.";
|
|
6905
|
+
}];
|
|
6906
|
+
};
|
|
6907
|
+
}, {
|
|
6908
|
+
readonly resource: "crm.associations";
|
|
6909
|
+
readonly method: "createDefault";
|
|
6910
|
+
readonly summary: "Create default association";
|
|
6911
|
+
readonly description: "Link two existing records with the default unlabelled association. Obtain each record id from objects.list or objects.search for its type. No request body is required; use associations.create to choose explicit association labels. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
|
|
6912
|
+
readonly http: "PUT";
|
|
6913
|
+
readonly path: "/crm/v1/objects/{objectType}/{objectId}/associations/default/{toObjectType}/{toObjectId}";
|
|
6914
|
+
readonly streaming: "no";
|
|
6915
|
+
readonly pagination: false;
|
|
6916
|
+
readonly pathParams: readonly [{
|
|
6917
|
+
readonly name: "objectType";
|
|
6918
|
+
readonly sdkName: "objectType";
|
|
6919
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
6920
|
+
}, {
|
|
6921
|
+
readonly name: "objectId";
|
|
6922
|
+
readonly sdkName: "objectId";
|
|
6923
|
+
readonly description: "Record id from objects.list, objects.search or objects.create for this objectType.";
|
|
6924
|
+
}, {
|
|
6925
|
+
readonly name: "toObjectType";
|
|
6926
|
+
readonly sdkName: "toObjectType";
|
|
6927
|
+
readonly description: "Destination object type from schemas.list; use the type of the record being linked.";
|
|
6928
|
+
}, {
|
|
6929
|
+
readonly name: "toObjectId";
|
|
6930
|
+
readonly sdkName: "toObjectId";
|
|
6931
|
+
readonly description: "Destination record identifier from objects.list or objects.search for toObjectType.";
|
|
6932
|
+
}];
|
|
6933
|
+
readonly query: readonly [];
|
|
6934
|
+
}, {
|
|
6935
|
+
readonly resource: "crm.associations";
|
|
6936
|
+
readonly method: "list";
|
|
6937
|
+
readonly summary: "List record associations";
|
|
6938
|
+
readonly description: "Read records linked to a source record, including association labels and type ids. Obtain source and destination object types from schemas.list and objectId from objects.list or objects.search. Follow paging.next.after to continue reading associated records.";
|
|
6939
|
+
readonly http: "GET";
|
|
6940
|
+
readonly path: "/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}";
|
|
6941
|
+
readonly streaming: "no";
|
|
6942
|
+
readonly pagination: false;
|
|
6943
|
+
readonly pathParams: readonly [{
|
|
6944
|
+
readonly name: "objectType";
|
|
6945
|
+
readonly sdkName: "objectType";
|
|
6946
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
6947
|
+
}, {
|
|
6948
|
+
readonly name: "objectId";
|
|
6949
|
+
readonly sdkName: "objectId";
|
|
6950
|
+
readonly description: "Record id from objects.list, objects.search or objects.create for this objectType.";
|
|
6951
|
+
}, {
|
|
6952
|
+
readonly name: "toObjectType";
|
|
6953
|
+
readonly sdkName: "toObjectType";
|
|
6954
|
+
readonly description: "Destination object type from schemas.list; use the type of the record being linked.";
|
|
6955
|
+
}];
|
|
6956
|
+
readonly query: readonly [{
|
|
6957
|
+
readonly name: "after";
|
|
6958
|
+
readonly type: "string";
|
|
6959
|
+
readonly required: false;
|
|
6960
|
+
readonly description: "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.";
|
|
6961
|
+
}, {
|
|
6962
|
+
readonly name: "limit";
|
|
6963
|
+
readonly type: "integer";
|
|
6964
|
+
readonly required: false;
|
|
6965
|
+
readonly description: "The maximum number of results to display per page.";
|
|
6966
|
+
}];
|
|
6967
|
+
}, {
|
|
6968
|
+
readonly resource: "crm.associations";
|
|
6969
|
+
readonly method: "remove";
|
|
6970
|
+
readonly summary: "Remove association";
|
|
6971
|
+
readonly description: "Remove the association between two existing records without archiving either record. Obtain the linked destination id from associations.list and confirm the source and destination object types before calling. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204.";
|
|
6972
|
+
readonly http: "DELETE";
|
|
6973
|
+
readonly path: "/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}";
|
|
6974
|
+
readonly streaming: "no";
|
|
6975
|
+
readonly pagination: false;
|
|
6976
|
+
readonly pathParams: readonly [{
|
|
6977
|
+
readonly name: "objectType";
|
|
6978
|
+
readonly sdkName: "objectType";
|
|
6979
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
6980
|
+
}, {
|
|
6981
|
+
readonly name: "objectId";
|
|
6982
|
+
readonly sdkName: "objectId";
|
|
6983
|
+
readonly description: "Record id from objects.list, objects.search or objects.create for this objectType.";
|
|
6984
|
+
}, {
|
|
6985
|
+
readonly name: "toObjectType";
|
|
6986
|
+
readonly sdkName: "toObjectType";
|
|
6987
|
+
readonly description: "Destination object type from schemas.list; use the type of the record being linked.";
|
|
6988
|
+
}, {
|
|
6989
|
+
readonly name: "toObjectId";
|
|
6990
|
+
readonly sdkName: "toObjectId";
|
|
6991
|
+
readonly description: "Destination record identifier from objects.list or objects.search for toObjectType.";
|
|
6992
|
+
}];
|
|
6993
|
+
readonly query: readonly [];
|
|
6994
|
+
}, {
|
|
6995
|
+
readonly resource: "crm.associations";
|
|
6996
|
+
readonly method: "create";
|
|
6997
|
+
readonly summary: "Create labelled association";
|
|
6998
|
+
readonly description: "Associate two existing records using the requested association category and type id. Obtain record ids from objects.list or objects.search; reuse known association type ids from associations.list. Send the association-spec array as the body; use associations.createDefault when no label is needed. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
|
|
6999
|
+
readonly http: "PUT";
|
|
7000
|
+
readonly path: "/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}";
|
|
7001
|
+
readonly streaming: "no";
|
|
7002
|
+
readonly pagination: false;
|
|
7003
|
+
readonly pathParams: readonly [{
|
|
7004
|
+
readonly name: "objectType";
|
|
7005
|
+
readonly sdkName: "objectType";
|
|
7006
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
7007
|
+
}, {
|
|
7008
|
+
readonly name: "objectId";
|
|
7009
|
+
readonly sdkName: "objectId";
|
|
7010
|
+
readonly description: "Record id from objects.list, objects.search or objects.create for this objectType.";
|
|
7011
|
+
}, {
|
|
7012
|
+
readonly name: "toObjectType";
|
|
7013
|
+
readonly sdkName: "toObjectType";
|
|
7014
|
+
readonly description: "Destination object type from schemas.list; use the type of the record being linked.";
|
|
7015
|
+
}, {
|
|
7016
|
+
readonly name: "toObjectId";
|
|
7017
|
+
readonly sdkName: "toObjectId";
|
|
7018
|
+
readonly description: "Destination record identifier from objects.list or objects.search for toObjectType.";
|
|
7019
|
+
}];
|
|
7020
|
+
readonly query: readonly [];
|
|
7021
|
+
readonly body: {
|
|
7022
|
+
readonly required: true;
|
|
7023
|
+
readonly fields: readonly [];
|
|
7024
|
+
};
|
|
7025
|
+
}, {
|
|
7026
|
+
readonly resource: "crm.pipelines";
|
|
7027
|
+
readonly method: "list";
|
|
7028
|
+
readonly summary: "List pipelines";
|
|
7029
|
+
readonly description: "Discover pipelines and stage ids for records of one object type from schemas.list. Reuse pipeline and stage ids in record property updates or lead qualification. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.";
|
|
7030
|
+
readonly http: "GET";
|
|
7031
|
+
readonly path: "/crm/v1/pipelines/{objectType}";
|
|
7032
|
+
readonly streaming: "no";
|
|
7033
|
+
readonly pagination: false;
|
|
7034
|
+
readonly pathParams: readonly [{
|
|
7035
|
+
readonly name: "objectType";
|
|
7036
|
+
readonly sdkName: "objectType";
|
|
7037
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
7038
|
+
}];
|
|
7039
|
+
readonly query: readonly [];
|
|
7040
|
+
}, {
|
|
7041
|
+
readonly resource: "crm.pipelines";
|
|
7042
|
+
readonly method: "create";
|
|
7043
|
+
readonly summary: "Create pipeline";
|
|
7044
|
+
readonly description: "Create a pipeline with its ordered stages for an object type from schemas.list. Provide a display label, displayOrder and initial stages, then use the returned ids when assigning records. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.";
|
|
7045
|
+
readonly http: "POST";
|
|
7046
|
+
readonly path: "/crm/v1/pipelines/{objectType}";
|
|
7047
|
+
readonly streaming: "no";
|
|
7048
|
+
readonly pagination: false;
|
|
7049
|
+
readonly pathParams: readonly [{
|
|
7050
|
+
readonly name: "objectType";
|
|
7051
|
+
readonly sdkName: "objectType";
|
|
7052
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
7053
|
+
}];
|
|
7054
|
+
readonly query: readonly [];
|
|
7055
|
+
readonly body: {
|
|
7056
|
+
readonly required: true;
|
|
7057
|
+
readonly fields: readonly [{
|
|
7058
|
+
readonly name: "displayOrder";
|
|
7059
|
+
readonly type: "integer";
|
|
7060
|
+
readonly required: true;
|
|
7061
|
+
readonly description: "An integer indicating the order in which the pipeline appears relative to other pipelines.";
|
|
7062
|
+
}, {
|
|
7063
|
+
readonly name: "label";
|
|
7064
|
+
readonly type: "string";
|
|
7065
|
+
readonly required: true;
|
|
7066
|
+
readonly description: "A string representing the name or title of the pipeline.";
|
|
7067
|
+
}, {
|
|
7068
|
+
readonly name: "pipelineId";
|
|
7069
|
+
readonly type: "string";
|
|
7070
|
+
readonly required: false;
|
|
7071
|
+
readonly description: "A string that uniquely identifies the pipeline. This property is optional when creating a new pipeline.";
|
|
7072
|
+
}, {
|
|
7073
|
+
readonly name: "stages";
|
|
7074
|
+
readonly type: "array";
|
|
7075
|
+
readonly itemType: "object";
|
|
7076
|
+
readonly required: true;
|
|
7077
|
+
readonly description: "An array of PipelineStageInput objects, each representing a stage within the pipeline.";
|
|
7078
|
+
}];
|
|
7079
|
+
};
|
|
7080
|
+
}, {
|
|
7081
|
+
readonly resource: "crm.pipelines";
|
|
7082
|
+
readonly method: "archive";
|
|
7083
|
+
readonly summary: "Archive pipeline";
|
|
7084
|
+
readonly description: "Archive a pipeline selected from pipelines.list when records no longer depend on it. Check current records and stage usage first; resolve references reported by validation before retrying. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.";
|
|
7085
|
+
readonly http: "DELETE";
|
|
7086
|
+
readonly path: "/crm/v1/pipelines/{objectType}/{pipelineId}";
|
|
7087
|
+
readonly streaming: "no";
|
|
7088
|
+
readonly pagination: false;
|
|
7089
|
+
readonly pathParams: readonly [{
|
|
7090
|
+
readonly name: "objectType";
|
|
7091
|
+
readonly sdkName: "objectType";
|
|
7092
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
7093
|
+
}, {
|
|
7094
|
+
readonly name: "pipelineId";
|
|
7095
|
+
readonly sdkName: "pipelineId";
|
|
7096
|
+
readonly description: "Pipeline identifier from pipelines.list for this objectType.";
|
|
7097
|
+
}];
|
|
7098
|
+
readonly query: readonly [{
|
|
7099
|
+
readonly name: "validateDealStageUsagesBeforeDelete";
|
|
7100
|
+
readonly type: "boolean";
|
|
7101
|
+
readonly required: false;
|
|
7102
|
+
readonly description: "A boolean indicating whether to validate deal stage usages before deleting the pipeline. Defaults to true.";
|
|
7103
|
+
}, {
|
|
7104
|
+
readonly name: "validateReferencesBeforeDelete";
|
|
7105
|
+
readonly type: "boolean";
|
|
7106
|
+
readonly required: false;
|
|
7107
|
+
readonly description: "A boolean indicating whether to validate references before deleting the pipeline. Defaults to true.";
|
|
7108
|
+
}];
|
|
7109
|
+
}, {
|
|
7110
|
+
readonly resource: "crm.pipelines";
|
|
7111
|
+
readonly method: "retrieve";
|
|
7112
|
+
readonly summary: "Retrieve pipeline";
|
|
7113
|
+
readonly description: "Inspect the stage ids and metadata of a pipeline before moving a record or editing its workflow. Obtain pipelineId from pipelines.list and use the returned stages array to select a destination. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.";
|
|
7114
|
+
readonly http: "GET";
|
|
7115
|
+
readonly path: "/crm/v1/pipelines/{objectType}/{pipelineId}";
|
|
7116
|
+
readonly streaming: "no";
|
|
7117
|
+
readonly pagination: false;
|
|
7118
|
+
readonly pathParams: readonly [{
|
|
7119
|
+
readonly name: "objectType";
|
|
7120
|
+
readonly sdkName: "objectType";
|
|
7121
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
7122
|
+
}, {
|
|
7123
|
+
readonly name: "pipelineId";
|
|
7124
|
+
readonly sdkName: "pipelineId";
|
|
7125
|
+
readonly description: "Pipeline identifier from pipelines.list for this objectType.";
|
|
7126
|
+
}];
|
|
7127
|
+
readonly query: readonly [];
|
|
7128
|
+
}, {
|
|
7129
|
+
readonly resource: "crm.pipelines";
|
|
7130
|
+
readonly method: "update";
|
|
7131
|
+
readonly summary: "Update pipeline";
|
|
7132
|
+
readonly description: "Change editable pipeline settings selected by pipelineId from pipelines.list. Omit settings that should remain unchanged and inspect current stages with pipelines.retrieve before modifying the workflow. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.";
|
|
7133
|
+
readonly http: "PATCH";
|
|
7134
|
+
readonly path: "/crm/v1/pipelines/{objectType}/{pipelineId}";
|
|
7135
|
+
readonly streaming: "no";
|
|
7136
|
+
readonly pagination: false;
|
|
7137
|
+
readonly pathParams: readonly [{
|
|
7138
|
+
readonly name: "objectType";
|
|
7139
|
+
readonly sdkName: "objectType";
|
|
7140
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
7141
|
+
}, {
|
|
7142
|
+
readonly name: "pipelineId";
|
|
7143
|
+
readonly sdkName: "pipelineId";
|
|
7144
|
+
readonly description: "Pipeline identifier from pipelines.list for this objectType.";
|
|
7145
|
+
}];
|
|
7146
|
+
readonly query: readonly [{
|
|
7147
|
+
readonly name: "validateDealStageUsagesBeforeDelete";
|
|
7148
|
+
readonly type: "boolean";
|
|
7149
|
+
readonly required: false;
|
|
7150
|
+
readonly description: "A boolean indicating whether to validate deal stage usages before deleting. Defaults to true.";
|
|
7151
|
+
}, {
|
|
7152
|
+
readonly name: "validateReferencesBeforeDelete";
|
|
7153
|
+
readonly type: "boolean";
|
|
7154
|
+
readonly required: false;
|
|
7155
|
+
readonly description: "A boolean indicating whether to validate references before deleting. Defaults to true.";
|
|
7156
|
+
}];
|
|
7157
|
+
readonly body: {
|
|
7158
|
+
readonly required: true;
|
|
7159
|
+
readonly fields: readonly [{
|
|
7160
|
+
readonly name: "archived";
|
|
7161
|
+
readonly type: "boolean";
|
|
7162
|
+
readonly required: false;
|
|
7163
|
+
readonly description: "A boolean value that indicates whether the pipeline is archived.";
|
|
7164
|
+
}, {
|
|
7165
|
+
readonly name: "displayOrder";
|
|
7166
|
+
readonly type: "integer";
|
|
7167
|
+
readonly required: false;
|
|
7168
|
+
readonly description: "An integer indicating the position of the pipeline in a list, which determines its display order.";
|
|
7169
|
+
}, {
|
|
7170
|
+
readonly name: "label";
|
|
7171
|
+
readonly type: "string";
|
|
7172
|
+
readonly required: false;
|
|
7173
|
+
readonly description: "The name of the pipeline, represented as a string.";
|
|
7174
|
+
}];
|
|
7175
|
+
};
|
|
7176
|
+
}, {
|
|
7177
|
+
readonly resource: "crm.pipelines.stages";
|
|
7178
|
+
readonly method: "create";
|
|
7179
|
+
readonly summary: "Create pipeline stage";
|
|
7180
|
+
readonly description: "Add an ordered stage to a pipeline from pipelines.list. Provide its display label, displayOrder and metadata; save the returned stage id for record updates. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.";
|
|
7181
|
+
readonly http: "POST";
|
|
7182
|
+
readonly path: "/crm/v1/pipelines/{objectType}/{pipelineId}/stages";
|
|
7183
|
+
readonly streaming: "no";
|
|
7184
|
+
readonly pagination: false;
|
|
7185
|
+
readonly pathParams: readonly [{
|
|
7186
|
+
readonly name: "objectType";
|
|
7187
|
+
readonly sdkName: "objectType";
|
|
7188
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
7189
|
+
}, {
|
|
7190
|
+
readonly name: "pipelineId";
|
|
7191
|
+
readonly sdkName: "pipelineId";
|
|
7192
|
+
readonly description: "Pipeline identifier from pipelines.list for this objectType.";
|
|
7193
|
+
}];
|
|
7194
|
+
readonly query: readonly [];
|
|
7195
|
+
readonly body: {
|
|
7196
|
+
readonly required: true;
|
|
7197
|
+
readonly fields: readonly [{
|
|
7198
|
+
readonly name: "displayOrder";
|
|
7199
|
+
readonly type: "integer";
|
|
7200
|
+
readonly required: true;
|
|
7201
|
+
readonly description: "An integer indicating the position of this stage within the pipeline. Lower numbers indicate earlier stages.";
|
|
7202
|
+
}, {
|
|
7203
|
+
readonly name: "label";
|
|
7204
|
+
readonly type: "string";
|
|
7205
|
+
readonly required: true;
|
|
7206
|
+
readonly description: "The name of the pipeline stage. It is a string that provides a human-readable identifier for the stage.";
|
|
7207
|
+
}, {
|
|
7208
|
+
readonly name: "metadata";
|
|
7209
|
+
readonly type: "object";
|
|
7210
|
+
readonly required: true;
|
|
7211
|
+
readonly description: "String-valued stage settings, including transition and entry requirements. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying.";
|
|
7212
|
+
}, {
|
|
7213
|
+
readonly name: "stageId";
|
|
7214
|
+
readonly type: "string";
|
|
7215
|
+
readonly required: false;
|
|
7216
|
+
readonly description: "A string that uniquely identifies the stage within the pipeline.";
|
|
7217
|
+
}];
|
|
7218
|
+
};
|
|
7219
|
+
}, {
|
|
7220
|
+
readonly resource: "crm.pipelines.stages";
|
|
7221
|
+
readonly method: "archive";
|
|
7222
|
+
readonly summary: "Archive pipeline stage";
|
|
7223
|
+
readonly description: "Archive a stage selected from pipelines.retrieve after checking record usage. A stage that still has records cannot be archived without resolving their assignment; move those records to an allowed stage first. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.";
|
|
7224
|
+
readonly http: "DELETE";
|
|
7225
|
+
readonly path: "/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}";
|
|
7226
|
+
readonly streaming: "no";
|
|
7227
|
+
readonly pagination: false;
|
|
7228
|
+
readonly pathParams: readonly [{
|
|
7229
|
+
readonly name: "objectType";
|
|
7230
|
+
readonly sdkName: "objectType";
|
|
7231
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
7232
|
+
}, {
|
|
7233
|
+
readonly name: "pipelineId";
|
|
7234
|
+
readonly sdkName: "pipelineId";
|
|
7235
|
+
readonly description: "Pipeline identifier from pipelines.list for this objectType.";
|
|
7236
|
+
}, {
|
|
7237
|
+
readonly name: "stageId";
|
|
7238
|
+
readonly sdkName: "stageId";
|
|
7239
|
+
readonly description: "Stage identifier from the stages array returned by pipelines.retrieve for this pipeline.";
|
|
7240
|
+
}];
|
|
7241
|
+
readonly query: readonly [{
|
|
7242
|
+
readonly name: "validateReferencesBeforeDelete";
|
|
7243
|
+
readonly type: "boolean";
|
|
7244
|
+
readonly required: false;
|
|
7245
|
+
readonly description: "A boolean flag indicating whether to validate references before deleting the stage. Defaults to true.";
|
|
7246
|
+
}];
|
|
7247
|
+
}, {
|
|
7248
|
+
readonly resource: "crm.pipelines.stages";
|
|
7249
|
+
readonly method: "update";
|
|
7250
|
+
readonly summary: "Update pipeline stage";
|
|
7251
|
+
readonly description: "Change the label, order or metadata of a stage selected from pipelines.retrieve. Existing records must satisfy entry rules when subsequently moved; omitted settings retain their values. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.";
|
|
7252
|
+
readonly http: "PATCH";
|
|
7253
|
+
readonly path: "/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}";
|
|
7254
|
+
readonly streaming: "no";
|
|
7255
|
+
readonly pagination: false;
|
|
7256
|
+
readonly pathParams: readonly [{
|
|
7257
|
+
readonly name: "objectType";
|
|
7258
|
+
readonly sdkName: "objectType";
|
|
7259
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
7260
|
+
}, {
|
|
7261
|
+
readonly name: "pipelineId";
|
|
7262
|
+
readonly sdkName: "pipelineId";
|
|
7263
|
+
readonly description: "Pipeline identifier from pipelines.list for this objectType.";
|
|
7264
|
+
}, {
|
|
7265
|
+
readonly name: "stageId";
|
|
7266
|
+
readonly sdkName: "stageId";
|
|
7267
|
+
readonly description: "Stage identifier from the stages array returned by pipelines.retrieve for this pipeline.";
|
|
7268
|
+
}];
|
|
7269
|
+
readonly query: readonly [];
|
|
7270
|
+
readonly body: {
|
|
7271
|
+
readonly required: true;
|
|
7272
|
+
readonly fields: readonly [{
|
|
7273
|
+
readonly name: "archived";
|
|
7274
|
+
readonly type: "boolean";
|
|
7275
|
+
readonly required: false;
|
|
7276
|
+
readonly description: "A boolean indicating whether the pipeline stage is archived.";
|
|
7277
|
+
}, {
|
|
7278
|
+
readonly name: "displayOrder";
|
|
7279
|
+
readonly type: "integer";
|
|
7280
|
+
readonly required: false;
|
|
7281
|
+
readonly description: "An integer specifying the order in which the stage appears relative to other stages.";
|
|
7282
|
+
}, {
|
|
7283
|
+
readonly name: "label";
|
|
7284
|
+
readonly type: "string";
|
|
7285
|
+
readonly required: false;
|
|
7286
|
+
readonly description: "A string representing the name or title of the pipeline stage.";
|
|
7287
|
+
}, {
|
|
7288
|
+
readonly name: "metadata";
|
|
7289
|
+
readonly type: "object";
|
|
7290
|
+
readonly required: true;
|
|
7291
|
+
readonly description: "String-valued stage settings, including transition and entry requirements. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying.";
|
|
7292
|
+
}];
|
|
7293
|
+
};
|
|
7294
|
+
}, {
|
|
7295
|
+
readonly resource: "crm.properties";
|
|
7296
|
+
readonly method: "list";
|
|
7297
|
+
readonly summary: "List properties";
|
|
7298
|
+
readonly description: "Inspect the property definitions available for an object type before writing or filtering records. Obtain objectType from schemas.list; reuse each immutable name in record properties and filters. archived defaults to false.";
|
|
7299
|
+
readonly http: "GET";
|
|
7300
|
+
readonly path: "/crm/v1/properties/{objectType}";
|
|
7301
|
+
readonly streaming: "no";
|
|
7302
|
+
readonly pagination: false;
|
|
7303
|
+
readonly pathParams: readonly [{
|
|
7304
|
+
readonly name: "objectType";
|
|
7305
|
+
readonly sdkName: "objectType";
|
|
7306
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
7307
|
+
}];
|
|
7308
|
+
readonly query: readonly [{
|
|
7309
|
+
readonly name: "archived";
|
|
7310
|
+
readonly type: "boolean";
|
|
7311
|
+
readonly required: false;
|
|
7312
|
+
readonly description: "Whether to return only results that have been archived.";
|
|
7313
|
+
}, {
|
|
7314
|
+
readonly name: "dataSensitivity";
|
|
7315
|
+
readonly type: "string";
|
|
7316
|
+
readonly enum: readonly ["highly_sensitive", "non_sensitive", "sensitive"];
|
|
7317
|
+
readonly required: false;
|
|
7318
|
+
readonly description: "Filter properties based on data sensitivity level. Valid values are 'non_sensitive', 'sensitive', and 'highly_sensitive'. Defaults to 'non_sensitive'.";
|
|
7319
|
+
}, {
|
|
7320
|
+
readonly name: "locale";
|
|
7321
|
+
readonly type: "string";
|
|
7322
|
+
readonly required: false;
|
|
7323
|
+
readonly description: "Specify the locale to retrieve properties in a particular language or regional format.";
|
|
7324
|
+
}, {
|
|
7325
|
+
readonly name: "properties";
|
|
7326
|
+
readonly type: "string";
|
|
7327
|
+
readonly required: false;
|
|
7328
|
+
readonly description: "A comma-separated list of property names to include in the response.";
|
|
7329
|
+
}];
|
|
7330
|
+
}, {
|
|
7331
|
+
readonly resource: "crm.properties";
|
|
7332
|
+
readonly method: "create";
|
|
7333
|
+
readonly summary: "Create property";
|
|
7334
|
+
readonly description: "Define a property before setting its values on records. Choose objectType from schemas.list and groupName from properties.groups.list; provide an immutable internal name, display label, type and fieldType. Enumeration properties require their valid options. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
|
|
7335
|
+
readonly http: "POST";
|
|
7336
|
+
readonly path: "/crm/v1/properties/{objectType}";
|
|
7337
|
+
readonly streaming: "no";
|
|
7338
|
+
readonly pagination: false;
|
|
7339
|
+
readonly pathParams: readonly [{
|
|
7340
|
+
readonly name: "objectType";
|
|
7341
|
+
readonly sdkName: "objectType";
|
|
7342
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
7343
|
+
}];
|
|
7344
|
+
readonly query: readonly [];
|
|
7345
|
+
readonly body: {
|
|
7346
|
+
readonly required: true;
|
|
7347
|
+
readonly fields: readonly [{
|
|
7348
|
+
readonly name: "calculationFormula";
|
|
7349
|
+
readonly type: "string";
|
|
7350
|
+
readonly required: false;
|
|
7351
|
+
readonly description: "Represents a formula that is used to compute a calculated property.";
|
|
7352
|
+
}, {
|
|
7353
|
+
readonly name: "currencyPropertyName";
|
|
7354
|
+
readonly type: "string";
|
|
7355
|
+
readonly required: false;
|
|
7356
|
+
readonly description: "A string representing the name of the currency property.";
|
|
7357
|
+
}, {
|
|
7358
|
+
readonly name: "dataSensitivity";
|
|
7359
|
+
readonly type: "string";
|
|
7360
|
+
readonly enum: readonly ["highly_sensitive", "non_sensitive", "sensitive"];
|
|
7361
|
+
readonly required: false;
|
|
7362
|
+
readonly description: "Indicates the sensitivity level of the property, with options: highly_sensitive, non_sensitive, or sensitive.";
|
|
7363
|
+
}, {
|
|
7364
|
+
readonly name: "description";
|
|
7365
|
+
readonly type: "string";
|
|
7366
|
+
readonly required: false;
|
|
7367
|
+
readonly description: "A description of the property that will be shown as help text in CRM.";
|
|
7368
|
+
}, {
|
|
7369
|
+
readonly name: "displayOrder";
|
|
7370
|
+
readonly type: "integer";
|
|
7371
|
+
readonly required: false;
|
|
7372
|
+
readonly description: "Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property to be displayed after any positive values.";
|
|
7373
|
+
}, {
|
|
7374
|
+
readonly name: "externalOptions";
|
|
7375
|
+
readonly type: "boolean";
|
|
7376
|
+
readonly required: false;
|
|
7377
|
+
readonly description: "Applicable only for 'enumeration' type properties. Should be set to true in conjunction with a 'referencedObjectType' of 'OWNER'. Otherwise false.";
|
|
7378
|
+
}, {
|
|
7379
|
+
readonly name: "fieldType";
|
|
7380
|
+
readonly type: "string";
|
|
7381
|
+
readonly enum: readonly ["booleancheckbox", "calculation_equation", "checkbox", "date", "file", "html", "number", "phonenumber", "radio", "select", "text", "textarea"];
|
|
7382
|
+
readonly required: true;
|
|
7383
|
+
readonly description: "Controls how the property appears in CRM.";
|
|
7384
|
+
}, {
|
|
7385
|
+
readonly name: "formField";
|
|
7386
|
+
readonly type: "boolean";
|
|
7387
|
+
readonly required: false;
|
|
7388
|
+
readonly description: "Whether or not the property can be used in a CRM form.";
|
|
7389
|
+
}, {
|
|
7390
|
+
readonly name: "groupName";
|
|
7391
|
+
readonly type: "string";
|
|
7392
|
+
readonly required: true;
|
|
7393
|
+
readonly description: "The name of the property group the property belongs to.";
|
|
7394
|
+
}, {
|
|
7395
|
+
readonly name: "hasUniqueValue";
|
|
7396
|
+
readonly type: "boolean";
|
|
7397
|
+
readonly required: false;
|
|
7398
|
+
readonly description: "Whether or not the property's value must be unique. Once set, this can't be changed.";
|
|
7399
|
+
}, {
|
|
7400
|
+
readonly name: "hidden";
|
|
7401
|
+
readonly type: "boolean";
|
|
7402
|
+
readonly required: false;
|
|
7403
|
+
readonly description: "If true, the property won't be visible and can't be used in CRM.";
|
|
7404
|
+
}, {
|
|
7405
|
+
readonly name: "label";
|
|
7406
|
+
readonly type: "string";
|
|
7407
|
+
readonly required: true;
|
|
7408
|
+
readonly description: "A human-readable property label that will be shown in CRM.";
|
|
7409
|
+
}, {
|
|
7410
|
+
readonly name: "name";
|
|
7411
|
+
readonly type: "string";
|
|
7412
|
+
readonly required: true;
|
|
7413
|
+
readonly description: "The internal property name, which must be used when referencing the property via the API.";
|
|
7414
|
+
}, {
|
|
7415
|
+
readonly name: "numberDisplayHint";
|
|
7416
|
+
readonly type: "string";
|
|
7417
|
+
readonly enum: readonly ["currency", "duration", "formatted", "percentage", "probability", "unformatted"];
|
|
7418
|
+
readonly required: false;
|
|
7419
|
+
readonly description: "A string providing a hint on how to display numbers. Valid values include 'unformatted', 'formatted', 'currency', 'percentage', 'duration', 'probability'.";
|
|
7420
|
+
}, {
|
|
7421
|
+
readonly name: "options";
|
|
7422
|
+
readonly type: "array";
|
|
7423
|
+
readonly itemType: "object";
|
|
7424
|
+
readonly required: false;
|
|
7425
|
+
readonly description: "A list of valid options for the property. This field is required for enumerated properties.";
|
|
7426
|
+
}, {
|
|
7427
|
+
readonly name: "referencedObjectType";
|
|
7428
|
+
readonly type: "string";
|
|
7429
|
+
readonly required: false;
|
|
7430
|
+
readonly description: "Should be set to 'OWNER' when 'externalOptions' is true, which causes the property to dynamically pull option values from the current CRM users.";
|
|
7431
|
+
}, {
|
|
7432
|
+
readonly name: "showCurrencySymbol";
|
|
7433
|
+
readonly type: "boolean";
|
|
7434
|
+
readonly required: false;
|
|
7435
|
+
readonly description: "A boolean indicating whether to show the currency symbol for currency fields.";
|
|
7436
|
+
}, {
|
|
7437
|
+
readonly name: "textDisplayHint";
|
|
7438
|
+
readonly type: "string";
|
|
7439
|
+
readonly enum: readonly ["domain_name", "email", "ip_address", "multi_line", "phone_number", "physical_address", "postal_code", "unformatted_single_line"];
|
|
7440
|
+
readonly required: false;
|
|
7441
|
+
readonly description: "A string providing a hint on how to display text. Valid values include 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', 'postal_code'.";
|
|
7442
|
+
}, {
|
|
7443
|
+
readonly name: "type";
|
|
7444
|
+
readonly type: "string";
|
|
7445
|
+
readonly enum: readonly ["bool", "date", "datetime", "enumeration", "number", "phone_number", "string"];
|
|
7446
|
+
readonly required: true;
|
|
7447
|
+
readonly description: "The data type of the property.";
|
|
7448
|
+
}];
|
|
7449
|
+
};
|
|
7450
|
+
}, {
|
|
7451
|
+
readonly resource: "crm.properties.groups";
|
|
7452
|
+
readonly method: "list";
|
|
7453
|
+
readonly summary: "List property groups";
|
|
7454
|
+
readonly description: "Discover property groups for an object type before creating or organizing property definitions. Obtain objectType from schemas.list and reuse a group name as groupName in properties.create or properties.update.";
|
|
7455
|
+
readonly http: "GET";
|
|
7456
|
+
readonly path: "/crm/v1/properties/{objectType}/groups";
|
|
7457
|
+
readonly streaming: "no";
|
|
7458
|
+
readonly pagination: false;
|
|
7459
|
+
readonly pathParams: readonly [{
|
|
7460
|
+
readonly name: "objectType";
|
|
7461
|
+
readonly sdkName: "objectType";
|
|
7462
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
7463
|
+
}];
|
|
7464
|
+
readonly query: readonly [{
|
|
7465
|
+
readonly name: "locale";
|
|
7466
|
+
readonly type: "string";
|
|
7467
|
+
readonly required: false;
|
|
7468
|
+
readonly description: "The language locale to use for property group labels. This can help in displaying labels in the preferred language.";
|
|
7469
|
+
}];
|
|
7470
|
+
}, {
|
|
7471
|
+
readonly resource: "crm.properties.groups";
|
|
7472
|
+
readonly method: "create";
|
|
7473
|
+
readonly summary: "Create property group";
|
|
7474
|
+
readonly description: "Create a named group for related property definitions of one object type. Obtain objectType from schemas.list; choose a unique internal name and display label, then reuse the returned name as groupName when creating properties. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
|
|
7475
|
+
readonly http: "POST";
|
|
7476
|
+
readonly path: "/crm/v1/properties/{objectType}/groups";
|
|
7477
|
+
readonly streaming: "no";
|
|
7478
|
+
readonly pagination: false;
|
|
7479
|
+
readonly pathParams: readonly [{
|
|
7480
|
+
readonly name: "objectType";
|
|
7481
|
+
readonly sdkName: "objectType";
|
|
7482
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
7483
|
+
}];
|
|
7484
|
+
readonly query: readonly [];
|
|
7485
|
+
readonly body: {
|
|
7486
|
+
readonly required: true;
|
|
7487
|
+
readonly fields: readonly [{
|
|
7488
|
+
readonly name: "displayOrder";
|
|
7489
|
+
readonly type: "integer";
|
|
7490
|
+
readonly required: false;
|
|
7491
|
+
readonly description: "Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.";
|
|
7492
|
+
}, {
|
|
7493
|
+
readonly name: "label";
|
|
7494
|
+
readonly type: "string";
|
|
7495
|
+
readonly required: true;
|
|
7496
|
+
readonly description: "A human-readable label that will be shown in CRM.";
|
|
7497
|
+
}, {
|
|
7498
|
+
readonly name: "name";
|
|
7499
|
+
readonly type: "string";
|
|
7500
|
+
readonly required: true;
|
|
7501
|
+
readonly description: "The internal property group name, which must be used when referencing the property group via the API.";
|
|
7502
|
+
}];
|
|
7503
|
+
};
|
|
7504
|
+
}, {
|
|
7505
|
+
readonly resource: "crm.properties";
|
|
7506
|
+
readonly method: "archive";
|
|
7507
|
+
readonly summary: "Archive property";
|
|
7508
|
+
readonly description: "Archive a property definition selected by internal name from properties.list. Confirm that record entry and search flows no longer depend on it; archived definitions are excluded from normal property lists. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204.";
|
|
7509
|
+
readonly http: "DELETE";
|
|
7510
|
+
readonly path: "/crm/v1/properties/{objectType}/{propertyName}";
|
|
7511
|
+
readonly streaming: "no";
|
|
7512
|
+
readonly pagination: false;
|
|
7513
|
+
readonly pathParams: readonly [{
|
|
7514
|
+
readonly name: "objectType";
|
|
7515
|
+
readonly sdkName: "objectType";
|
|
7516
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
7517
|
+
}, {
|
|
7518
|
+
readonly name: "propertyName";
|
|
7519
|
+
readonly sdkName: "propertyName";
|
|
7520
|
+
readonly description: "Immutable internal property name from properties.list; do not pass the display label.";
|
|
7521
|
+
}];
|
|
7522
|
+
readonly query: readonly [];
|
|
7523
|
+
}, {
|
|
7524
|
+
readonly resource: "crm.properties";
|
|
7525
|
+
readonly method: "retrieve";
|
|
7526
|
+
readonly summary: "Retrieve property";
|
|
7527
|
+
readonly description: "Inspect the type, options and modification restrictions of a property before changing its definition or record values. Obtain propertyName from properties.list; it is the immutable internal name rather than the label.";
|
|
7528
|
+
readonly http: "GET";
|
|
7529
|
+
readonly path: "/crm/v1/properties/{objectType}/{propertyName}";
|
|
7530
|
+
readonly streaming: "no";
|
|
7531
|
+
readonly pagination: false;
|
|
7532
|
+
readonly pathParams: readonly [{
|
|
7533
|
+
readonly name: "objectType";
|
|
7534
|
+
readonly sdkName: "objectType";
|
|
7535
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
7536
|
+
}, {
|
|
7537
|
+
readonly name: "propertyName";
|
|
7538
|
+
readonly sdkName: "propertyName";
|
|
7539
|
+
readonly description: "Immutable internal property name from properties.list; do not pass the display label.";
|
|
7540
|
+
}];
|
|
7541
|
+
readonly query: readonly [{
|
|
7542
|
+
readonly name: "archived";
|
|
7543
|
+
readonly type: "boolean";
|
|
7544
|
+
readonly required: false;
|
|
7545
|
+
readonly description: "Whether to return only results that have been archived.";
|
|
7546
|
+
}, {
|
|
7547
|
+
readonly name: "dataSensitivity";
|
|
7548
|
+
readonly type: "string";
|
|
7549
|
+
readonly enum: readonly ["highly_sensitive", "non_sensitive", "sensitive"];
|
|
7550
|
+
readonly required: false;
|
|
7551
|
+
readonly description: "The level of data sensitivity to filter properties by. Valid values are 'non_sensitive', 'sensitive', and 'highly_sensitive'. Defaults to 'non_sensitive'.";
|
|
7552
|
+
}, {
|
|
7553
|
+
readonly name: "locale";
|
|
7554
|
+
readonly type: "string";
|
|
7555
|
+
readonly required: false;
|
|
7556
|
+
readonly description: "The locale to use for property labels and descriptions.";
|
|
7557
|
+
}, {
|
|
7558
|
+
readonly name: "properties";
|
|
7559
|
+
readonly type: "string";
|
|
7560
|
+
readonly required: false;
|
|
7561
|
+
readonly description: "A comma-separated list of property names to include in the response.";
|
|
7562
|
+
}];
|
|
7563
|
+
}, {
|
|
7564
|
+
readonly resource: "crm.properties";
|
|
7565
|
+
readonly method: "update";
|
|
7566
|
+
readonly summary: "Update property";
|
|
7567
|
+
readonly description: "Change editable settings of a property selected from properties.list, such as its label, group or options. Preserve the immutable internal name; inspect modificationMetadata before editing system-managed definitions. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
|
|
7568
|
+
readonly http: "PATCH";
|
|
7569
|
+
readonly path: "/crm/v1/properties/{objectType}/{propertyName}";
|
|
7570
|
+
readonly streaming: "no";
|
|
7571
|
+
readonly pagination: false;
|
|
7572
|
+
readonly pathParams: readonly [{
|
|
7573
|
+
readonly name: "objectType";
|
|
7574
|
+
readonly sdkName: "objectType";
|
|
7575
|
+
readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
|
|
7576
|
+
}, {
|
|
7577
|
+
readonly name: "propertyName";
|
|
7578
|
+
readonly sdkName: "propertyName";
|
|
7579
|
+
readonly description: "Immutable internal property name from properties.list; do not pass the display label.";
|
|
7580
|
+
}];
|
|
7581
|
+
readonly query: readonly [];
|
|
7582
|
+
readonly body: {
|
|
7583
|
+
readonly required: true;
|
|
7584
|
+
readonly fields: readonly [{
|
|
7585
|
+
readonly name: "calculationFormula";
|
|
7586
|
+
readonly type: "string";
|
|
7587
|
+
readonly required: false;
|
|
7588
|
+
readonly description: "Represents a formula that is used to compute a calculated property.";
|
|
7589
|
+
}, {
|
|
7590
|
+
readonly name: "currencyPropertyName";
|
|
7591
|
+
readonly type: "string";
|
|
7592
|
+
readonly required: false;
|
|
7593
|
+
readonly description: "A string specifying the name of the property that holds the currency information, applicable when showCurrencySymbol is true.";
|
|
7594
|
+
}, {
|
|
7595
|
+
readonly name: "description";
|
|
7596
|
+
readonly type: "string";
|
|
7597
|
+
readonly required: false;
|
|
7598
|
+
readonly description: "A description of the property that will be shown as help text in CRM.";
|
|
7599
|
+
}, {
|
|
7600
|
+
readonly name: "displayOrder";
|
|
7601
|
+
readonly type: "integer";
|
|
7602
|
+
readonly required: false;
|
|
7603
|
+
readonly description: "Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the Property to be displayed after any positive values.";
|
|
7604
|
+
}, {
|
|
7605
|
+
readonly name: "fieldType";
|
|
7606
|
+
readonly type: "string";
|
|
7607
|
+
readonly enum: readonly ["booleancheckbox", "calculation_equation", "checkbox", "date", "file", "html", "number", "phonenumber", "radio", "select", "text", "textarea"];
|
|
7608
|
+
readonly required: false;
|
|
7609
|
+
readonly description: "Controls how the property appears in CRM.";
|
|
7610
|
+
}, {
|
|
7611
|
+
readonly name: "formField";
|
|
7612
|
+
readonly type: "boolean";
|
|
7613
|
+
readonly required: false;
|
|
7614
|
+
readonly description: "Whether or not the property can be used in a CRM form.";
|
|
7615
|
+
}, {
|
|
7616
|
+
readonly name: "groupName";
|
|
7617
|
+
readonly type: "string";
|
|
7618
|
+
readonly required: false;
|
|
7619
|
+
readonly description: "The name of the property group the property belongs to.";
|
|
7620
|
+
}, {
|
|
7621
|
+
readonly name: "hidden";
|
|
7622
|
+
readonly type: "boolean";
|
|
7623
|
+
readonly required: false;
|
|
7624
|
+
readonly description: "If true, the property won't be visible and can't be used in CRM.";
|
|
7625
|
+
}, {
|
|
7626
|
+
readonly name: "label";
|
|
7627
|
+
readonly type: "string";
|
|
7628
|
+
readonly required: false;
|
|
7629
|
+
readonly description: "A human-readable property label that will be shown in CRM.";
|
|
7630
|
+
}, {
|
|
7631
|
+
readonly name: "numberDisplayHint";
|
|
7632
|
+
readonly type: "string";
|
|
7633
|
+
readonly enum: readonly ["currency", "duration", "formatted", "percentage", "probability", "unformatted"];
|
|
7634
|
+
readonly required: false;
|
|
7635
|
+
readonly description: "A string providing a hint for displaying number values. Valid values include 'unformatted', 'formatted', 'currency', 'percentage', 'duration', and 'probability'.";
|
|
7636
|
+
}, {
|
|
7637
|
+
readonly name: "options";
|
|
7638
|
+
readonly type: "array";
|
|
7639
|
+
readonly itemType: "object";
|
|
7640
|
+
readonly required: false;
|
|
7641
|
+
readonly description: "A list of valid options for the property.";
|
|
7642
|
+
}, {
|
|
7643
|
+
readonly name: "showCurrencySymbol";
|
|
7644
|
+
readonly type: "boolean";
|
|
7645
|
+
readonly required: false;
|
|
7646
|
+
readonly description: "A boolean indicating whether to display a currency symbol for number fields formatted as currency.";
|
|
7647
|
+
}, {
|
|
7648
|
+
readonly name: "textDisplayHint";
|
|
7649
|
+
readonly type: "string";
|
|
7650
|
+
readonly enum: readonly ["domain_name", "email", "ip_address", "multi_line", "phone_number", "physical_address", "postal_code", "unformatted_single_line"];
|
|
7651
|
+
readonly required: false;
|
|
7652
|
+
readonly description: "A string providing a hint for displaying text values. Valid values include 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', and 'postal_code'.";
|
|
7653
|
+
}, {
|
|
7654
|
+
readonly name: "type";
|
|
7655
|
+
readonly type: "string";
|
|
7656
|
+
readonly enum: readonly ["bool", "date", "datetime", "enumeration", "number", "phone_number", "string"];
|
|
7657
|
+
readonly required: false;
|
|
7658
|
+
readonly description: "The data type of the property.";
|
|
7659
|
+
}];
|
|
7660
|
+
};
|
|
7661
|
+
}, {
|
|
7662
|
+
readonly resource: "crm.schemas";
|
|
7663
|
+
readonly method: "list";
|
|
7664
|
+
readonly summary: "List object schemas";
|
|
7665
|
+
readonly description: "Discover available object schemas, display labels, property definitions and association definitions. Reuse the object type identifier or name in record, property and pipeline operations. archived defaults to false; the include parameters control the definition and audit details returned.";
|
|
7666
|
+
readonly http: "GET";
|
|
7667
|
+
readonly path: "/crm/v1/schemas";
|
|
7668
|
+
readonly streaming: "no";
|
|
7669
|
+
readonly pagination: false;
|
|
7670
|
+
readonly pathParams: readonly [];
|
|
7671
|
+
readonly query: readonly [{
|
|
7672
|
+
readonly name: "archived";
|
|
7673
|
+
readonly type: "boolean";
|
|
7674
|
+
readonly required: false;
|
|
7675
|
+
readonly description: "Whether to return only results that have been archived.";
|
|
7676
|
+
}, {
|
|
7677
|
+
readonly name: "includeAssociationDefinitions";
|
|
7678
|
+
readonly type: "boolean";
|
|
7679
|
+
readonly required: false;
|
|
7680
|
+
readonly description: "Whether to include association definitions in the response. Defaults to true.";
|
|
7681
|
+
}, {
|
|
7682
|
+
readonly name: "includeAuditMetadata";
|
|
7683
|
+
readonly type: "boolean";
|
|
7684
|
+
readonly required: false;
|
|
7685
|
+
readonly description: "Whether to include audit metadata in the response. Defaults to true.";
|
|
7686
|
+
}, {
|
|
7687
|
+
readonly name: "includePropertyDefinitions";
|
|
7688
|
+
readonly type: "boolean";
|
|
7689
|
+
readonly required: false;
|
|
7690
|
+
readonly description: "Whether to include property definitions in the response. Defaults to true.";
|
|
7691
|
+
}];
|
|
7692
|
+
}, {
|
|
7693
|
+
readonly resource: "crm.schemas";
|
|
7694
|
+
readonly method: "create";
|
|
7695
|
+
readonly summary: "Create object schema";
|
|
7696
|
+
readonly description: "Define a custom CRM object type before creating its records. Provide its immutable name, singular and plural labels, primaryDisplayProperty, properties and associated object types. Save the returned object type identifier for subsequent record and property operations. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
|
|
7697
|
+
readonly http: "POST";
|
|
7698
|
+
readonly path: "/crm/v1/schemas";
|
|
7699
|
+
readonly streaming: "no";
|
|
7700
|
+
readonly pagination: false;
|
|
7701
|
+
readonly pathParams: readonly [];
|
|
7702
|
+
readonly query: readonly [];
|
|
7703
|
+
readonly body: {
|
|
7704
|
+
readonly required: true;
|
|
7705
|
+
readonly fields: readonly [{
|
|
7706
|
+
readonly name: "allowsSensitiveProperties";
|
|
7707
|
+
readonly type: "boolean";
|
|
7708
|
+
readonly required: true;
|
|
7709
|
+
readonly description: "Determines if the object type can include properties that are marked as sensitive.";
|
|
7710
|
+
}, {
|
|
7711
|
+
readonly name: "associatedObjects";
|
|
7712
|
+
readonly type: "array";
|
|
7713
|
+
readonly itemType: "string";
|
|
7714
|
+
readonly required: true;
|
|
7715
|
+
readonly description: "Associations defined for this object type.";
|
|
7716
|
+
}, {
|
|
7717
|
+
readonly name: "description";
|
|
7718
|
+
readonly type: "string";
|
|
7719
|
+
readonly required: false;
|
|
7720
|
+
readonly description: "A brief explanation of the object type.";
|
|
7721
|
+
}, {
|
|
7722
|
+
readonly name: "labels";
|
|
7723
|
+
readonly type: "object";
|
|
7724
|
+
readonly required: true;
|
|
7725
|
+
}, {
|
|
7726
|
+
readonly name: "name";
|
|
7727
|
+
readonly type: "string";
|
|
7728
|
+
readonly required: true;
|
|
7729
|
+
readonly description: "A unique name for this object. For internal use only.";
|
|
7730
|
+
}, {
|
|
7731
|
+
readonly name: "primaryDisplayProperty";
|
|
7732
|
+
readonly type: "string";
|
|
7733
|
+
readonly required: false;
|
|
7734
|
+
readonly description: "The name of the primary property for this object. This will be displayed as primary on the CRM record page for this object type.";
|
|
7735
|
+
}, {
|
|
7736
|
+
readonly name: "properties";
|
|
7737
|
+
readonly type: "array";
|
|
7738
|
+
readonly itemType: "object";
|
|
7739
|
+
readonly required: true;
|
|
7740
|
+
readonly description: "Properties defined for this object type.";
|
|
7741
|
+
}, {
|
|
7742
|
+
readonly name: "requiredProperties";
|
|
7743
|
+
readonly type: "array";
|
|
7744
|
+
readonly itemType: "string";
|
|
7745
|
+
readonly required: true;
|
|
7746
|
+
readonly description: "The names of properties that should be **required** when creating an object of this type.";
|
|
7747
|
+
}, {
|
|
7748
|
+
readonly name: "searchableProperties";
|
|
7749
|
+
readonly type: "array";
|
|
7750
|
+
readonly itemType: "string";
|
|
7751
|
+
readonly required: true;
|
|
7752
|
+
readonly description: "Names of properties that will be indexed for this object type in by CRM's product search.";
|
|
7753
|
+
}, {
|
|
7754
|
+
readonly name: "secondaryDisplayProperties";
|
|
7755
|
+
readonly type: "array";
|
|
7756
|
+
readonly itemType: "string";
|
|
7757
|
+
readonly required: true;
|
|
7758
|
+
readonly description: "The names of secondary properties for this object. These will be displayed as secondary on the CRM record page for this object type.";
|
|
7759
|
+
}, {
|
|
7760
|
+
readonly name: "shouldCreateSameObjectAssociation";
|
|
7761
|
+
readonly type: "boolean";
|
|
7762
|
+
readonly required: true;
|
|
7763
|
+
readonly description: "A boolean indicating whether associations should be created between objects of the same type.";
|
|
7764
|
+
}];
|
|
7765
|
+
};
|
|
7766
|
+
}, {
|
|
7767
|
+
readonly resource: "cut.exports";
|
|
7768
|
+
readonly method: "retrieve";
|
|
7769
|
+
readonly summary: "Retrieve video export";
|
|
7770
|
+
readonly description: "Poll an export id returned by projects.exports.create or list to observe render progress. queued, fetching, rendering, stitching and saving are in progress; done provides asset in the target library, failed provides error, and canceled means the job stopped. Only done confirms a usable output asset.";
|
|
7771
|
+
readonly http: "GET";
|
|
7772
|
+
readonly path: "/cut/v1/exports/{export_id}";
|
|
7773
|
+
readonly streaming: "no";
|
|
7774
|
+
readonly pagination: false;
|
|
7775
|
+
readonly pathParams: readonly [{
|
|
7776
|
+
readonly name: "export_id";
|
|
7777
|
+
readonly sdkName: "export_id";
|
|
7778
|
+
readonly description: "Export identifier returned by its create or list operation; use the id, not a display name.";
|
|
7779
|
+
}];
|
|
7780
|
+
readonly query: readonly [];
|
|
7781
|
+
}, {
|
|
7782
|
+
readonly resource: "cut.exports";
|
|
7783
|
+
readonly method: "cancel";
|
|
7784
|
+
readonly summary: "Cancel video export";
|
|
7785
|
+
readonly description: "Request cancellation of an export obtained from projects.exports.create or list when its output is no longer needed. Read the returned job status and retrieve it to confirm the terminal outcome; do not interpret a cancellation request as successful rendering.";
|
|
7786
|
+
readonly http: "POST";
|
|
7787
|
+
readonly path: "/cut/v1/exports/{export_id}:cancel";
|
|
7788
|
+
readonly streaming: "no";
|
|
7789
|
+
readonly pagination: false;
|
|
7790
|
+
readonly pathParams: readonly [{
|
|
7791
|
+
readonly name: "export_id";
|
|
7792
|
+
readonly sdkName: "export_id";
|
|
7793
|
+
readonly description: "Export identifier returned by its create or list operation; use the id, not a display name.";
|
|
7794
|
+
}];
|
|
7795
|
+
readonly query: readonly [];
|
|
7796
|
+
}, {
|
|
7797
|
+
readonly resource: "cut.projects";
|
|
7798
|
+
readonly method: "list";
|
|
7799
|
+
readonly summary: "List projects";
|
|
7800
|
+
readonly description: "Discover projects owned by the API key organization and obtain project_id values. Results default to active projects ordered by updateTime descending; use filter state = \"deleted\" to find retained deleted projects for undelete. Continue with next_page_token as page_token until the token is absent.";
|
|
7801
|
+
readonly http: "GET";
|
|
7802
|
+
readonly path: "/cut/v1/projects";
|
|
7803
|
+
readonly streaming: "no";
|
|
7804
|
+
readonly pagination: false;
|
|
7805
|
+
readonly pathParams: readonly [];
|
|
7806
|
+
readonly query: readonly [{
|
|
7807
|
+
readonly name: "page_size";
|
|
7808
|
+
readonly type: "integer";
|
|
7809
|
+
readonly required: false;
|
|
7810
|
+
readonly description: "Maximum resources in one page, from 1 to 100; defaults to 50.";
|
|
7811
|
+
}, {
|
|
7812
|
+
readonly name: "page_token";
|
|
7813
|
+
readonly type: "string";
|
|
7814
|
+
readonly required: false;
|
|
7815
|
+
readonly description: "Opaque next_page_token from the preceding page; omit on the first request.";
|
|
7816
|
+
}, {
|
|
7817
|
+
readonly name: "filter";
|
|
7818
|
+
readonly type: "string";
|
|
7819
|
+
readonly required: false;
|
|
7820
|
+
readonly description: "Optional resource filter; projects supports state = \"active\" or state = \"deleted\".";
|
|
7821
|
+
}, {
|
|
7822
|
+
readonly name: "order_by";
|
|
7823
|
+
readonly type: "string";
|
|
7824
|
+
readonly required: false;
|
|
7825
|
+
readonly description: "Optional ordering expression; projects supports updateTime desc.";
|
|
7826
|
+
}];
|
|
7827
|
+
}, {
|
|
7828
|
+
readonly resource: "cut.projects";
|
|
7829
|
+
readonly method: "create";
|
|
7830
|
+
readonly summary: "Create project";
|
|
7831
|
+
readonly description: "Create a blank editing project in the API key organization before writing a script. First obtain accessible library ids from praxis.media; bindings must include exactly one read_write library with default_upload true. Each call creates a new project and returns HTTP 201; save its id for execute, state and timeline calls. All editing positions use seconds.";
|
|
7832
|
+
readonly http: "POST";
|
|
7833
|
+
readonly path: "/cut/v1/projects";
|
|
7834
|
+
readonly streaming: "no";
|
|
7835
|
+
readonly pagination: false;
|
|
7836
|
+
readonly pathParams: readonly [];
|
|
7837
|
+
readonly query: readonly [];
|
|
7838
|
+
readonly body: {
|
|
7839
|
+
readonly required: true;
|
|
7840
|
+
readonly fields: readonly [{
|
|
7841
|
+
readonly name: "name";
|
|
7842
|
+
readonly type: "string";
|
|
7843
|
+
readonly required: true;
|
|
7844
|
+
readonly description: "Human-readable project name; required and must contain non-whitespace text.";
|
|
7845
|
+
}, {
|
|
7846
|
+
readonly name: "labels";
|
|
7847
|
+
readonly type: "object";
|
|
7848
|
+
readonly required: false;
|
|
7849
|
+
readonly description: "User-defined string labels for organizing projects; label keys retain their original spelling.";
|
|
7850
|
+
}, {
|
|
7851
|
+
readonly name: "settings";
|
|
7852
|
+
readonly type: "object";
|
|
7853
|
+
readonly required: true;
|
|
7854
|
+
readonly description: "Dimensions and frame rate for a new editing project.";
|
|
7855
|
+
}, {
|
|
7856
|
+
readonly name: "bindings";
|
|
7857
|
+
readonly type: "array";
|
|
7858
|
+
readonly itemType: "object";
|
|
7859
|
+
readonly required: true;
|
|
7860
|
+
readonly description: "Accessible library bindings; exactly one read_write entry must have default_upload true.";
|
|
7861
|
+
}];
|
|
7862
|
+
};
|
|
7863
|
+
}, {
|
|
7864
|
+
readonly resource: "cut.projects";
|
|
7865
|
+
readonly method: "delete";
|
|
7866
|
+
readonly summary: "Delete project";
|
|
7867
|
+
readonly description: "Soft-delete a project selected from projects.list. The project is retained for seven days until purge_time and can be restored with undelete before that deadline. Deleted projects cannot be edited; list with filter state = \"deleted\" to locate retained projects.";
|
|
7868
|
+
readonly http: "DELETE";
|
|
7869
|
+
readonly path: "/cut/v1/projects/{project_id}";
|
|
7870
|
+
readonly streaming: "no";
|
|
7871
|
+
readonly pagination: false;
|
|
7872
|
+
readonly pathParams: readonly [{
|
|
7873
|
+
readonly name: "project_id";
|
|
7874
|
+
readonly sdkName: "project_id";
|
|
7875
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
7876
|
+
}];
|
|
7877
|
+
readonly query: readonly [];
|
|
7878
|
+
}, {
|
|
7879
|
+
readonly resource: "cut.projects";
|
|
7880
|
+
readonly method: "retrieve";
|
|
7881
|
+
readonly summary: "Retrieve project";
|
|
7882
|
+
readonly description: "Inspect project metadata, settings and library bindings before editing. Copy id from projects.create or list; expand=timeline,exports,versions includes selected related resources. The expanded timeline uses seconds and the returned revision can guard a later execute call with expected_revision.";
|
|
7883
|
+
readonly http: "GET";
|
|
7884
|
+
readonly path: "/cut/v1/projects/{project_id}";
|
|
7885
|
+
readonly streaming: "no";
|
|
7886
|
+
readonly pagination: false;
|
|
7887
|
+
readonly pathParams: readonly [{
|
|
7888
|
+
readonly name: "project_id";
|
|
7889
|
+
readonly sdkName: "project_id";
|
|
7890
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
7891
|
+
}];
|
|
7892
|
+
readonly query: readonly [{
|
|
7893
|
+
readonly name: "expand";
|
|
7894
|
+
readonly type: "string";
|
|
7895
|
+
readonly required: false;
|
|
7896
|
+
readonly description: "Comma-separated expansions: timeline includes clips, exports includes render jobs, versions includes saved snapshots.";
|
|
7897
|
+
}];
|
|
7898
|
+
}, {
|
|
7899
|
+
readonly resource: "cut.projects";
|
|
7900
|
+
readonly method: "update";
|
|
7901
|
+
readonly summary: "Update project metadata";
|
|
7902
|
+
readonly description: "Change the project display name or replace its labels by naming those fields in update_mask. Use execute for clip or track edits. Each successful update commits a new revision; labels are replaced as a whole when selected, so read and merge existing labels before overwriting them.";
|
|
7903
|
+
readonly http: "PATCH";
|
|
7904
|
+
readonly path: "/cut/v1/projects/{project_id}";
|
|
7905
|
+
readonly streaming: "no";
|
|
7906
|
+
readonly pagination: false;
|
|
7907
|
+
readonly pathParams: readonly [{
|
|
7908
|
+
readonly name: "project_id";
|
|
7909
|
+
readonly sdkName: "project_id";
|
|
7910
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
7911
|
+
}];
|
|
7912
|
+
readonly query: readonly [];
|
|
7913
|
+
readonly body: {
|
|
7914
|
+
readonly required: true;
|
|
7915
|
+
readonly fields: readonly [{
|
|
7916
|
+
readonly name: "name";
|
|
7917
|
+
readonly type: "string";
|
|
7918
|
+
readonly required: false;
|
|
7919
|
+
readonly description: "Replacement display name when update_mask includes name.";
|
|
7920
|
+
}, {
|
|
7921
|
+
readonly name: "labels";
|
|
7922
|
+
readonly type: "object";
|
|
7923
|
+
readonly required: false;
|
|
7924
|
+
readonly description: "User-defined string labels for organizing projects; label keys retain their original spelling.";
|
|
7925
|
+
}, {
|
|
7926
|
+
readonly name: "update_mask";
|
|
7927
|
+
readonly type: "array";
|
|
7928
|
+
readonly itemType: "string";
|
|
7929
|
+
readonly enum: readonly ["name", "labels"];
|
|
7930
|
+
readonly required: true;
|
|
7931
|
+
readonly description: "Metadata fields to replace; name changes the display name and labels replaces all labels.";
|
|
7932
|
+
}];
|
|
7933
|
+
};
|
|
7934
|
+
}, {
|
|
7935
|
+
readonly resource: "cut.projects.analysis";
|
|
7936
|
+
readonly method: "create";
|
|
7937
|
+
readonly summary: "Analyze project media";
|
|
7938
|
+
readonly description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible.";
|
|
7939
|
+
readonly http: "POST";
|
|
7940
|
+
readonly path: "/cut/v1/projects/{project_id}/analysis";
|
|
7941
|
+
readonly streaming: "no";
|
|
7942
|
+
readonly pagination: false;
|
|
7943
|
+
readonly pathParams: readonly [{
|
|
7944
|
+
readonly name: "project_id";
|
|
7945
|
+
readonly sdkName: "project_id";
|
|
7946
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
7947
|
+
}];
|
|
7948
|
+
readonly query: readonly [];
|
|
7949
|
+
readonly body: {
|
|
7950
|
+
readonly required: true;
|
|
7951
|
+
readonly fields: readonly [{
|
|
7952
|
+
readonly name: "media";
|
|
7953
|
+
readonly type: "array";
|
|
7954
|
+
readonly itemType: "object";
|
|
7955
|
+
readonly required: false;
|
|
7956
|
+
readonly description: "Bound-library assets to analyze; omission selects project media.";
|
|
7957
|
+
}, {
|
|
7958
|
+
readonly name: "kinds";
|
|
7959
|
+
readonly type: "array";
|
|
7960
|
+
readonly itemType: "string";
|
|
7961
|
+
readonly enum: readonly ["silence", "filler", "scenes"];
|
|
7962
|
+
readonly required: true;
|
|
7963
|
+
readonly description: "Analysis types to request for the selected source assets.";
|
|
7964
|
+
}];
|
|
7965
|
+
};
|
|
7966
|
+
}, {
|
|
7967
|
+
readonly resource: "cut.projects.bindings";
|
|
7968
|
+
readonly method: "list";
|
|
7969
|
+
readonly summary: "List library bindings";
|
|
7970
|
+
readonly description: "Discover the named media libraries available to this project before selecting source assets or an import/export destination. read bindings supply source assets; read_write bindings also accept uploads. Exactly one writable binding supplies the default upload destination.";
|
|
7971
|
+
readonly http: "GET";
|
|
7972
|
+
readonly path: "/cut/v1/projects/{project_id}/bindings";
|
|
7973
|
+
readonly streaming: "no";
|
|
7974
|
+
readonly pagination: false;
|
|
7975
|
+
readonly pathParams: readonly [{
|
|
7976
|
+
readonly name: "project_id";
|
|
7977
|
+
readonly sdkName: "project_id";
|
|
7978
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
7979
|
+
}];
|
|
7980
|
+
readonly query: readonly [];
|
|
7981
|
+
}, {
|
|
7982
|
+
readonly resource: "cut.projects.bindings";
|
|
7983
|
+
readonly method: "create";
|
|
7984
|
+
readonly summary: "Bind media library";
|
|
7985
|
+
readonly description: "Attach an accessible media library to an existing project under a unique name. Obtain library_id from praxis.media and choose read for source-only access or read_write for imports and exports. The project must retain exactly one read_write binding with default_upload true after the change.";
|
|
7986
|
+
readonly http: "POST";
|
|
7987
|
+
readonly path: "/cut/v1/projects/{project_id}/bindings";
|
|
7988
|
+
readonly streaming: "no";
|
|
7989
|
+
readonly pagination: false;
|
|
7990
|
+
readonly pathParams: readonly [{
|
|
7991
|
+
readonly name: "project_id";
|
|
7992
|
+
readonly sdkName: "project_id";
|
|
7993
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
7994
|
+
}];
|
|
7995
|
+
readonly query: readonly [];
|
|
7996
|
+
readonly body: {
|
|
7997
|
+
readonly required: true;
|
|
7998
|
+
readonly fields: readonly [{
|
|
7999
|
+
readonly name: "binding";
|
|
8000
|
+
readonly type: "object";
|
|
8001
|
+
readonly required: true;
|
|
8002
|
+
readonly description: "A named project link to a media library. Exactly one read_write binding must be default_upload.";
|
|
8003
|
+
}];
|
|
8004
|
+
};
|
|
8005
|
+
}, {
|
|
8006
|
+
readonly resource: "cut.projects.bindings";
|
|
8007
|
+
readonly method: "delete";
|
|
8008
|
+
readonly summary: "Remove library binding";
|
|
8009
|
+
readonly description: "Detach a library alias obtained from bindings.list after removing all timeline clips that reference its library. BINDING_IN_USE returns 409 while references remain; inspect timeline and edit those clips first. Removal must preserve the one writable default upload binding.";
|
|
8010
|
+
readonly http: "DELETE";
|
|
8011
|
+
readonly path: "/cut/v1/projects/{project_id}/bindings/{name}";
|
|
8012
|
+
readonly streaming: "no";
|
|
8013
|
+
readonly pagination: false;
|
|
8014
|
+
readonly pathParams: readonly [{
|
|
8015
|
+
readonly name: "project_id";
|
|
8016
|
+
readonly sdkName: "project_id";
|
|
8017
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
8018
|
+
}, {
|
|
8019
|
+
readonly name: "name";
|
|
8020
|
+
readonly sdkName: "name";
|
|
8021
|
+
readonly description: "Project-local binding alias from bindings.list; detach only after removing all clips that reference its library.";
|
|
8022
|
+
}];
|
|
8023
|
+
readonly query: readonly [];
|
|
8024
|
+
}, {
|
|
8025
|
+
readonly resource: "cut.projects.exports";
|
|
8026
|
+
readonly method: "list";
|
|
8027
|
+
readonly summary: "List project exports";
|
|
8028
|
+
readonly description: "Find export jobs associated with this project before polling or canceling a render. Copy an export id into praxis.cut.exports.retrieve or cancel. Continue with next_page_token as page_token when present; queued or in-progress jobs have not produced a final media asset.";
|
|
8029
|
+
readonly http: "GET";
|
|
8030
|
+
readonly path: "/cut/v1/projects/{project_id}/exports";
|
|
8031
|
+
readonly streaming: "no";
|
|
8032
|
+
readonly pagination: false;
|
|
8033
|
+
readonly pathParams: readonly [{
|
|
8034
|
+
readonly name: "project_id";
|
|
8035
|
+
readonly sdkName: "project_id";
|
|
8036
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
8037
|
+
}];
|
|
8038
|
+
readonly query: readonly [{
|
|
8039
|
+
readonly name: "page_size";
|
|
8040
|
+
readonly type: "integer";
|
|
8041
|
+
readonly required: false;
|
|
8042
|
+
readonly description: "Maximum resources in one page, from 1 to 100; defaults to 50.";
|
|
8043
|
+
}, {
|
|
8044
|
+
readonly name: "page_token";
|
|
8045
|
+
readonly type: "string";
|
|
8046
|
+
readonly required: false;
|
|
8047
|
+
readonly description: "Opaque next_page_token from the preceding page; omit on the first request.";
|
|
8048
|
+
}, {
|
|
8049
|
+
readonly name: "filter";
|
|
8050
|
+
readonly type: "string";
|
|
8051
|
+
readonly required: false;
|
|
8052
|
+
readonly description: "Optional resource filter; projects supports state = \"active\" or state = \"deleted\".";
|
|
8053
|
+
}, {
|
|
8054
|
+
readonly name: "order_by";
|
|
8055
|
+
readonly type: "string";
|
|
8056
|
+
readonly required: false;
|
|
8057
|
+
readonly description: "Optional ordering expression; projects supports updateTime desc.";
|
|
8058
|
+
}];
|
|
8059
|
+
}, {
|
|
8060
|
+
readonly resource: "cut.projects.exports";
|
|
8061
|
+
readonly method: "create";
|
|
8062
|
+
readonly summary: "Create video export";
|
|
8063
|
+
readonly description: "Start an asynchronous video export from the project into a writable bound media library. Choose binding from bindings.list or omit it for default_upload, and optionally select revision and output settings. HTTP 202 only accepts the job; poll praxis.cut.exports.retrieve using the returned id until status is done, failed or canceled. On done, asset identifies the video written back to praxis.media. Each call starts a job, so retrieve a known job before retrying a submission.";
|
|
8064
|
+
readonly http: "POST";
|
|
8065
|
+
readonly path: "/cut/v1/projects/{project_id}/exports";
|
|
8066
|
+
readonly streaming: "no";
|
|
8067
|
+
readonly pagination: false;
|
|
8068
|
+
readonly pathParams: readonly [{
|
|
8069
|
+
readonly name: "project_id";
|
|
8070
|
+
readonly sdkName: "project_id";
|
|
8071
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
8072
|
+
}];
|
|
8073
|
+
readonly query: readonly [];
|
|
8074
|
+
readonly body: {
|
|
8075
|
+
readonly required: true;
|
|
8076
|
+
readonly fields: readonly [{
|
|
8077
|
+
readonly name: "output";
|
|
8078
|
+
readonly type: "object";
|
|
8079
|
+
readonly required: false;
|
|
8080
|
+
readonly description: "Rendering options for an exported video.";
|
|
8081
|
+
}, {
|
|
8082
|
+
readonly name: "binding";
|
|
8083
|
+
readonly type: "string";
|
|
8084
|
+
readonly required: false;
|
|
8085
|
+
readonly description: "Writable binding name used as the export destination; omission uses default_upload.";
|
|
8086
|
+
}, {
|
|
8087
|
+
readonly name: "revision";
|
|
8088
|
+
readonly type: "integer";
|
|
8089
|
+
readonly required: false;
|
|
8090
|
+
readonly description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write.";
|
|
8091
|
+
}];
|
|
8092
|
+
};
|
|
8093
|
+
}, {
|
|
8094
|
+
readonly resource: "cut.projects.frames";
|
|
8095
|
+
readonly method: "list";
|
|
8096
|
+
readonly summary: "Render preview frames";
|
|
8097
|
+
readonly description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Fetch the returned image URLs before expires_at; render again when they expire.";
|
|
8098
|
+
readonly http: "GET";
|
|
8099
|
+
readonly path: "/cut/v1/projects/{project_id}/frames";
|
|
8100
|
+
readonly streaming: "no";
|
|
8101
|
+
readonly pagination: false;
|
|
8102
|
+
readonly pathParams: readonly [{
|
|
8103
|
+
readonly name: "project_id";
|
|
8104
|
+
readonly sdkName: "project_id";
|
|
8105
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
8106
|
+
}];
|
|
8107
|
+
readonly query: readonly [{
|
|
8108
|
+
readonly name: "at";
|
|
8109
|
+
readonly type: "string";
|
|
8110
|
+
readonly required: true;
|
|
8111
|
+
readonly description: "Required comma-separated non-negative project times in seconds, for example 12,15.5.";
|
|
8112
|
+
}, {
|
|
8113
|
+
readonly name: "scale";
|
|
8114
|
+
readonly type: "number";
|
|
8115
|
+
readonly required: false;
|
|
8116
|
+
readonly description: "Positive image size multiplier; 0.5 renders at half the project dimensions.";
|
|
8117
|
+
}, {
|
|
8118
|
+
readonly name: "revision";
|
|
8119
|
+
readonly type: "integer";
|
|
8120
|
+
readonly required: false;
|
|
8121
|
+
readonly description: "Optional committed project revision from state or execute; omission selects the current revision.";
|
|
8122
|
+
}];
|
|
8123
|
+
}, {
|
|
8124
|
+
readonly resource: "cut.projects.media";
|
|
8125
|
+
readonly method: "import";
|
|
8126
|
+
readonly summary: "Import project media";
|
|
8127
|
+
readonly description: "Import a URL, data URI or existing file into a writable project media library. Select binding from bindings.list or omit it to use default_upload. Save library_id and asset_id from the result and use them as libraryId and assetId inside execute script media references; overwrites follow the source asset latest version.";
|
|
8128
|
+
readonly http: "POST";
|
|
8129
|
+
readonly path: "/cut/v1/projects/{project_id}/media:import";
|
|
8130
|
+
readonly streaming: "no";
|
|
8131
|
+
readonly pagination: false;
|
|
8132
|
+
readonly pathParams: readonly [{
|
|
8133
|
+
readonly name: "project_id";
|
|
8134
|
+
readonly sdkName: "project_id";
|
|
8135
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
8136
|
+
}];
|
|
8137
|
+
readonly query: readonly [];
|
|
8138
|
+
readonly body: {
|
|
8139
|
+
readonly required: true;
|
|
8140
|
+
readonly fields: readonly [{
|
|
8141
|
+
readonly name: "binding";
|
|
8142
|
+
readonly type: "string";
|
|
8143
|
+
readonly required: false;
|
|
8144
|
+
readonly description: "Writable binding name from project bindings; omission uses default_upload.";
|
|
8145
|
+
}, {
|
|
8146
|
+
readonly name: "source";
|
|
8147
|
+
readonly type: "object";
|
|
8148
|
+
readonly required: true;
|
|
8149
|
+
readonly description: "Exactly one input source for the imported asset.";
|
|
8150
|
+
}, {
|
|
8151
|
+
readonly name: "display_name";
|
|
8152
|
+
readonly type: "string";
|
|
8153
|
+
readonly required: false;
|
|
8154
|
+
readonly description: "Optional human-readable display name for the new media asset.";
|
|
8155
|
+
}];
|
|
8156
|
+
};
|
|
8157
|
+
}, {
|
|
8158
|
+
readonly resource: "cut.projects";
|
|
8159
|
+
readonly method: "retrieveState";
|
|
8160
|
+
readonly summary: "Read editing state";
|
|
8161
|
+
readonly description: "Read lightweight project context before composing an execute script. Returns current revision, rendering settings, track counts, library bindings and offline media count without individual clips. For complete clip documents or a selected time range, read timeline instead.";
|
|
8162
|
+
readonly http: "GET";
|
|
8163
|
+
readonly path: "/cut/v1/projects/{project_id}/state";
|
|
8164
|
+
readonly streaming: "no";
|
|
8165
|
+
readonly pagination: false;
|
|
8166
|
+
readonly pathParams: readonly [{
|
|
8167
|
+
readonly name: "project_id";
|
|
8168
|
+
readonly sdkName: "project_id";
|
|
8169
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
8170
|
+
}];
|
|
8171
|
+
readonly query: readonly [];
|
|
8172
|
+
}, {
|
|
8173
|
+
readonly resource: "cut.projects";
|
|
8174
|
+
readonly method: "retrieveTimeline";
|
|
8175
|
+
readonly summary: "Read project timeline";
|
|
8176
|
+
readonly description: "Inspect clips and markers in a selected project range before editing. view=full returns structured tracks with all timeline positions in seconds; view=compact returns compact text for script context. from and to are seconds and tracks limits the selection to comma-separated track ids from state. Concurrent changes while preparing a full timeline return 409; retrieve the latest state and try the read again.";
|
|
8177
|
+
readonly http: "GET";
|
|
8178
|
+
readonly path: "/cut/v1/projects/{project_id}/timeline";
|
|
8179
|
+
readonly streaming: "no";
|
|
8180
|
+
readonly pagination: false;
|
|
8181
|
+
readonly pathParams: readonly [{
|
|
8182
|
+
readonly name: "project_id";
|
|
8183
|
+
readonly sdkName: "project_id";
|
|
8184
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
8185
|
+
}];
|
|
8186
|
+
readonly query: readonly [{
|
|
8187
|
+
readonly name: "view";
|
|
8188
|
+
readonly type: "string";
|
|
8189
|
+
readonly enum: readonly ["full", "compact"];
|
|
8190
|
+
readonly required: false;
|
|
8191
|
+
readonly description: "full returns structured clips; compact returns compact textual editing context.";
|
|
8192
|
+
}, {
|
|
8193
|
+
readonly name: "from";
|
|
8194
|
+
readonly type: "number";
|
|
8195
|
+
readonly required: false;
|
|
8196
|
+
readonly description: "Optional start of the selected project range in seconds; omit for the beginning.";
|
|
8197
|
+
}, {
|
|
8198
|
+
readonly name: "to";
|
|
8199
|
+
readonly type: "number";
|
|
8200
|
+
readonly required: false;
|
|
8201
|
+
readonly description: "Optional end of the selected project range in seconds; omit for the end.";
|
|
8202
|
+
}, {
|
|
8203
|
+
readonly name: "tracks";
|
|
8204
|
+
readonly type: "string";
|
|
8205
|
+
readonly required: false;
|
|
8206
|
+
readonly description: "Comma-separated track ids from state to include; omit to include every track.";
|
|
8207
|
+
}];
|
|
8208
|
+
}, {
|
|
8209
|
+
readonly resource: "cut.projects.versions";
|
|
8210
|
+
readonly method: "list";
|
|
8211
|
+
readonly summary: "List saved versions";
|
|
8212
|
+
readonly description: "Find saved timeline snapshots for this project and obtain version_id values for restore. A saved version records its original revision; restoring it creates a new current revision rather than rewinding the revision counter. Continue with next_page_token as page_token until absent.";
|
|
8213
|
+
readonly http: "GET";
|
|
8214
|
+
readonly path: "/cut/v1/projects/{project_id}/versions";
|
|
8215
|
+
readonly streaming: "no";
|
|
8216
|
+
readonly pagination: false;
|
|
8217
|
+
readonly pathParams: readonly [{
|
|
8218
|
+
readonly name: "project_id";
|
|
8219
|
+
readonly sdkName: "project_id";
|
|
8220
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
8221
|
+
}];
|
|
8222
|
+
readonly query: readonly [{
|
|
8223
|
+
readonly name: "page_size";
|
|
8224
|
+
readonly type: "integer";
|
|
8225
|
+
readonly required: false;
|
|
8226
|
+
readonly description: "Maximum resources in one page, from 1 to 100; defaults to 50.";
|
|
8227
|
+
}, {
|
|
8228
|
+
readonly name: "page_token";
|
|
8229
|
+
readonly type: "string";
|
|
8230
|
+
readonly required: false;
|
|
8231
|
+
readonly description: "Opaque next_page_token from the preceding page; omit on the first request.";
|
|
8232
|
+
}, {
|
|
8233
|
+
readonly name: "filter";
|
|
8234
|
+
readonly type: "string";
|
|
8235
|
+
readonly required: false;
|
|
8236
|
+
readonly description: "Optional resource filter; projects supports state = \"active\" or state = \"deleted\".";
|
|
8237
|
+
}, {
|
|
8238
|
+
readonly name: "order_by";
|
|
8239
|
+
readonly type: "string";
|
|
8240
|
+
readonly required: false;
|
|
8241
|
+
readonly description: "Optional ordering expression; projects supports updateTime desc.";
|
|
8242
|
+
}];
|
|
8243
|
+
}, {
|
|
8244
|
+
readonly resource: "cut.projects.versions";
|
|
8245
|
+
readonly method: "create";
|
|
8246
|
+
readonly summary: "Save project version";
|
|
8247
|
+
readonly description: "Save the current project timeline as a named recovery point before a substantial edit. Supply an optional label or send an empty object; keep the returned version id for versions.restore. Saving a version does not publish a rendered asset; use projects.exports.create for video output.";
|
|
8248
|
+
readonly http: "POST";
|
|
8249
|
+
readonly path: "/cut/v1/projects/{project_id}/versions";
|
|
8250
|
+
readonly streaming: "no";
|
|
8251
|
+
readonly pagination: false;
|
|
8252
|
+
readonly pathParams: readonly [{
|
|
8253
|
+
readonly name: "project_id";
|
|
8254
|
+
readonly sdkName: "project_id";
|
|
8255
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
8256
|
+
}];
|
|
8257
|
+
readonly query: readonly [];
|
|
8258
|
+
readonly body: {
|
|
8259
|
+
readonly required: true;
|
|
8260
|
+
readonly fields: readonly [{
|
|
8261
|
+
readonly name: "label";
|
|
8262
|
+
readonly type: "string";
|
|
8263
|
+
readonly required: false;
|
|
8264
|
+
readonly description: "Human-readable snapshot label, such as Before captions.";
|
|
8265
|
+
}];
|
|
8266
|
+
};
|
|
8267
|
+
}, {
|
|
8268
|
+
readonly resource: "cut.projects";
|
|
8269
|
+
readonly method: "execute";
|
|
8270
|
+
readonly summary: "Execute editing script";
|
|
8271
|
+
readonly description: "Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Use AddTrack, Insert, Update, Delete, Split, Trim, Move, RippleDeleteRange, UpdateTrack, DeleteTrack, SetSettings, AddCaptionsFromTranscript and SetMarker for writes; GetTimeline, GetItem, FindItems, GetMedia, GetTranscript and GetAnalysis read editing context; Print emits text and Preview requests frame previews. All script times are seconds; script object fields use camelCase, for example `media: {libraryId, assetId}`. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project:\n\n```js\nconst t = AddTrack(\"video\");\nInsert(t, {type: \"color\", color: \"#123456\", start: 0, length: 3});\nPrint(t);\n```";
|
|
8272
|
+
readonly http: "POST";
|
|
8273
|
+
readonly path: "/cut/v1/projects/{project_id}:execute";
|
|
8274
|
+
readonly streaming: "no";
|
|
8275
|
+
readonly pagination: false;
|
|
8276
|
+
readonly pathParams: readonly [{
|
|
8277
|
+
readonly name: "project_id";
|
|
8278
|
+
readonly sdkName: "project_id";
|
|
8279
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
8280
|
+
}];
|
|
8281
|
+
readonly query: readonly [];
|
|
8282
|
+
readonly body: {
|
|
8283
|
+
readonly required: true;
|
|
8284
|
+
readonly fields: readonly [{
|
|
8285
|
+
readonly name: "script";
|
|
8286
|
+
readonly type: "string";
|
|
8287
|
+
readonly required: false;
|
|
8288
|
+
readonly description: "Synchronous editing source using Cut execute functions; submit this or edit_id, never both. Script source is opaque: function names and object fields inside JavaScript use their documented camelCase spelling.";
|
|
8289
|
+
}, {
|
|
8290
|
+
readonly name: "edit_id";
|
|
8291
|
+
readonly type: "string";
|
|
8292
|
+
readonly required: false;
|
|
8293
|
+
readonly description: "Saved failed script identifier from error.details.edit_id; valid for ten minutes.";
|
|
8294
|
+
}, {
|
|
8295
|
+
readonly name: "edits";
|
|
8296
|
+
readonly type: "array";
|
|
8297
|
+
readonly itemType: "object";
|
|
8298
|
+
readonly required: false;
|
|
8299
|
+
readonly description: "Literal replacements applied to the saved source before rerunning.";
|
|
8300
|
+
}, {
|
|
8301
|
+
readonly name: "expected_revision";
|
|
8302
|
+
readonly type: "integer";
|
|
8303
|
+
readonly required: false;
|
|
8304
|
+
readonly description: "Committed project revision from retrieve, state, timeline or execute; increases after each successful write.";
|
|
8305
|
+
}];
|
|
8306
|
+
};
|
|
8307
|
+
}, {
|
|
8308
|
+
readonly resource: "cut.projects";
|
|
8309
|
+
readonly method: "undelete";
|
|
8310
|
+
readonly summary: "Restore deleted project";
|
|
8311
|
+
readonly description: "Return a retained deleted project to active state before its purge_time. Obtain project_id from projects.list filtered to deleted projects. This restores the project, not an older timeline revision; use versions.restore when reverting editing content.";
|
|
8312
|
+
readonly http: "POST";
|
|
8313
|
+
readonly path: "/cut/v1/projects/{project_id}:undelete";
|
|
8314
|
+
readonly streaming: "no";
|
|
8315
|
+
readonly pagination: false;
|
|
8316
|
+
readonly pathParams: readonly [{
|
|
8317
|
+
readonly name: "project_id";
|
|
8318
|
+
readonly sdkName: "project_id";
|
|
8319
|
+
readonly description: "Project identifier returned by its create or list operation; use the id, not a display name.";
|
|
8320
|
+
}];
|
|
8321
|
+
readonly query: readonly [];
|
|
8322
|
+
}, {
|
|
8323
|
+
readonly resource: "cut.versions";
|
|
8324
|
+
readonly method: "restore";
|
|
8325
|
+
readonly summary: "Restore saved version";
|
|
8326
|
+
readonly description: "Replace current editing content with a saved project snapshot selected from projects.versions.list. The restore commits a new transaction and revision while preserving the saved version for future use. Inspect the returned summary and timeline before further editing; a response revision conflict can follow a committed restore, so retrieve current state before retrying.";
|
|
8327
|
+
readonly http: "POST";
|
|
8328
|
+
readonly path: "/cut/v1/versions/{version_id}:restore";
|
|
8329
|
+
readonly streaming: "no";
|
|
8330
|
+
readonly pagination: false;
|
|
8331
|
+
readonly pathParams: readonly [{
|
|
8332
|
+
readonly name: "version_id";
|
|
8333
|
+
readonly sdkName: "version_id";
|
|
8334
|
+
readonly description: "Version identifier returned by its create or list operation; use the id, not a display name.";
|
|
8335
|
+
}];
|
|
8336
|
+
readonly query: readonly [];
|
|
8337
|
+
}, {
|
|
8338
|
+
readonly resource: "database.databases";
|
|
8339
|
+
readonly method: "list";
|
|
8340
|
+
readonly summary: "List databases";
|
|
8341
|
+
readonly description: "Find databases owned by your tenant and obtain their ids for schema or row operations. Excludes deleting by default. status=active or status=deleting selects that state; invalid values return 400 INVALID_PARAMS.";
|
|
8342
|
+
readonly http: "GET";
|
|
8343
|
+
readonly path: "/database/v1/databases";
|
|
8344
|
+
readonly streaming: "no";
|
|
8345
|
+
readonly pagination: true;
|
|
8346
|
+
readonly pathParams: readonly [];
|
|
8347
|
+
readonly query: readonly [{
|
|
8348
|
+
readonly name: "cursor";
|
|
8349
|
+
readonly type: "string";
|
|
8350
|
+
readonly required: false;
|
|
8351
|
+
readonly description: "Opaque next_cursor from the previous page.";
|
|
8352
|
+
}, {
|
|
8353
|
+
readonly name: "limit";
|
|
8354
|
+
readonly type: "integer";
|
|
8355
|
+
readonly required: false;
|
|
8356
|
+
readonly description: "Page size.";
|
|
8357
|
+
}, {
|
|
8358
|
+
readonly name: "labels";
|
|
8359
|
+
readonly type: "object";
|
|
8360
|
+
readonly required: false;
|
|
8361
|
+
readonly description: "Exact label match, encoded as labels[purpose]=docs.";
|
|
8362
|
+
}, {
|
|
8363
|
+
readonly name: "status";
|
|
8364
|
+
readonly type: "string";
|
|
8365
|
+
readonly enum: readonly ["active", "deleting"];
|
|
8366
|
+
readonly required: false;
|
|
8367
|
+
readonly description: "Filter by lifecycle state. active (the default when omitted) lists usable databases; deleting lists databases that were deleted and are still inside the seven-day restore window. Any other value returns 400 INVALID_PARAMS.";
|
|
8368
|
+
}];
|
|
8369
|
+
}, {
|
|
8370
|
+
readonly resource: "database.databases";
|
|
8371
|
+
readonly method: "create";
|
|
8372
|
+
readonly summary: "Create database";
|
|
8373
|
+
readonly description: "Creates an empty database for the caller and returns it with status active (HTTP 201); add tables next with praxis.database.databases.tables.create. name is required and is 1–64 visible characters after trimming. labels are optional string tags (at most 64; each key starts with a lowercase letter and uses up to 63 characters of a-z 0-9 _ -; each value is up to 63 characters of a-z 0-9 _ -) that databaseListDatabases can filter on. If initialization fails the call returns 503 CAPACITY and the half-created database is left with status failed; retry by calling create again, which makes a new database. Unlike Supabase, this creates a SQLite-backed database without a PostgreSQL connection or SQL execution endpoint. Use a Praxis credential; access is scoped to its tenant, not to Supabase Auth users or RLS policies.";
|
|
8374
|
+
readonly http: "POST";
|
|
8375
|
+
readonly path: "/database/v1/databases";
|
|
8376
|
+
readonly streaming: "no";
|
|
8377
|
+
readonly pagination: false;
|
|
8378
|
+
readonly pathParams: readonly [];
|
|
8379
|
+
readonly query: readonly [];
|
|
8380
|
+
readonly body: {
|
|
8381
|
+
readonly required: true;
|
|
8382
|
+
readonly fields: readonly [{
|
|
8383
|
+
readonly name: "name";
|
|
8384
|
+
readonly type: "string";
|
|
8385
|
+
readonly required: true;
|
|
8386
|
+
readonly description: "Display name for the database: 1–64 visible characters after trimming; control characters are rejected. It is not an identifier, so later calls still use the returned id.";
|
|
8387
|
+
}, {
|
|
8388
|
+
readonly name: "labels";
|
|
8389
|
+
readonly type: "object";
|
|
8390
|
+
readonly required: false;
|
|
8391
|
+
readonly description: "Optional string tags to attach, at most 64. Each key starts with a lowercase letter and may use up to 63 characters of a-z 0-9 _ -; each value is up to 63 characters of a-z 0-9 _ -. List calls filter on exact key and value pairs.";
|
|
8392
|
+
}];
|
|
8393
|
+
};
|
|
8394
|
+
}, {
|
|
8395
|
+
readonly resource: "database.databases";
|
|
8396
|
+
readonly method: "delete";
|
|
8397
|
+
readonly summary: "Delete database";
|
|
8398
|
+
readonly description: "Soft-delete a database when it should stop accepting schema and row operations. Idempotently enters deleting with a seven-day purge_at. GET remains available; child operations return 409 until restored.";
|
|
8399
|
+
readonly http: "DELETE";
|
|
8400
|
+
readonly path: "/database/v1/databases/{database_id}";
|
|
8401
|
+
readonly streaming: "no";
|
|
8402
|
+
readonly pagination: false;
|
|
8403
|
+
readonly pathParams: readonly [{
|
|
8404
|
+
readonly name: "database_id";
|
|
8405
|
+
readonly sdkName: "database_id";
|
|
8406
|
+
readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
|
|
8407
|
+
}];
|
|
8408
|
+
readonly query: readonly [];
|
|
8409
|
+
}, {
|
|
8410
|
+
readonly resource: "database.databases";
|
|
8411
|
+
readonly method: "retrieve";
|
|
8412
|
+
readonly summary: "Get database";
|
|
8413
|
+
readonly description: "Returns one database by id, including a database in the deleting state (purge_at then shows when it will be permanently removed). Call it before table or row operations to confirm status is active: schema and row calls on a deleting database return 409 DATABASE_INVALID_STATE. size_bytes is refreshed from live storage at most once every five seconds. A purged or unknown id returns 404 DATABASE_NOT_FOUND.";
|
|
8414
|
+
readonly http: "GET";
|
|
8415
|
+
readonly path: "/database/v1/databases/{database_id}";
|
|
8416
|
+
readonly streaming: "no";
|
|
8417
|
+
readonly pagination: false;
|
|
8418
|
+
readonly pathParams: readonly [{
|
|
8419
|
+
readonly name: "database_id";
|
|
8420
|
+
readonly sdkName: "database_id";
|
|
8421
|
+
readonly description: "Identifier of the database to act on: the id (db_…) returned by databaseCreateDatabase or databaseListDatabases. A display name is not accepted.";
|
|
8422
|
+
}];
|
|
8423
|
+
readonly query: readonly [];
|
|
8424
|
+
}, {
|
|
8425
|
+
readonly resource: "database.databases";
|
|
5858
8426
|
readonly method: "update";
|
|
5859
8427
|
readonly summary: "Update database";
|
|
5860
8428
|
readonly description: "Renames an active database and/or replaces its labels; send only the keys you want to change. labels is replaced as a whole, not merged, so include every label you want to keep. A body without name or labels, or with values equal to the current ones, changes nothing and leaves updated_at as is. A database in the deleting state returns 409 DATABASE_INVALID_STATE; restore it first with databaseRestoreDatabase.";
|
|
@@ -6596,7 +9164,7 @@ export declare const operations: readonly [{
|
|
|
6596
9164
|
readonly resource: "file.files";
|
|
6597
9165
|
readonly method: "create";
|
|
6598
9166
|
readonly summary: "Upload file";
|
|
6599
|
-
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
|
|
9167
|
+
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 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–7776000). Without expiry, the file persists until deleted.";
|
|
6600
9168
|
readonly http: "POST";
|
|
6601
9169
|
readonly path: "/file/v1/files";
|
|
6602
9170
|
readonly streaming: "no";
|
|
@@ -6614,19 +9182,14 @@ export declare const operations: readonly [{
|
|
|
6614
9182
|
}, {
|
|
6615
9183
|
readonly name: "purpose";
|
|
6616
9184
|
readonly type: "string";
|
|
6617
|
-
readonly enum: readonly ["user_data", "
|
|
9185
|
+
readonly enum: readonly ["user_data", "vision"];
|
|
6618
9186
|
readonly required: true;
|
|
6619
|
-
readonly description: "Purpose label stored with the file: user_data
|
|
9187
|
+
readonly description: "Purpose label stored with the file: user_data or vision. The vision purpose accepts only PNG, JPEG, GIF and WebP images. Conversation image references require user_data.";
|
|
6620
9188
|
}, {
|
|
6621
9189
|
readonly name: "expires_after";
|
|
6622
9190
|
readonly type: "object";
|
|
6623
9191
|
readonly required: false;
|
|
6624
9192
|
readonly description: "Optional expiry relative to created_at. Files without an expiry persist until deleted.";
|
|
6625
|
-
}, {
|
|
6626
|
-
readonly name: "praxis";
|
|
6627
|
-
readonly type: "object";
|
|
6628
|
-
readonly required: false;
|
|
6629
|
-
readonly description: "Own-face extensions. Use at most one expiry setting.";
|
|
6630
9193
|
}];
|
|
6631
9194
|
};
|
|
6632
9195
|
}, {
|
|
@@ -6674,11 +9237,59 @@ export declare const operations: readonly [{
|
|
|
6674
9237
|
readonly description: "ID of a tenant-owned live file, as returned by upload or list; starts with file-.";
|
|
6675
9238
|
}];
|
|
6676
9239
|
readonly query: readonly [];
|
|
9240
|
+
}, {
|
|
9241
|
+
readonly resource: "file.files.contentLinks";
|
|
9242
|
+
readonly method: "revoke";
|
|
9243
|
+
readonly summary: "Revoke a file content link";
|
|
9244
|
+
readonly description: "Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within 30 seconds; the file and other links remain available. Only current IAM capability tokens can be revoked; legacy content links expire at the migration deadline. Example body: {\"token\":\"<token from /c/>\"}.";
|
|
9245
|
+
readonly http: "POST";
|
|
9246
|
+
readonly path: "/file/v1/files/{file_id}/content_links:revoke";
|
|
9247
|
+
readonly streaming: "no";
|
|
9248
|
+
readonly pagination: false;
|
|
9249
|
+
readonly pathParams: readonly [{
|
|
9250
|
+
readonly name: "file_id";
|
|
9251
|
+
readonly sdkName: "file_id";
|
|
9252
|
+
readonly description: "Tenant-owned file identifier returned by file creation or listing; the token must name this same file.";
|
|
9253
|
+
}];
|
|
9254
|
+
readonly query: readonly [];
|
|
9255
|
+
readonly body: {
|
|
9256
|
+
readonly required: true;
|
|
9257
|
+
readonly fields: readonly [{
|
|
9258
|
+
readonly name: "token";
|
|
9259
|
+
readonly type: "string";
|
|
9260
|
+
readonly required: true;
|
|
9261
|
+
readonly description: "Signed token taken from the /c/ path component of a previously issued file content URL, without the host or /c/ prefix.";
|
|
9262
|
+
}];
|
|
9263
|
+
};
|
|
9264
|
+
}, {
|
|
9265
|
+
readonly resource: "file.files.contentUrl";
|
|
9266
|
+
readonly method: "create";
|
|
9267
|
+
readonly summary: "Create a download URL";
|
|
9268
|
+
readonly description: "Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to 3600 seconds and is at most 604800 seconds. Issuance requires the same credential and file-read access as files.retrieveContent; a processing file returns 409 FILE_NOT_READY, so poll files.retrieve until active before retrying. A missing, expired or other-organization file returns 404. Each issuance creates a new link. OpenAI Files has no signed download URL; this follows S3 presigned GET semantics. Example body: {\"ttl_seconds\":3600}.";
|
|
9269
|
+
readonly http: "POST";
|
|
9270
|
+
readonly path: "/file/v1/files/{file_id}/content_url";
|
|
9271
|
+
readonly streaming: "no";
|
|
9272
|
+
readonly pagination: false;
|
|
9273
|
+
readonly pathParams: readonly [{
|
|
9274
|
+
readonly name: "file_id";
|
|
9275
|
+
readonly sdkName: "file_id";
|
|
9276
|
+
readonly description: "Tenant-owned live file identifier from file creation or listing; the file must be active to issue a download URL.";
|
|
9277
|
+
}];
|
|
9278
|
+
readonly query: readonly [];
|
|
9279
|
+
readonly body: {
|
|
9280
|
+
readonly required: false;
|
|
9281
|
+
readonly fields: readonly [{
|
|
9282
|
+
readonly name: "ttl_seconds";
|
|
9283
|
+
readonly type: "integer";
|
|
9284
|
+
readonly required: false;
|
|
9285
|
+
readonly description: "Download link lifetime in seconds, from 1 through 604800; omitted means 3600. This does not change the file's own expiry.";
|
|
9286
|
+
}];
|
|
9287
|
+
};
|
|
6677
9288
|
}, {
|
|
6678
9289
|
readonly resource: "file.uploads";
|
|
6679
9290
|
readonly method: "create";
|
|
6680
9291
|
readonly summary: "Create an upload";
|
|
6681
|
-
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
|
|
9292
|
+
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 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.";
|
|
6682
9293
|
readonly http: "POST";
|
|
6683
9294
|
readonly path: "/file/v1/uploads";
|
|
6684
9295
|
readonly streaming: "no";
|
|
@@ -6705,9 +9316,9 @@ export declare const operations: readonly [{
|
|
|
6705
9316
|
}, {
|
|
6706
9317
|
readonly name: "purpose";
|
|
6707
9318
|
readonly type: "string";
|
|
6708
|
-
readonly enum: readonly ["user_data", "
|
|
9319
|
+
readonly enum: readonly ["user_data", "vision"];
|
|
6709
9320
|
readonly required: true;
|
|
6710
|
-
readonly description: "Use user_data for conversation attachments,
|
|
9321
|
+
readonly description: "Use user_data for conversation attachments, or vision for PNG, JPEG, GIF and WebP images.";
|
|
6711
9322
|
}, {
|
|
6712
9323
|
readonly name: "expires_after";
|
|
6713
9324
|
readonly type: "object";
|
|
@@ -6720,6 +9331,52 @@ export declare const operations: readonly [{
|
|
|
6720
9331
|
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.";
|
|
6721
9332
|
}];
|
|
6722
9333
|
};
|
|
9334
|
+
}, {
|
|
9335
|
+
readonly resource: "file.uploads";
|
|
9336
|
+
readonly method: "createSigned";
|
|
9337
|
+
readonly summary: "Create a one-time upload URL";
|
|
9338
|
+
readonly description: "Upload a local file of up to 2 GiB from a coding agent without sending bytes through the model. Provide basename, exact byte count and MIME type. Up to 104857600 bytes, PUT the file to url with curl -T photo.png -H 'Content-Type: image/png' '<url>'; success returns 201 with the file object, and reuse returns 410 CAPABILITY_USED. Above that threshold, split the file into part_size chunks (default 64000000 bytes), PUT each chunk to its numbered parts[].url in any order, then POST complete_url without a body. Part PUTs return 200; completion returns 201 with the file object, including its state, or 400 if a part is missing. A processing file can be polled with files.retrieve until active. Identical part bytes may be retried; changed bytes at the same number return 400. Completion reuse returns 410 CAPABILITY_USED. Each PUT requires the exact signed Content-Length; single-PUT Content-Type must match content_type or be omitted. Expired, revoked, invalid, wrong-action or cross-organization URLs return 404. URL lifetime defaults to 900 seconds for single PUT or 3600 for multipart, at most 604800; all multipart URLs share an expiry. Multipart creation reserves storage quota. Issuance requires the same unscoped credential as direct file creation. Each issuance creates a new upload and is not idempotent. Example body: {\"filename\":\"photo.png\",\"bytes\":2048,\"content_type\":\"image/png\"}.";
|
|
9339
|
+
readonly http: "POST";
|
|
9340
|
+
readonly path: "/file/v1/uploads/signed";
|
|
9341
|
+
readonly streaming: "no";
|
|
9342
|
+
readonly pagination: false;
|
|
9343
|
+
readonly pathParams: readonly [];
|
|
9344
|
+
readonly query: readonly [];
|
|
9345
|
+
readonly body: {
|
|
9346
|
+
readonly required: true;
|
|
9347
|
+
readonly fields: readonly [{
|
|
9348
|
+
readonly name: "filename";
|
|
9349
|
+
readonly type: "string";
|
|
9350
|
+
readonly required: true;
|
|
9351
|
+
readonly description: "Stored basename, 1–255 UTF-8 bytes without control characters or path separators.";
|
|
9352
|
+
}, {
|
|
9353
|
+
readonly name: "bytes";
|
|
9354
|
+
readonly type: "integer";
|
|
9355
|
+
readonly required: true;
|
|
9356
|
+
readonly description: "Exact local file size in bytes, from 1 through 2147483648 (2 GiB). Up to 104857600 bytes returns one PUT URL; larger files return numbered part URLs and a completion URL. Every PUT requires its exact signed Content-Length.";
|
|
9357
|
+
}, {
|
|
9358
|
+
readonly name: "content_type";
|
|
9359
|
+
readonly type: "string";
|
|
9360
|
+
readonly required: true;
|
|
9361
|
+
readonly description: "Declared MIME type, such as image/png. In single-PUT mode, send exactly this Content-Type or omit it. Stored file metadata is detected from the bytes in both modes.";
|
|
9362
|
+
}, {
|
|
9363
|
+
readonly name: "purpose";
|
|
9364
|
+
readonly type: "string";
|
|
9365
|
+
readonly enum: readonly ["user_data", "vision"];
|
|
9366
|
+
readonly required: false;
|
|
9367
|
+
readonly description: "user_data stores ordinary files and conversation images; vision accepts PNG, JPEG, GIF or WebP images only. Omitted means user_data.";
|
|
9368
|
+
}, {
|
|
9369
|
+
readonly name: "expires_in";
|
|
9370
|
+
readonly type: "integer";
|
|
9371
|
+
readonly required: false;
|
|
9372
|
+
readonly description: "Lifetime in seconds, from 1 through 604800: defaults to 900 for single PUT or 3600 for multipart. All part URLs and the completion URL share one expiry. This does not set the resulting file's lifetime.";
|
|
9373
|
+
}, {
|
|
9374
|
+
readonly name: "part_size";
|
|
9375
|
+
readonly type: "integer";
|
|
9376
|
+
readonly required: false;
|
|
9377
|
+
readonly description: "Fixed multipart chunk size in bytes, from 5242880 through 64000000; defaults to 64000000. Used only above 104857600 total bytes. The final part contains the remaining bytes; single-PUT mode keeps its existing response.";
|
|
9378
|
+
}];
|
|
9379
|
+
};
|
|
6723
9380
|
}, {
|
|
6724
9381
|
readonly resource: "file.uploads";
|
|
6725
9382
|
readonly method: "cancel";
|
|
@@ -6837,7 +9494,7 @@ export declare const operations: readonly [{
|
|
|
6837
9494
|
readonly resource: "knowledge.vectorStores";
|
|
6838
9495
|
readonly method: "create";
|
|
6839
9496
|
readonly summary: "Create knowledge base";
|
|
6840
|
-
readonly description: "Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded.
|
|
9497
|
+
readonly description: "Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. Each file accepts up to 52428800 bytes and 5000000 estimated tokens; each account holds up to 100 active/nondeleted stores. Minimal body: {\"name\":\"Refund policies\"}.";
|
|
6841
9498
|
readonly http: "POST";
|
|
6842
9499
|
readonly path: "/knowledge/v1/vector_stores";
|
|
6843
9500
|
readonly streaming: "no";
|
|
@@ -6881,7 +9538,7 @@ export declare const operations: readonly [{
|
|
|
6881
9538
|
readonly name: "models";
|
|
6882
9539
|
readonly type: "object";
|
|
6883
9540
|
readonly required: false;
|
|
6884
|
-
readonly description: "Model roles to set. The model must exist in the model catalog and serve the role (embedding → openai.embeddings, rerank → cohere.rerank, query_rewrite → openai.chat.completions). The embedding model must output 1024-dimension vectors. Omitted roles stay unchanged; null restores all defaults. Unknown roles or empty IDs return 400 INVALID_PARAMS. The OpenAI-compatible API rejects this field with 400.";
|
|
9541
|
+
readonly description: "Model roles to set. The model must exist in the model catalog and serve the role (embedding → openai.embeddings, rerank → cohere.rerank, query_rewrite → openai.chat.completions, ocr → mistral.ocr or pdf_input capability, vision → vision capability). The embedding model must output 1024-dimension vectors. Omitted roles stay unchanged; null restores all defaults. Unknown roles or empty IDs return 400 INVALID_PARAMS. The OpenAI-compatible API rejects this field with 400.";
|
|
6885
9542
|
}];
|
|
6886
9543
|
};
|
|
6887
9544
|
}, {
|
|
@@ -6964,7 +9621,7 @@ export declare const operations: readonly [{
|
|
|
6964
9621
|
readonly name: "models";
|
|
6965
9622
|
readonly type: "object";
|
|
6966
9623
|
readonly required: false;
|
|
6967
|
-
readonly description: "Model roles to set. The model must exist in the model catalog and serve the role (embedding → openai.embeddings, rerank → cohere.rerank, query_rewrite → openai.chat.completions). The embedding model must output 1024-dimension vectors. Omitted roles stay unchanged; null restores all defaults. Unknown roles or empty IDs return 400 INVALID_PARAMS. The OpenAI-compatible API rejects this field with 400.";
|
|
9624
|
+
readonly description: "Model roles to set. The model must exist in the model catalog and serve the role (embedding → openai.embeddings, rerank → cohere.rerank, query_rewrite → openai.chat.completions, ocr → mistral.ocr or pdf_input capability, vision → vision capability). The embedding model must output 1024-dimension vectors. Omitted roles stay unchanged; null restores all defaults. Unknown roles or empty IDs return 400 INVALID_PARAMS. The OpenAI-compatible API rejects this field with 400.";
|
|
6968
9625
|
}];
|
|
6969
9626
|
};
|
|
6970
9627
|
}, {
|
|
@@ -7141,7 +9798,7 @@ export declare const operations: readonly [{
|
|
|
7141
9798
|
readonly resource: "knowledge.vectorStores.files";
|
|
7142
9799
|
readonly method: "create";
|
|
7143
9800
|
readonly summary: "Add file";
|
|
7144
|
-
readonly description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching.
|
|
9801
|
+
readonly description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching. Each file accepts up to 52428800 bytes and 5000000 estimated tokens; chunk sizes use estimated tokens rather than a model tokenizer. Text, Markdown, CSV, JSON, HTML, PDF, DOCX, PPTX, XLSX and PNG/JPEG/GIF/WebP images can be extracted; audio and video uploads are not knowledge documents. Images may yield generated descriptions rather than verbatim OCR. auto chunking resolves to static 800/400; explicit sizes are 100–4096 with overlap at most half the size. Each store holds at most 10000 attached files. Reattaching the same file returns its existing record without applying new attributes or chunking; inspect last_error after failure.";
|
|
7145
9802
|
readonly http: "POST";
|
|
7146
9803
|
readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files";
|
|
7147
9804
|
readonly streaming: "no";
|
|
@@ -7657,7 +10314,7 @@ export declare const operations: readonly [{
|
|
|
7657
10314
|
readonly name: "overwrite";
|
|
7658
10315
|
readonly type: "boolean";
|
|
7659
10316
|
readonly required: false;
|
|
7660
|
-
readonly description: "Allow replacing an existing public_id, preserving its asset_id and increasing its version. False returns the existing resource without replacing it; defaults to true.";
|
|
10317
|
+
readonly description: "Allow replacing an existing public_id, preserving its asset_id and increasing its version. Only the latest version is deliverable; old version URLs return 404. Create a new public_id to retain old deliveries. False returns the existing resource without replacing it; defaults to true.";
|
|
7661
10318
|
}, {
|
|
7662
10319
|
readonly name: "tags";
|
|
7663
10320
|
readonly type: "object";
|
|
@@ -7679,6 +10336,12 @@ export declare const operations: readonly [{
|
|
|
7679
10336
|
readonly enum: readonly ["image", "video", "raw", "auto"];
|
|
7680
10337
|
readonly required: false;
|
|
7681
10338
|
readonly description: "Upload category: image for images, video for video or audio, raw for unprocessed files, or auto to detect the category. Defaults to auto.";
|
|
10339
|
+
}, {
|
|
10340
|
+
readonly name: "type";
|
|
10341
|
+
readonly type: "string";
|
|
10342
|
+
readonly enum: readonly ["upload", "authenticated"];
|
|
10343
|
+
readonly required: false;
|
|
10344
|
+
readonly description: "Asset delivery mode: upload is public; authenticated requires a signed URL or delivery token for originals and derivatives. private is unsupported.";
|
|
7682
10345
|
}];
|
|
7683
10346
|
};
|
|
7684
10347
|
}, {
|
|
@@ -7702,6 +10365,7 @@ export declare const operations: readonly [{
|
|
|
7702
10365
|
readonly name: "file_id";
|
|
7703
10366
|
readonly type: "string";
|
|
7704
10367
|
readonly required: true;
|
|
10368
|
+
readonly description: "File ID to copy into this library instead of file bytes. This independent copy defaults to public delivery; set type=authenticated for private delivery. Deleting the source File does not delete this asset.";
|
|
7705
10369
|
}, {
|
|
7706
10370
|
readonly name: "public_id";
|
|
7707
10371
|
readonly type: "string";
|
|
@@ -7746,7 +10410,7 @@ export declare const operations: readonly [{
|
|
|
7746
10410
|
readonly name: "overwrite";
|
|
7747
10411
|
readonly type: "boolean";
|
|
7748
10412
|
readonly required: false;
|
|
7749
|
-
readonly description: "Allow replacing an existing public_id, preserving its asset_id and increasing its version. False returns the existing resource without replacing it; defaults to true.";
|
|
10413
|
+
readonly description: "Allow replacing an existing public_id, preserving its asset_id and increasing its version. Only the latest version is deliverable; old version URLs return 404. Create a new public_id to retain old deliveries. False returns the existing resource without replacing it; defaults to true.";
|
|
7750
10414
|
}, {
|
|
7751
10415
|
readonly name: "tags";
|
|
7752
10416
|
readonly type: "object";
|
|
@@ -7768,6 +10432,12 @@ export declare const operations: readonly [{
|
|
|
7768
10432
|
readonly enum: readonly ["image", "video", "raw", "auto"];
|
|
7769
10433
|
readonly required: false;
|
|
7770
10434
|
readonly description: "Upload category: image for images, video for video or audio, raw for unprocessed files, or auto to detect the category. Defaults to auto.";
|
|
10435
|
+
}, {
|
|
10436
|
+
readonly name: "type";
|
|
10437
|
+
readonly type: "string";
|
|
10438
|
+
readonly enum: readonly ["upload", "authenticated"];
|
|
10439
|
+
readonly required: false;
|
|
10440
|
+
readonly description: "Asset delivery mode: upload is public; authenticated requires a signed URL or delivery token for originals and derivatives. private is unsupported.";
|
|
7771
10441
|
}];
|
|
7772
10442
|
};
|
|
7773
10443
|
}, {
|
|
@@ -7989,6 +10659,35 @@ export declare const operations: readonly [{
|
|
|
7989
10659
|
readonly description: "Batch identifier returned by createBatch or batchAssets; resolved within this library.";
|
|
7990
10660
|
}];
|
|
7991
10661
|
readonly query: readonly [];
|
|
10662
|
+
}, {
|
|
10663
|
+
readonly resource: "media.libraries.deliveryTokens";
|
|
10664
|
+
readonly method: "create";
|
|
10665
|
+
readonly summary: "Create delivery token";
|
|
10666
|
+
readonly description: "Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is 3600 seconds; narrow acl and expires_in before sharing. Anyone holding the token can read matching paths until expires_at.";
|
|
10667
|
+
readonly http: "POST";
|
|
10668
|
+
readonly path: "/media/v1/libraries/{library_id}/delivery_tokens";
|
|
10669
|
+
readonly streaming: "no";
|
|
10670
|
+
readonly pagination: false;
|
|
10671
|
+
readonly pathParams: readonly [{
|
|
10672
|
+
readonly name: "library_id";
|
|
10673
|
+
readonly sdkName: "library_id";
|
|
10674
|
+
readonly description: "Library ID returned by creation.";
|
|
10675
|
+
}];
|
|
10676
|
+
readonly query: readonly [];
|
|
10677
|
+
readonly body: {
|
|
10678
|
+
readonly required: true;
|
|
10679
|
+
readonly fields: readonly [{
|
|
10680
|
+
readonly name: "acl";
|
|
10681
|
+
readonly type: "string";
|
|
10682
|
+
readonly required: false;
|
|
10683
|
+
readonly description: "Delivery path glob restricted to the library path prefix (a slash, library_id, then a slash). Defaults to that prefix followed by *; * matches any path text. Tildes and control characters are rejected.";
|
|
10684
|
+
}, {
|
|
10685
|
+
readonly name: "expires_in";
|
|
10686
|
+
readonly type: "integer";
|
|
10687
|
+
readonly required: false;
|
|
10688
|
+
readonly description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 3600.";
|
|
10689
|
+
}];
|
|
10690
|
+
};
|
|
7992
10691
|
}, {
|
|
7993
10692
|
readonly resource: "media.libraries.events";
|
|
7994
10693
|
readonly method: "list";
|
|
@@ -8155,7 +10854,7 @@ export declare const operations: readonly [{
|
|
|
8155
10854
|
readonly name: "expression";
|
|
8156
10855
|
readonly type: "string";
|
|
8157
10856
|
readonly required: false;
|
|
8158
|
-
readonly description: "Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets.";
|
|
10857
|
+
readonly description: "Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets. For business metadata use context.sku=KETTLE-RED AND context.revision=2; request with_field: [\"context\"] to include context.";
|
|
8159
10858
|
}, {
|
|
8160
10859
|
readonly name: "sort_by";
|
|
8161
10860
|
readonly type: "array";
|
|
@@ -8267,6 +10966,54 @@ export declare const operations: readonly [{
|
|
|
8267
10966
|
readonly description: "Expression filter restricting eligible result assets.";
|
|
8268
10967
|
}];
|
|
8269
10968
|
};
|
|
10969
|
+
}, {
|
|
10970
|
+
readonly resource: "meta.docs";
|
|
10971
|
+
readonly method: "search";
|
|
10972
|
+
readonly summary: "Search platform documentation";
|
|
10973
|
+
readonly description: "Find guides and references by keyword before reading them with praxis.meta.docs.retrieve. Public; no API key required. Matches documentation titles, headings and page text without case sensitivity; all query words must occur. q is required; limit defaults to 20 and accepts 1–50. lang defaults to zh or use en for English. Returns paths, page titles, canonical URLs and short matching snippets; no matches returns an empty array.";
|
|
10974
|
+
readonly http: "GET";
|
|
10975
|
+
readonly path: "/meta/v1/docs/search";
|
|
10976
|
+
readonly streaming: "no";
|
|
10977
|
+
readonly pagination: false;
|
|
10978
|
+
readonly pathParams: readonly [];
|
|
10979
|
+
readonly query: readonly [{
|
|
10980
|
+
readonly name: "q";
|
|
10981
|
+
readonly type: "string";
|
|
10982
|
+
readonly required: true;
|
|
10983
|
+
readonly description: "Keywords describing the syntax or guide needed, for example export or workflow.";
|
|
10984
|
+
}, {
|
|
10985
|
+
readonly name: "limit";
|
|
10986
|
+
readonly type: "integer";
|
|
10987
|
+
readonly required: false;
|
|
10988
|
+
readonly description: "Maximum number of matching pages returned; integer 1–50, default 20.";
|
|
10989
|
+
}, {
|
|
10990
|
+
readonly name: "lang";
|
|
10991
|
+
readonly type: "string";
|
|
10992
|
+
readonly enum: readonly ["zh", "en"];
|
|
10993
|
+
readonly required: false;
|
|
10994
|
+
readonly description: "Documentation language: zh for Chinese (default), en for English.";
|
|
10995
|
+
}];
|
|
10996
|
+
}, {
|
|
10997
|
+
readonly resource: "meta.docs";
|
|
10998
|
+
readonly method: "retrieve";
|
|
10999
|
+
readonly summary: "Read documentation Markdown";
|
|
11000
|
+
readonly description: "Read a platform guide or reference before implementing an unfamiliar capability. Public; no API key required. Take path from praxis.meta.docs.search, or use developers/automation/guides/write-workflow. Append #heading-id to path to read only that section, including its subsections. Encode the hash as %23 over HTTP; SDK callers pass it in the path string. lang defaults to zh; en selects the English page. Unknown pages or anchors return DOC_NOT_FOUND; search again for a valid path.";
|
|
11001
|
+
readonly http: "GET";
|
|
11002
|
+
readonly path: "/meta/v1/docs/{path}";
|
|
11003
|
+
readonly streaming: "no";
|
|
11004
|
+
readonly pagination: false;
|
|
11005
|
+
readonly pathParams: readonly [{
|
|
11006
|
+
readonly name: "path";
|
|
11007
|
+
readonly sdkName: "path";
|
|
11008
|
+
readonly description: "Slash-separated documentation path from docs.search; optionally append #heading-id to select a section.";
|
|
11009
|
+
}];
|
|
11010
|
+
readonly query: readonly [{
|
|
11011
|
+
readonly name: "lang";
|
|
11012
|
+
readonly type: "string";
|
|
11013
|
+
readonly enum: readonly ["zh", "en"];
|
|
11014
|
+
readonly required: false;
|
|
11015
|
+
readonly description: "Documentation language: zh for Chinese (default), en for English.";
|
|
11016
|
+
}];
|
|
8270
11017
|
}, {
|
|
8271
11018
|
readonly resource: "meta.health";
|
|
8272
11019
|
readonly method: "retrieve";
|
|
@@ -9346,7 +12093,7 @@ export declare const operations: readonly [{
|
|
|
9346
12093
|
readonly name: "supported_api";
|
|
9347
12094
|
readonly type: "array";
|
|
9348
12095
|
readonly itemType: "string";
|
|
9349
|
-
readonly enum: readonly ["anthropic.messages", "cohere.rerank", "google.generateContent", "mistral.ocr", "openai.audio.speech", "openai.audio.transcriptions", "openai.chat.completions", "openai.embeddings", "openai.images.edits", "openai.images.generations", "openai.responses", "openai.videos"];
|
|
12096
|
+
readonly enum: readonly ["anthropic.messages", "cohere.rerank", "google.generateContent", "mistral.ocr", "openai.audio.speech", "openai.audio.transcriptions", "openai.chat.completions", "openai.embeddings", "openai.images.edits", "openai.images.generations", "openai.responses", "openai.videos", "typesafe.systemone"];
|
|
9350
12097
|
readonly required: false;
|
|
9351
12098
|
readonly description: "Match any comma-separated declared protocol ID; omitted or empty includes all models. Combined with type and output_modalities using AND. Invalid IDs return 400 with all legal values.";
|
|
9352
12099
|
}, {
|
|
@@ -9804,6 +12551,41 @@ export declare const operations: readonly [{
|
|
|
9804
12551
|
readonly description: "Id of the stored response, the `id` returned by createResponse (it looks like resp_...). An unknown id, a response created with store false, an expired response and another tenant's response all answer 404.";
|
|
9805
12552
|
}];
|
|
9806
12553
|
readonly query: readonly [];
|
|
12554
|
+
}, {
|
|
12555
|
+
readonly resource: "model.systemone";
|
|
12556
|
+
readonly method: "create";
|
|
12557
|
+
readonly summary: "Ask structured decision questions";
|
|
12558
|
+
readonly description: "Ask typed questions about a state and get calibrated probabilities instead of generated text. Same request and response as TypeSafe System One. Use model ids from model.models.list declaring typesafe.systemone. Send one or more noul, choice or score questions; answers use the same question ids. Input tokens are charged at the catalog input price; output tokens are free. usage.cost and X-Praxis-Cost-Usd expose the same customer charge in USD. box questions and assets are unsupported and return 400: images are not supported. Unknown top-level fields pass unchanged to the native upstream.";
|
|
12559
|
+
readonly http: "POST";
|
|
12560
|
+
readonly path: "/model/v1/systemone";
|
|
12561
|
+
readonly streaming: "no";
|
|
12562
|
+
readonly pagination: false;
|
|
12563
|
+
readonly pathParams: readonly [];
|
|
12564
|
+
readonly query: readonly [];
|
|
12565
|
+
readonly body: {
|
|
12566
|
+
readonly required: true;
|
|
12567
|
+
readonly fields: readonly [{
|
|
12568
|
+
readonly name: "model";
|
|
12569
|
+
readonly type: "string";
|
|
12570
|
+
readonly required: true;
|
|
12571
|
+
readonly description: "Published model id from model.models.list with supported_apis containing typesafe.systemone; returned unchanged in the response.";
|
|
12572
|
+
}, {
|
|
12573
|
+
readonly name: "state";
|
|
12574
|
+
readonly type: "object";
|
|
12575
|
+
readonly required: true;
|
|
12576
|
+
readonly description: "Shared content evaluated by every question, supplied as text, a JSON object or an array.";
|
|
12577
|
+
}, {
|
|
12578
|
+
readonly name: "questions";
|
|
12579
|
+
readonly type: "object";
|
|
12580
|
+
readonly required: true;
|
|
12581
|
+
readonly description: "Non-empty map of caller-chosen question ids to typed questions; answers preserve these ids. noul evaluates yes/no, choice selects a named option, score rates ordered levels. box is unsupported.";
|
|
12582
|
+
}, {
|
|
12583
|
+
readonly name: "assets";
|
|
12584
|
+
readonly type: "object";
|
|
12585
|
+
readonly required: false;
|
|
12586
|
+
readonly description: "Unsupported image assets. Supplying this field, including null or an empty collection, returns 400: images are not supported.";
|
|
12587
|
+
}];
|
|
12588
|
+
};
|
|
9807
12589
|
}, {
|
|
9808
12590
|
readonly resource: "model.videos";
|
|
9809
12591
|
readonly method: "list";
|
|
@@ -10849,7 +13631,7 @@ export declare const operations: readonly [{
|
|
|
10849
13631
|
readonly resource: "sandbox.sandboxes.commands";
|
|
10850
13632
|
readonly method: "run";
|
|
10851
13633
|
readonly summary: "Run a command in the sandbox";
|
|
10852
|
-
readonly description: "Execute a shell command and wait for stdout, stderr and exitCode. Supply cmd, optional cwd and envs, and timeoutMs (1–
|
|
13634
|
+
readonly description: "Execute a shell command and wait for stdout, stderr and exitCode. Supply cmd, optional cwd and envs, and timeoutMs (1–3600000 milliseconds, default 600000, that is 10 minutes; E2B defaults to 60000). Unlike E2B, this endpoint is synchronous only: no background mode, callbacks or unlimited timeout (timeoutMs 0); output is bounded to 1 MiB including stream framing. Nonzero exit codes return 200 with the result. A timeout returns COMMAND_TIMEOUT (504); transport timeout does not confirm process termination, so do not blindly retry commands with side effects. Example body: {\"cmd\":\"echo hi\"}.";
|
|
10853
13635
|
readonly http: "POST";
|
|
10854
13636
|
readonly path: "/sandbox/v1/sandboxes/{sandbox_id}/commands";
|
|
10855
13637
|
readonly streaming: "no";
|
|
@@ -10867,6 +13649,11 @@ export declare const operations: readonly [{
|
|
|
10867
13649
|
readonly type: "string";
|
|
10868
13650
|
readonly required: true;
|
|
10869
13651
|
readonly description: "Shell command to execute, for example echo hi.";
|
|
13652
|
+
}, {
|
|
13653
|
+
readonly name: "background";
|
|
13654
|
+
readonly type: "boolean";
|
|
13655
|
+
readonly required: false;
|
|
13656
|
+
readonly description: "When true, return 202 with the pid as soon as the process starts; it keeps running after the request ends. Read its status and output with GET /sandbox/v1/sandboxes/{sandbox_id}/commands/{pid}, stop it with DELETE. Same idea as E2B background commands.";
|
|
10870
13657
|
}, {
|
|
10871
13658
|
readonly name: "cwd";
|
|
10872
13659
|
readonly type: "string";
|
|
@@ -10881,7 +13668,7 @@ export declare const operations: readonly [{
|
|
|
10881
13668
|
readonly name: "timeoutMs";
|
|
10882
13669
|
readonly type: "integer";
|
|
10883
13670
|
readonly required: false;
|
|
10884
|
-
readonly description: "Execution timeout in milliseconds, from 1 to
|
|
13671
|
+
readonly description: "Execution timeout in milliseconds, from 1 to 3600000 (1 hour); defaults to 600000 (10 minutes). In background mode this limits process runtime; expiry records exit code 124.";
|
|
10885
13672
|
}];
|
|
10886
13673
|
};
|
|
10887
13674
|
}, {
|
|
@@ -11043,7 +13830,7 @@ export declare const operations: readonly [{
|
|
|
11043
13830
|
readonly resource: "sandbox.templates";
|
|
11044
13831
|
readonly method: "list";
|
|
11045
13832
|
readonly summary: "List templates (v2)";
|
|
11046
|
-
readonly description: "List
|
|
13833
|
+
readonly description: "List official templates and all your custom templates, including waiting, building, ready and error builds. Custom templates appear first; each custom row describes its latest build, not necessarily the current ready build. Use templateID for build management and a ready template name when creating a sandbox. Own-face official distinguishes public catalog entries; sourceKind is omitted until a source is submitted and on official templates. Other organizations' templates are invisible.";
|
|
11047
13834
|
readonly http: "GET";
|
|
11048
13835
|
readonly path: "/sandbox/v1/templates";
|
|
11049
13836
|
readonly streaming: "no";
|
|
@@ -11053,8 +13840,171 @@ export declare const operations: readonly [{
|
|
|
11053
13840
|
readonly name: "teamID";
|
|
11054
13841
|
readonly type: "string";
|
|
11055
13842
|
readonly required: false;
|
|
11056
|
-
readonly description: "
|
|
13843
|
+
readonly description: "Upstream team selector; Praxis always lists the authenticated organization's templates.";
|
|
13844
|
+
}, {
|
|
13845
|
+
readonly name: "nextToken";
|
|
13846
|
+
readonly type: "string";
|
|
13847
|
+
readonly required: false;
|
|
13848
|
+
readonly description: "Cursor to start the list from";
|
|
11057
13849
|
}, {
|
|
13850
|
+
readonly name: "limit";
|
|
13851
|
+
readonly type: "integer";
|
|
13852
|
+
readonly required: false;
|
|
13853
|
+
readonly description: "Maximum number of items to return per page";
|
|
13854
|
+
}];
|
|
13855
|
+
}, {
|
|
13856
|
+
readonly resource: "sandbox.templates";
|
|
13857
|
+
readonly method: "create";
|
|
13858
|
+
readonly summary: "Create template (v3)";
|
|
13859
|
+
readonly description: "Reserve a waiting build before submitting its source. Reusing a name in your organization allocates a new build on the same template. Returns templateID and buildID; start it with templates.builds.update, then poll templates.builds.status.list. A name:tag suffix and tags are assigned after successful publication. Example: {\"name\":\"my-template\",\"cpuCount\":2,\"memoryMB\":2048}. The own face also accepts diskGb, a positive integer defaulting to 10 GiB.";
|
|
13860
|
+
readonly http: "POST";
|
|
13861
|
+
readonly path: "/sandbox/v1/templates";
|
|
13862
|
+
readonly streaming: "no";
|
|
13863
|
+
readonly pagination: false;
|
|
13864
|
+
readonly pathParams: readonly [];
|
|
13865
|
+
readonly query: readonly [];
|
|
13866
|
+
readonly body: {
|
|
13867
|
+
readonly required: true;
|
|
13868
|
+
readonly fields: readonly [{
|
|
13869
|
+
readonly name: "name";
|
|
13870
|
+
readonly type: "string";
|
|
13871
|
+
readonly required: false;
|
|
13872
|
+
readonly description: "Name of the template. Can include a tag with colon separator (e.g. \"my-template\" or \"my-template:v1\"). If tag is included, it will be treated as if the tag was provided in the tags array.";
|
|
13873
|
+
}, {
|
|
13874
|
+
readonly name: "tags";
|
|
13875
|
+
readonly type: "array";
|
|
13876
|
+
readonly itemType: "string";
|
|
13877
|
+
readonly required: false;
|
|
13878
|
+
readonly description: "Tags to assign to the template build";
|
|
13879
|
+
}, {
|
|
13880
|
+
readonly name: "alias";
|
|
13881
|
+
readonly type: "string";
|
|
13882
|
+
readonly required: false;
|
|
13883
|
+
readonly description: "Alias of the template. Deprecated, use name instead.";
|
|
13884
|
+
}, {
|
|
13885
|
+
readonly name: "teamID";
|
|
13886
|
+
readonly type: "string";
|
|
13887
|
+
readonly required: false;
|
|
13888
|
+
readonly description: "Identifier of the team";
|
|
13889
|
+
}, {
|
|
13890
|
+
readonly name: "cpuCount";
|
|
13891
|
+
readonly type: "integer";
|
|
13892
|
+
readonly required: false;
|
|
13893
|
+
readonly description: "Requested virtual CPU count; a positive integer, default 2 for template builds.";
|
|
13894
|
+
}, {
|
|
13895
|
+
readonly name: "memoryMB";
|
|
13896
|
+
readonly type: "integer";
|
|
13897
|
+
readonly required: false;
|
|
13898
|
+
readonly description: "Requested build memory in MiB; a positive integer, default 1024.";
|
|
13899
|
+
}, {
|
|
13900
|
+
readonly name: "minFreeDiskMb";
|
|
13901
|
+
readonly type: "integer";
|
|
13902
|
+
readonly required: false;
|
|
13903
|
+
readonly description: "Upstream minimum free disk request in MiB; use the native diskGb field to set the build disk size.";
|
|
13904
|
+
}, {
|
|
13905
|
+
readonly name: "diskGb";
|
|
13906
|
+
readonly type: "integer";
|
|
13907
|
+
readonly required: false;
|
|
13908
|
+
readonly description: "Build disk size in GiB, a positive safe integer. Defaults to 10; available only on the own face.";
|
|
13909
|
+
}];
|
|
13910
|
+
};
|
|
13911
|
+
}, {
|
|
13912
|
+
readonly resource: "sandbox.templates.aliases";
|
|
13913
|
+
readonly method: "retrieve";
|
|
13914
|
+
readonly summary: "Check template alias";
|
|
13915
|
+
readonly description: "Resolve a name within your organization to its templateID before reading or managing builds. Use the bare template name, without a :tag suffix. Unknown and other-organization names return 404. The response public field is false for your private templates.";
|
|
13916
|
+
readonly http: "GET";
|
|
13917
|
+
readonly path: "/sandbox/v1/templates/aliases/{alias}";
|
|
13918
|
+
readonly streaming: "no";
|
|
13919
|
+
readonly pagination: false;
|
|
13920
|
+
readonly pathParams: readonly [{
|
|
13921
|
+
readonly name: "alias";
|
|
13922
|
+
readonly sdkName: "alias";
|
|
13923
|
+
readonly description: "Bare template name belonging to your organization, without a tag or provider namespace.";
|
|
13924
|
+
}];
|
|
13925
|
+
readonly query: readonly [];
|
|
13926
|
+
}, {
|
|
13927
|
+
readonly resource: "sandbox.templates.tags";
|
|
13928
|
+
readonly method: "delete";
|
|
13929
|
+
readonly summary: "Delete template tags";
|
|
13930
|
+
readonly description: "Remove the specified tag labels from your template by name, for example {\"name\":\"my-template\",\"tags\":[\"stable\"]}. Builds remain available. Removing default means untagged sandbox creation no longer resolves this template. Unknown or other-organization names return 404. b<number> names are reserved read-only build aliases and cannot be assigned or deleted as tags.";
|
|
13931
|
+
readonly http: "DELETE";
|
|
13932
|
+
readonly path: "/sandbox/v1/templates/tags";
|
|
13933
|
+
readonly streaming: "no";
|
|
13934
|
+
readonly pagination: false;
|
|
13935
|
+
readonly pathParams: readonly [];
|
|
13936
|
+
readonly query: readonly [];
|
|
13937
|
+
readonly body: {
|
|
13938
|
+
readonly required: true;
|
|
13939
|
+
readonly fields: readonly [{
|
|
13940
|
+
readonly name: "name";
|
|
13941
|
+
readonly type: "string";
|
|
13942
|
+
readonly required: true;
|
|
13943
|
+
readonly description: "Name of the template";
|
|
13944
|
+
}, {
|
|
13945
|
+
readonly name: "tags";
|
|
13946
|
+
readonly type: "array";
|
|
13947
|
+
readonly itemType: "string";
|
|
13948
|
+
readonly required: true;
|
|
13949
|
+
readonly description: "Tags to delete";
|
|
13950
|
+
}];
|
|
13951
|
+
};
|
|
13952
|
+
}, {
|
|
13953
|
+
readonly resource: "sandbox.templates.tags";
|
|
13954
|
+
readonly method: "create";
|
|
13955
|
+
readonly summary: "Assign template tags";
|
|
13956
|
+
readonly description: "Assign tags to the ready build selected by target in name:tag format, for example {\"target\":\"my-template:default\",\"tags\":[\"stable\"]}. Names belong to your organization. Tags move an existing label to this build without rebuilding. Obtain available names from templates.list and tags from templates.tags.list. b<number> names are reserved read-only build aliases and cannot be assigned or deleted as tags. target also accepts name:b<number> to select a ready build by number, for example my-template:b1.";
|
|
13957
|
+
readonly http: "POST";
|
|
13958
|
+
readonly path: "/sandbox/v1/templates/tags";
|
|
13959
|
+
readonly streaming: "no";
|
|
13960
|
+
readonly pagination: false;
|
|
13961
|
+
readonly pathParams: readonly [];
|
|
13962
|
+
readonly query: readonly [];
|
|
13963
|
+
readonly body: {
|
|
13964
|
+
readonly required: true;
|
|
13965
|
+
readonly fields: readonly [{
|
|
13966
|
+
readonly name: "target";
|
|
13967
|
+
readonly type: "string";
|
|
13968
|
+
readonly required: true;
|
|
13969
|
+
readonly description: "Target template in \"name:tag\" format";
|
|
13970
|
+
}, {
|
|
13971
|
+
readonly name: "tags";
|
|
13972
|
+
readonly type: "array";
|
|
13973
|
+
readonly itemType: "string";
|
|
13974
|
+
readonly required: true;
|
|
13975
|
+
readonly description: "Tags to assign to the template";
|
|
13976
|
+
}];
|
|
13977
|
+
};
|
|
13978
|
+
}, {
|
|
13979
|
+
readonly resource: "sandbox.templates";
|
|
13980
|
+
readonly method: "delete";
|
|
13981
|
+
readonly summary: "Delete template";
|
|
13982
|
+
readonly description: "Permanently remove your template, its builds and tag assignments using templateID from templates.create. Active instances prevent deletion with 409; terminate them first. Unknown or other-organization IDs return 404. Snapshot IDs use snapshots.delete instead.";
|
|
13983
|
+
readonly http: "DELETE";
|
|
13984
|
+
readonly path: "/sandbox/v1/templates/{templateID}";
|
|
13985
|
+
readonly streaming: "no";
|
|
13986
|
+
readonly pagination: false;
|
|
13987
|
+
readonly pathParams: readonly [{
|
|
13988
|
+
readonly name: "templateID";
|
|
13989
|
+
readonly sdkName: "templateID";
|
|
13990
|
+
readonly description: "Template identifier from templates.create or templates.list. Use your organization's templateID, not a provider handle.";
|
|
13991
|
+
}];
|
|
13992
|
+
readonly query: readonly [];
|
|
13993
|
+
}, {
|
|
13994
|
+
readonly resource: "sandbox.templates";
|
|
13995
|
+
readonly method: "retrieve";
|
|
13996
|
+
readonly summary: "List template builds";
|
|
13997
|
+
readonly description: "Inspect your template and its newest builds using templateID from templates.create. Build states are waiting, building, ready or error. Use limit and the returned x-next-token header to page builds. Unknown or other-organization templates return 404.";
|
|
13998
|
+
readonly http: "GET";
|
|
13999
|
+
readonly path: "/sandbox/v1/templates/{templateID}";
|
|
14000
|
+
readonly streaming: "no";
|
|
14001
|
+
readonly pagination: false;
|
|
14002
|
+
readonly pathParams: readonly [{
|
|
14003
|
+
readonly name: "templateID";
|
|
14004
|
+
readonly sdkName: "templateID";
|
|
14005
|
+
readonly description: "Template identifier from templates.create or templates.list. Use your organization's templateID, not a provider handle.";
|
|
14006
|
+
}];
|
|
14007
|
+
readonly query: readonly [{
|
|
11058
14008
|
readonly name: "nextToken";
|
|
11059
14009
|
readonly type: "string";
|
|
11060
14010
|
readonly required: false;
|
|
@@ -11065,6 +14015,120 @@ export declare const operations: readonly [{
|
|
|
11065
14015
|
readonly required: false;
|
|
11066
14016
|
readonly description: "Maximum number of items to return per page";
|
|
11067
14017
|
}];
|
|
14018
|
+
}, {
|
|
14019
|
+
readonly resource: "sandbox.templates.builds";
|
|
14020
|
+
readonly method: "update";
|
|
14021
|
+
readonly summary: "Start template build (v2)";
|
|
14022
|
+
readonly description: "Submit source for a waiting build returned by templates.create; returns 202 after queueing, not after successful publication. Unlike E2B, COPY is rejected (use RUN curl or git clone), fromTemplate accepts official catalog names only, and plaintext registry credentials are rejected. The own face also accepts dockerfile, mutually exclusive with fromImage/fromTemplate/steps, and fromImageRegistry vault references for nonofficial images. Poll templates.builds.status.list until ready or error. Example: {\"fromImage\":\"node:22\",\"steps\":[{\"type\":\"RUN\",\"args\":[\"echo hello\"]}]}.";
|
|
14023
|
+
readonly http: "POST";
|
|
14024
|
+
readonly path: "/sandbox/v1/templates/{templateID}/builds/{buildID}";
|
|
14025
|
+
readonly streaming: "no";
|
|
14026
|
+
readonly pagination: false;
|
|
14027
|
+
readonly pathParams: readonly [{
|
|
14028
|
+
readonly name: "templateID";
|
|
14029
|
+
readonly sdkName: "templateID";
|
|
14030
|
+
readonly description: "Template identifier from templates.create or templates.list. Use your organization's templateID, not a provider handle.";
|
|
14031
|
+
}, {
|
|
14032
|
+
readonly name: "buildID";
|
|
14033
|
+
readonly sdkName: "buildID";
|
|
14034
|
+
readonly description: "Build identifier returned by templates.create. It must belong to the selected template in your organization.";
|
|
14035
|
+
}];
|
|
14036
|
+
readonly query: readonly [];
|
|
14037
|
+
readonly body: {
|
|
14038
|
+
readonly required: true;
|
|
14039
|
+
readonly fields: readonly [{
|
|
14040
|
+
readonly name: "fromImage";
|
|
14041
|
+
readonly type: "string";
|
|
14042
|
+
readonly required: false;
|
|
14043
|
+
readonly description: "Image to use as a base for the template build";
|
|
14044
|
+
}, {
|
|
14045
|
+
readonly name: "fromTemplate";
|
|
14046
|
+
readonly type: "string";
|
|
14047
|
+
readonly required: false;
|
|
14048
|
+
readonly description: "Template to use as a base for the template build";
|
|
14049
|
+
}, {
|
|
14050
|
+
readonly name: "fromImageRegistry";
|
|
14051
|
+
readonly type: "object";
|
|
14052
|
+
readonly required: false;
|
|
14053
|
+
readonly description: "Registry authentication. Unlike E2B, only the vault reference variant is accepted; plaintext aws, gcp and registry variants return 400. Cannot be used with official templates.";
|
|
14054
|
+
}, {
|
|
14055
|
+
readonly name: "force";
|
|
14056
|
+
readonly type: "boolean";
|
|
14057
|
+
readonly required: false;
|
|
14058
|
+
readonly description: "Whether the whole build should be forced to run regardless of the cache";
|
|
14059
|
+
}, {
|
|
14060
|
+
readonly name: "steps";
|
|
14061
|
+
readonly type: "array";
|
|
14062
|
+
readonly itemType: "object";
|
|
14063
|
+
readonly required: false;
|
|
14064
|
+
readonly description: "List of steps to execute in the template build";
|
|
14065
|
+
}, {
|
|
14066
|
+
readonly name: "startCmd";
|
|
14067
|
+
readonly type: "string";
|
|
14068
|
+
readonly required: false;
|
|
14069
|
+
readonly description: "Start command to execute in the template after the build";
|
|
14070
|
+
}, {
|
|
14071
|
+
readonly name: "readyCmd";
|
|
14072
|
+
readonly type: "string";
|
|
14073
|
+
readonly required: false;
|
|
14074
|
+
readonly description: "Ready check command to execute in the template after the build";
|
|
14075
|
+
}, {
|
|
14076
|
+
readonly name: "dockerfile";
|
|
14077
|
+
readonly type: "string";
|
|
14078
|
+
readonly required: false;
|
|
14079
|
+
readonly description: "Dockerfile text, at most 64 KiB UTF-8. Mutually exclusive with fromImage, fromTemplate and steps. COPY/ADD are rejected; fetch remote content using RUN. Registry credentials require a nonofficial image in the first FROM.";
|
|
14080
|
+
}];
|
|
14081
|
+
};
|
|
14082
|
+
}, {
|
|
14083
|
+
readonly resource: "sandbox.templates.builds.status";
|
|
14084
|
+
readonly method: "list";
|
|
14085
|
+
readonly summary: "Template build status";
|
|
14086
|
+
readonly description: "Poll a build using templateID and buildID from templates.create. waiting means source has not been submitted; building includes queued work; ready permits sandbox creation; error is terminal, with reason when available. logsOffset counts previously read log entries, starting at zero; add logEntries.length after each response. limit is 0–100, default 100. level selects one log level; offsets then count entries at that level. Drain logs until an empty page, including after a terminal status.";
|
|
14087
|
+
readonly http: "GET";
|
|
14088
|
+
readonly path: "/sandbox/v1/templates/{templateID}/builds/{buildID}/status";
|
|
14089
|
+
readonly streaming: "no";
|
|
14090
|
+
readonly pagination: false;
|
|
14091
|
+
readonly pathParams: readonly [{
|
|
14092
|
+
readonly name: "templateID";
|
|
14093
|
+
readonly sdkName: "templateID";
|
|
14094
|
+
readonly description: "Template identifier from templates.create or templates.list. Use your organization's templateID, not a provider handle.";
|
|
14095
|
+
}, {
|
|
14096
|
+
readonly name: "buildID";
|
|
14097
|
+
readonly sdkName: "buildID";
|
|
14098
|
+
readonly description: "Build identifier returned by templates.create. It must belong to the selected template in your organization.";
|
|
14099
|
+
}];
|
|
14100
|
+
readonly query: readonly [{
|
|
14101
|
+
readonly name: "logsOffset";
|
|
14102
|
+
readonly type: "integer";
|
|
14103
|
+
readonly required: false;
|
|
14104
|
+
readonly description: "Index of the starting build log that should be returned with the template";
|
|
14105
|
+
}, {
|
|
14106
|
+
readonly name: "limit";
|
|
14107
|
+
readonly type: "integer";
|
|
14108
|
+
readonly required: false;
|
|
14109
|
+
readonly description: "Maximum number of logs that should be returned";
|
|
14110
|
+
}, {
|
|
14111
|
+
readonly name: "level";
|
|
14112
|
+
readonly type: "string";
|
|
14113
|
+
readonly enum: readonly ["debug", "info", "warn", "error"];
|
|
14114
|
+
readonly required: false;
|
|
14115
|
+
readonly description: "Select one exact log severity: debug for diagnostics, info for progress, warn for warnings, error for failures. Offsets count matching entries.";
|
|
14116
|
+
}];
|
|
14117
|
+
}, {
|
|
14118
|
+
readonly resource: "sandbox.templates.tags";
|
|
14119
|
+
readonly method: "list";
|
|
14120
|
+
readonly summary: "List template tags";
|
|
14121
|
+
readonly description: "Read the tag-to-build assignments for your template using templateID from templates.create. Only ready builds acquire tags. Use a returned tag with the template name as name:tag when creating a sandbox or assigning additional tags. Foreign IDs return 404.";
|
|
14122
|
+
readonly http: "GET";
|
|
14123
|
+
readonly path: "/sandbox/v1/templates/{templateID}/tags";
|
|
14124
|
+
readonly streaming: "no";
|
|
14125
|
+
readonly pagination: false;
|
|
14126
|
+
readonly pathParams: readonly [{
|
|
14127
|
+
readonly name: "templateID";
|
|
14128
|
+
readonly sdkName: "templateID";
|
|
14129
|
+
readonly description: "Template identifier from templates.create or templates.list. Use your organization's templateID, not a provider handle.";
|
|
14130
|
+
}];
|
|
14131
|
+
readonly query: readonly [];
|
|
11068
14132
|
}, {
|
|
11069
14133
|
readonly resource: "sandbox.volumes";
|
|
11070
14134
|
readonly method: "list";
|
|
@@ -11859,7 +14923,7 @@ export declare const operations: readonly [{
|
|
|
11859
14923
|
readonly resource: "ticket.milestones";
|
|
11860
14924
|
readonly method: "create";
|
|
11861
14925
|
readonly summary: "Create or add milestones";
|
|
11862
|
-
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.
|
|
14926
|
+
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. Service authorization applies to the verified human subject.";
|
|
11863
14927
|
readonly http: "POST";
|
|
11864
14928
|
readonly path: "/ticket/v1/milestones";
|
|
11865
14929
|
readonly streaming: "no";
|
|
@@ -11900,7 +14964,7 @@ export declare const operations: readonly [{
|
|
|
11900
14964
|
readonly resource: "ticket.milestones";
|
|
11901
14965
|
readonly method: "delete";
|
|
11902
14966
|
readonly summary: "Remove milestones";
|
|
11903
|
-
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.
|
|
14967
|
+
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. Service authorization applies to the verified human subject.";
|
|
11904
14968
|
readonly http: "DELETE";
|
|
11905
14969
|
readonly path: "/ticket/v1/milestones/{number}";
|
|
11906
14970
|
readonly streaming: "no";
|
|
@@ -11942,7 +15006,7 @@ export declare const operations: readonly [{
|
|
|
11942
15006
|
readonly resource: "ticket.milestones";
|
|
11943
15007
|
readonly method: "update";
|
|
11944
15008
|
readonly summary: "Update milestones";
|
|
11945
|
-
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.
|
|
15009
|
+
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. Service authorization applies to the verified human subject.";
|
|
11946
15010
|
readonly http: "PATCH";
|
|
11947
15011
|
readonly path: "/ticket/v1/milestones/{number}";
|
|
11948
15012
|
readonly streaming: "no";
|
|
@@ -13087,7 +16151,7 @@ export declare const operations: readonly [{
|
|
|
13087
16151
|
readonly resource: "vault.vaults.secrets";
|
|
13088
16152
|
readonly method: "create";
|
|
13089
16153
|
readonly summary: "Create secret";
|
|
13090
|
-
readonly description: "Store a manually supplied token in an active vault for
|
|
16154
|
+
readonly description: "Store a manually supplied token in an active vault. Omit allowed_hosts for name-based resolution only; host-based redemption never matches an empty host list. Unlike Anthropic credentials, this native operation takes name and value directly, with optional allowed_hosts and creates only static secrets; use praxis.vault.authorizations.create for OAuth. Its name must be unused by any non-archived secret in that vault; the response contains metadata but never the supplied value. Application praxis_vault_ref bindings declare vault_id and secret (the secret name), but currently return 501; do not copy the value into a plain-text binding or metadata as a substitute.";
|
|
13091
16155
|
readonly http: "POST";
|
|
13092
16156
|
readonly path: "/vault/v1/vaults/{vault_id}/secrets";
|
|
13093
16157
|
readonly streaming: "no";
|
|
@@ -13114,8 +16178,8 @@ export declare const operations: readonly [{
|
|
|
13114
16178
|
readonly name: "allowed_hosts";
|
|
13115
16179
|
readonly type: "array";
|
|
13116
16180
|
readonly itemType: "string";
|
|
13117
|
-
readonly required:
|
|
13118
|
-
readonly description: "Allowed destinations for the secret.
|
|
16181
|
+
readonly required: false;
|
|
16182
|
+
readonly description: "Allowed destinations for the secret. Omitting allowed_hosts on creation stores an empty list for name-based resolution only: host-based redemption never matches. When supplied, list 1–16 bare domain names, dotted-decimal IPv4 addresses or leading *. domain wildcards. A wildcard matches subdomains, not the domain itself. URLs, ports, paths, IPv6, local/private and platform hosts are rejected. Entries are lowercased, one trailing dot is removed, internationalized domains use Punycode, and duplicates are removed.";
|
|
13119
16183
|
}, {
|
|
13120
16184
|
readonly name: "description";
|
|
13121
16185
|
readonly type: "string";
|
|
@@ -13131,7 +16195,7 @@ export declare const operations: readonly [{
|
|
|
13131
16195
|
readonly type: "string";
|
|
13132
16196
|
readonly enum: readonly ["github", "openai", "anthropic", "stripe"];
|
|
13133
16197
|
readonly required: false;
|
|
13134
|
-
readonly description: "Static template ID from List templates. Records metadata.template; name
|
|
16198
|
+
readonly description: "Static template ID from List templates. Records metadata.template; name and value must still be supplied explicitly; allowed_hosts is optional.";
|
|
13135
16199
|
}, {
|
|
13136
16200
|
readonly name: "kind";
|
|
13137
16201
|
readonly type: "string";
|
|
@@ -13209,7 +16273,7 @@ export declare const operations: readonly [{
|
|
|
13209
16273
|
readonly type: "array";
|
|
13210
16274
|
readonly itemType: "string";
|
|
13211
16275
|
readonly required: false;
|
|
13212
|
-
readonly description: "Allowed destinations for the secret.
|
|
16276
|
+
readonly description: "Allowed destinations for the secret. Omitting allowed_hosts on creation stores an empty list for name-based resolution only: host-based redemption never matches. When supplied, list 1–16 bare domain names, dotted-decimal IPv4 addresses or leading *. domain wildcards. A wildcard matches subdomains, not the domain itself. URLs, ports, paths, IPv6, local/private and platform hosts are rejected. Entries are lowercased, one trailing dot is removed, internationalized domains use Punycode, and duplicates are removed.";
|
|
13213
16277
|
}, {
|
|
13214
16278
|
readonly name: "description";
|
|
13215
16279
|
readonly type: "string";
|
|
@@ -13293,7 +16357,7 @@ export declare const operations: readonly [{
|
|
|
13293
16357
|
readonly resource: "vault.vaults.secrets";
|
|
13294
16358
|
readonly method: "import";
|
|
13295
16359
|
readonly summary: "Import secrets";
|
|
13296
|
-
readonly description: "Import lines or dotenv text into an active vault, reporting success or failure for each entry. Existing names have their values replaced; their hosts change only when that line supplies allowed_hosts. Shared hosts apply only to newly created secrets.";
|
|
16360
|
+
readonly description: "Import lines or dotenv text into an active vault, reporting success or failure for each entry. Existing names have their values replaced; their hosts change only when that line supplies allowed_hosts. Shared hosts apply only to newly created secrets; if neither shared nor per-line hosts are supplied, new secrets use an empty host list for name-based resolution only.";
|
|
13297
16361
|
readonly http: "POST";
|
|
13298
16362
|
readonly path: "/vault/v1/vaults/{vault_id}/secrets:import";
|
|
13299
16363
|
readonly streaming: "no";
|