@makeplane/plane-node-sdk 0.2.12 → 0.2.13

package/dist/types.bundle.d.ts

@@ -148,6 +148,7 @@ export interface Project extends BaseModel {
 	cover_image_url: null;
 	name: string;
 	description: string;
+	description_html?: string;
 	network?: number;
 	identifier?: string;
 	emoji?: null;
@@ -520,6 +521,37 @@ export type ListStatesParams = {
 	offset?: number;
 };
 export type GroupEnum = "backlog" | "unstarted" | "started" | "completed" | "cancelled" | "triage";
+/**
+ * Workspace (catalog) states accept only the five lifecycle groups — the
+ * triage state is system-managed under workspace governance.
+ */
+export type CatalogGroupEnum = "backlog" | "unstarted" | "started" | "completed" | "cancelled";
+/**
+ * Request model for creating a workspace (catalog) state.
+ *
+ * Only accepted when the workspace owns states and workflows (workspace
+ * governance). `group` is required and must be one of the five lifecycle
+ * groups. Catalog states carry no `default` flag; the workspace default lives
+ * on the workflow's default state.
+ */
+export type CreateWorkspaceState = {
+	name: string;
+	color: string;
+	group: CatalogGroupEnum;
+	description?: string;
+	external_source?: string;
+	external_id?: string;
+};
+/**
+ * Request model for updating a workspace (catalog) state.
+ * `default` is not accepted for catalog states — the API rejects it with
+ * code `workspace_managed`.
+ */
+export type UpdateWorkspaceState = Partial<CreateWorkspaceState>;
+export type ListWorkspaceStatesParams = {
+	cursor?: string;
+	per_page?: number;
+};
 /**
  * WorkItem model interfaces
  */
@@ -1855,6 +1887,19 @@ export interface Page extends BaseModel {
 	description_stripped?: string;
 	created_by: string;
 	updated_by?: string;
+	/** 0 = public, 1 = private */
+	access?: number;
+	is_locked?: boolean;
+	/** Set when the page is archived; deleting a page requires it to be archived first */
+	archived_at?: string;
+	parent_id?: string;
+	/**
+	 * Where the page is filed, and the id of the row that files it there -- the
+	 * second is what addresses the membership when moving the page between
+	 * collections. Both are null for a page in no collection.
+	 */
+	collection_id?: string;
+	page_collection_id?: string;
 	[key: string]: any;
 }
 export type CreatePage = Partial<Page> & {
@@ -1863,6 +1908,14 @@ export type CreatePage = Partial<Page> & {
 	/** Create the page directly inside this collection */
 	collection_id?: string;
 };
+/**
+ * Fields a page update may change. At least one is required; sending neither is
+ * refused with 400 "Either name or description_html is required."
+ */
+export interface UpdatePage {
+	name?: string;
+	description_html?: string;
+}
 /**
  * Pages API resource
  * Handles both workspace and project page operations
@@ -1881,6 +1934,29 @@ declare class Pages$1 extends BaseResource {
 	 * List workspace pages
 	 */
 	listWorkspacePages(workspaceSlug: string, params?: any): Promise<PaginatedResponse<Page>>;
+	/**
+	 * Update a workspace page's name, content, or both. A page that is locked or
+	 * archived is refused.
+	 *
+	 * Content is written through Plane's live collaboration service, which owns the
+	 * document. If it is unreachable the API answers 502 and nothing is written,
+	 * rather than leaving the editor showing the old text.
+	 */
+	updateWorkspacePage(workspaceSlug: string, pageId: string, updatePage: UpdatePage): Promise<Page>;
+	/**
+	 * Archive a workspace page. Archiving is the reversible step the API requires
+	 * before a page can be deleted.
+	 */
+	archiveWorkspacePage(workspaceSlug: string, pageId: string): Promise<void>;
+	/**
+	 * Restore an archived workspace page
+	 */
+	unarchiveWorkspacePage(workspaceSlug: string, pageId: string): Promise<void>;
+	/**
+	 * Delete a workspace page. The page must be archived first; the API answers 400
+	 * "The page should be archived before deleting" otherwise.
+	 */
+	deleteWorkspacePage(workspaceSlug: string, pageId: string): Promise<void>;
 	/**
 	 * Create a project page
 	 */
@@ -1893,6 +1969,29 @@ declare class Pages$1 extends BaseResource {
 	 * List project pages
 	 */
 	listProjectPages(workspaceSlug: string, projectId: string, params?: any): Promise<PaginatedResponse<Page>>;
+	/**
+	 * Update a project page's name, content, or both. A page that is locked or
+	 * archived is refused.
+	 *
+	 * Content is written through Plane's live collaboration service, which owns the
+	 * document. If it is unreachable the API answers 502 and nothing is written,
+	 * rather than leaving the editor showing the old text.
+	 */
+	updateProjectPage(workspaceSlug: string, projectId: string, pageId: string, updatePage: UpdatePage): Promise<Page>;
+	/**
+	 * Archive a project page. Archiving is the reversible step the API requires
+	 * before a page can be deleted.
+	 */
+	archiveProjectPage(workspaceSlug: string, projectId: string, pageId: string): Promise<void>;
+	/**
+	 * Restore an archived project page
+	 */
+	unarchiveProjectPage(workspaceSlug: string, projectId: string, pageId: string): Promise<void>;
+	/**
+	 * Delete a project page. The page must be archived first; the API answers 400
+	 * "The page should be archived before deleting" otherwise.
+	 */
+	deleteProjectPage(workspaceSlug: string, projectId: string, pageId: string): Promise<void>;
 	/**
 	 * Retrieve workspace page
 	 */
@@ -2206,16 +2305,27 @@ export declare class Users extends BaseResource {
 }
 /**
  * Workspace Features model interfaces
+ *
+ * All fields are optional so a caller can toggle a single feature; the update
+ * endpoint is a partial (PATCH) that only applies the fields that are sent.
  */
 export interface WorkspaceFeatures {
-	project_grouping: boolean;
-	initiatives: boolean;
-	teams: boolean;
-	customers: boolean;
-	wiki: boolean;
-	pi: boolean;
+	project_grouping?: boolean;
+	initiatives?: boolean;
+	teams?: boolean;
+	customers?: boolean;
+	wiki?: boolean;
+	pi?: boolean;
+	work_item_types?: boolean;
+	releases?: boolean;
+	/**
+	 * Read-only: reports whether states and workflows live at the workspace
+	 * level (workspace governance). Only the governance migration can change
+	 * it — the update endpoint rejects it as an input.
+	 */
+	states_owned_by_workspace?: boolean;
 }
-export type UpdateWorkspaceFeatures = Partial<WorkspaceFeatures>;
+export type UpdateWorkspaceFeatures = Partial<Omit<WorkspaceFeatures, "states_owned_by_workspace">>;
 /**
  * Workspace API resource
  * Handles all workspace-related operations
@@ -3960,20 +4070,94 @@ export interface WorkflowTransition extends BaseModel {
 }
 export type CreateWorkflowTransition = Required<Pick<WorkflowTransition, "state_id" | "transition_state_id">> & Partial<Pick<WorkflowTransition, "type" | "member_ids" | "pre_rules" | "post_rules">>;
 export type UpdateWorkflowTransition = Partial<Pick<WorkflowTransition, "pre_rules" | "post_rules">>;
+/**
+ * A state's membership row within a workflow chain. `id` is the membership
+ * row's ID and `state_id` the state's own — the inverse of
+ * `WorkspaceWorkflowState`, whose rows are keyed by state ID.
+ */
+export interface WorkflowState {
+	id?: string;
+	state_id?: string;
+	workflow_id?: string;
+	type?: string;
+	allow_issue_creation?: boolean;
+	is_default?: boolean;
+	created_at?: string;
+	updated_at?: string;
+}
+export type UpdateWorkflowState = Partial<Pick<WorkflowState, "type" | "allow_issue_creation" | "is_default">>;
+/**
+ * One workflow activity/audit entry
+ */
+export interface WorkflowActivity {
+	id?: string;
+	verb?: string;
+	field?: string;
+	old_value?: unknown;
+	new_value?: unknown;
+	actor?: unknown;
+	created_at?: string;
+}
+/**
+ * Request model for approving or rejecting a work item's pending workflow
+ * transition
+ */
+export interface SubmitWorkItemApproval {
+	type: "approve" | "reject";
+}
+/**
+ * Response of a work item workflow approval: the state the item moved to
+ */
+export interface WorkItemApprovalResult {
+	state_id?: string;
+}
+/**
+ * A validation/action hook attached to a workflow transition.
+ * `config.secret` is masked for send_webhook handlers; the one-shot
+ * `secret_plaintext` appears on create and regenerate responses only.
+ */
+export interface WorkflowTransitionHook {
+	id?: string;
+	phase?: string;
+	handler_name?: string;
+	rule_type?: string;
+	execution_order?: number;
+	is_enabled?: boolean;
+	config?: Record<string, unknown>;
+	secret_plaintext?: string;
+}
+/**
+ * Request model for creating a workflow transition hook. `phase` and
+ * `handler_name` are immutable post-create.
+ */
+export type CreateWorkflowTransitionHook = Pick<WorkflowTransitionHook, "phase" | "handler_name" | "config"> & Partial<Pick<WorkflowTransitionHook, "is_enabled">>;
+export type UpdateWorkflowTransitionHook = Partial<Pick<WorkflowTransitionHook, "config" | "is_enabled">>;
 /**
  * WorkflowStates sub-resource
  * Manages state attachments on a workflow
  */
 declare class States$1 extends BaseResource {
 	constructor(config: Configuration);
+	/**
+	 * List the states attached to a workflow
+	 */
+	list(workspaceSlug: string, projectId: string, workflowId: string): Promise<WorkflowState[]>;
 	/**
 	 * Attach states to a workflow
 	 */
 	attach(workspaceSlug: string, projectId: string, workflowId: string, data: AttachWorkflowStates): Promise<void>;
+	/**
+	 * Update a state's membership row (type, allow_issue_creation, is_default)
+	 */
+	update(workspaceSlug: string, projectId: string, workflowId: string, stateId: string, data: UpdateWorkflowState): Promise<WorkflowState | null>;
 	/**
 	 * Detach a state from a workflow
 	 */
 	detach(workspaceSlug: string, projectId: string, workflowId: string, stateId: string): Promise<void>;
+	/**
+	 * Transfer work items off a state and remove it from the workflow
+	 */
+	transfer(workspaceSlug: string, projectId: string, workflowId: string, stateId: string, newStateId: string): Promise<void>;
 }
 /**
  * WorkflowTransitions sub-resource
@@ -3985,6 +4169,10 @@ declare class Transitions extends BaseResource {
 	 * List all state transitions for a workflow
 	 */
 	list(workspaceSlug: string, projectId: string, workflowId: string): Promise<WorkflowTransition[]>;
+	/**
+	 * Retrieve a workflow state transition by ID
+	 */
+	retrieve(workspaceSlug: string, projectId: string, workflowId: string, transitionId: string): Promise<WorkflowTransition>;
 	/**
 	 * Create a state transition for a workflow.
 	 * Returns null if the transition already exists (HTTP 400 "already exists").
@@ -3999,13 +4187,52 @@ declare class Transitions extends BaseResource {
 	 */
 	del(workspaceSlug: string, projectId: string, workflowId: string, transitionId: string): Promise<void>;
 }
+/**
+ * WorkflowTransitionHooks sub-resource
+ * Manages hooks attached to project workflow transitions
+ */
+declare class Hooks extends BaseResource {
+	constructor(config: Configuration);
+	private basePath;
+	/**
+	 * List hooks on a workflow transition
+	 */
+	list(workspaceSlug: string, projectId: string, workflowId: string, transitionId: string): Promise<WorkflowTransitionHook[]>;
+	/**
+	 * Create a hook on a workflow transition.
+	 * For send_webhook handlers the one-shot `secret_plaintext` is included in
+	 * the response of this call only.
+	 */
+	create(workspaceSlug: string, projectId: string, workflowId: string, transitionId: string, data: CreateWorkflowTransitionHook): Promise<WorkflowTransitionHook>;
+	/**
+	 * Retrieve a hook by ID
+	 */
+	retrieve(workspaceSlug: string, projectId: string, workflowId: string, transitionId: string, hookId: string): Promise<WorkflowTransitionHook>;
+	/**
+	 * Update a hook (`phase` and `handler_name` are immutable)
+	 */
+	update(workspaceSlug: string, projectId: string, workflowId: string, transitionId: string, hookId: string, data: UpdateWorkflowTransitionHook): Promise<WorkflowTransitionHook>;
+	/**
+	 * Delete a hook
+	 */
+	del(workspaceSlug: string, projectId: string, workflowId: string, transitionId: string, hookId: string): Promise<void>;
+}
+export type ListWorkflowActivitiesParams = {
+	created_at__gt?: string;
+};
 /**
  * Workflows API resource
- * Handles project workflow operations and exposes states/transitions sub-resources
+ * Handles project workflow operations and exposes states/transitions/hooks
+ * sub-resources.
+ *
+ * Under workspace governance, workflows are managed at the workspace level
+ * (see `WorkspaceWorkflows`) and project-scoped writes respond 400 with code
+ * `workspace_managed`.
  */
 export declare class Workflows extends BaseResource {
 	states: States$1;
 	transitions: Transitions;
+	hooks: Hooks;
 	constructor(config: Configuration);
 	/**
 	 * List all workflows for a project
@@ -4015,10 +4242,27 @@ export declare class Workflows extends BaseResource {
 	 * Create a new workflow for a project
 	 */
 	create(workspaceSlug: string, projectId: string, data: CreateWorkflow): Promise<Workflow>;
+	/**
+	 * Retrieve a workflow by ID
+	 */
+	retrieve(workspaceSlug: string, projectId: string, workflowId: string): Promise<Workflow>;
 	/**
 	 * Update a workflow by ID
 	 */
 	update(workspaceSlug: string, projectId: string, workflowId: string, data: UpdateWorkflow): Promise<Workflow>;
+	/**
+	 * Delete a workflow by ID.
+	 * The default workflow cannot be deleted.
+	 */
+	delete(workspaceSlug: string, projectId: string, workflowId: string): Promise<void>;
+	/**
+	 * List the workflow's activity/audit entries
+	 */
+	activities(workspaceSlug: string, projectId: string, workflowId: string, params?: ListWorkflowActivitiesParams): Promise<WorkflowActivity[]>;
+	/**
+	 * Approve or reject a work item's pending workflow transition
+	 */
+	submitWorkItemApproval(workspaceSlug: string, projectId: string, workItemId: string, data: SubmitWorkItemApproval): Promise<WorkItemApprovalResult>;
 }
 /**
  * Project template model interfaces
@@ -4098,6 +4342,580 @@ export declare class ProjectTemplates extends BaseResource {
 	pages: Pages$4;
 	constructor(config: Configuration);
 }
+/**
+ * WorkspaceStates API resource
+ * Manages workspace-level work-item states.
+ *
+ * Reads are dual-mode: under workspace governance, `list`/`retrieve` serve
+ * the workspace states catalog; in ungoverned workspaces they aggregate the
+ * states of every project the caller can access. Writes are only available
+ * when the workspace owns states and workflows — otherwise the API responds
+ * 400 with code `workspace_not_managed`. Check
+ * `Workspace.retrieveFeatures(...).states_owned_by_workspace` to know which
+ * mode a workspace is in.
+ *
+ * Not to be confused with `WorkspaceProjectStates` (`{slug}/project-states/`),
+ * which manages project *lifecycle* states.
+ */
+export declare class WorkspaceStates extends BaseResource {
+	constructor(config: Configuration);
+	/**
+	 * List states at workspace scope (works in both modes)
+	 */
+	list(workspaceSlug: string, params?: ListWorkspaceStatesParams): Promise<PaginatedResponse<State>>;
+	/**
+	 * Retrieve a workspace state by its external ID and source
+	 */
+	retrieveByExternalId(workspaceSlug: string, externalId: string, externalSource: string): Promise<State>;
+	/**
+	 * Create a new workspace (catalog) state.
+	 * Governed workspaces only (400 `workspace_not_managed` otherwise).
+	 * Catalog state names are workspace-unique — a duplicate name responds 409
+	 * with code `state_name_in_use`.
+	 */
+	create(workspaceSlug: string, data: CreateWorkspaceState): Promise<State>;
+	/**
+	 * Retrieve a workspace state by ID
+	 */
+	retrieve(workspaceSlug: string, stateId: string): Promise<State>;
+	/**
+	 * Update a workspace (catalog) state by ID.
+	 * Governed workspaces only. The triage state cannot be updated, and the
+	 * `default` flag is managed by the workflow's default state.
+	 */
+	update(workspaceSlug: string, stateId: string, data: UpdateWorkspaceState): Promise<State>;
+	/**
+	 * Delete a workspace (catalog) state by ID.
+	 * Governed workspaces only. Deletion is blocked (400) while any workflow
+	 * chain references the state or any work item still points at it; the
+	 * triage state is never deletable.
+	 */
+	delete(workspaceSlug: string, stateId: string): Promise<void>;
+}
+/**
+ * One state row in a workspace workflow's chain.
+ *
+ * Rows are keyed by catalog state IDs, so `id` is the state's own ID — the
+ * inverse of the project-scoped `WorkflowState` (see `./Workflow`), where
+ * `id` is the membership row's ID and `state_id` is the state's. The API
+ * never sends `state_id` on these rows; treat `id` as the state ID.
+ *
+ * `transitions` embeds the outgoing transitions (with approvers) when the
+ * payload is the full chain projection.
+ */
+export interface WorkspaceWorkflowState {
+	id?: string;
+	state_id?: string;
+	type?: string;
+	allow_issue_creation?: boolean;
+	is_default?: boolean;
+	sequence?: number;
+	transitions?: Record<string, unknown>[];
+}
+/**
+ * Workspace workflow model (catalog list row / detail superset).
+ *
+ * The list endpoint returns the count fields only; `retrieve` adds the full
+ * `states` chain, `project_ids`/`work_item_type_ids` usage, and
+ * `referenced_resources`.
+ */
+export interface WorkspaceWorkflow {
+	id?: string;
+	name: string;
+	description?: string;
+	is_default?: boolean;
+	is_active?: boolean;
+	workspace_id?: string;
+	project_id?: string;
+	states_count?: number;
+	projects_count?: number;
+	work_item_types_count?: number;
+	project_ids?: string[];
+	work_item_type_ids?: string[];
+	states?: WorkspaceWorkflowState[];
+	referenced_resources?: unknown;
+	created_at?: string;
+	updated_at?: string;
+	created_by?: string;
+	updated_by?: string;
+}
+export type PaginatedWorkspaceWorkflowResponse = PaginatedResponse<WorkspaceWorkflow>;
+/**
+ * Request model for creating a workspace workflow (a draft until its chain
+ * is configured via the states endpoints)
+ */
+export type CreateWorkspaceWorkflow = {
+	name: string;
+	description?: string;
+};
+/**
+ * Request model for updating workspace workflow metadata
+ */
+export type UpdateWorkspaceWorkflow = Partial<{
+	name: string;
+	description: string;
+	is_active: boolean;
+}>;
+/**
+ * Request model for appending catalog states to a workflow's chain
+ */
+export interface AddWorkspaceWorkflowStates {
+	state_ids: string[];
+}
+/**
+ * Request model for updating a chain membership row.
+ * Changing `type` (e.g. to/from `approval`) removes the row's existing
+ * transitions server-side.
+ */
+export type UpdateWorkspaceWorkflowState = Partial<{
+	type: string;
+	allow_issue_creation: boolean;
+	is_default: boolean;
+}>;
+/**
+ * Request body for removing a state from a chain.
+ * Orphan-gated: every work item stranded by the removal must be covered by
+ * `state_mapping` (409 with an orphan report otherwise). Removing the default
+ * state requires `new_default_state_id`.
+ */
+export interface RemoveWorkspaceWorkflowState {
+	new_default_state_id?: string;
+	state_mapping?: Record<string, string>;
+}
+/**
+ * One project resolving to a workflow in the usage report
+ */
+export interface WorkspaceWorkflowUsageProject {
+	project_id?: string;
+	name?: string;
+	types: (string | null)[];
+}
+/**
+ * Usage report for a workspace workflow: projects/types resolving to it, plus
+ * the types mandating or allowing it
+ */
+export interface WorkspaceWorkflowUsage {
+	projects: WorkspaceWorkflowUsageProject[];
+	types_mandating: string[];
+	types_allowing: string[];
+}
+/**
+ * State transition within a workspace workflow
+ */
+export interface WorkspaceWorkflowTransition {
+	id?: string;
+	workflow_state_id?: string;
+	transition_state_id?: string;
+	rejection_state_id?: string;
+	required_approvals?: number;
+	member_ids?: string[];
+	pre_hooks?: Record<string, unknown>[];
+	post_hooks?: Record<string, unknown>[];
+	created_at?: string;
+	updated_at?: string;
+}
+/**
+ * Request model for creating a workspace workflow transition.
+ * `state_id` is the chain state the transition starts from; `member_ids` are
+ * the approvers (approval-type states only).
+ */
+export type CreateWorkspaceWorkflowTransition = {
+	state_id: string;
+	transition_state_id: string;
+	rejection_state_id?: string;
+	required_approvals?: number;
+	member_ids?: string[];
+};
+/**
+ * Request model for updating a workspace workflow transition
+ */
+export type UpdateWorkspaceWorkflowTransition = Partial<{
+	transition_state_id: string;
+	rejection_state_id: string;
+	required_approvals: number;
+	member_ids: string[];
+}>;
+/**
+ * WorkspaceWorkflows.states sub-resource
+ * Manages a workspace workflow's chain (state memberships)
+ */
+declare class States$2 extends BaseResource {
+	constructor(config: Configuration);
+	/**
+	 * Append catalog states to the workflow's chain.
+	 * Returns the updated chain rows.
+	 */
+	add(workspaceSlug: string, workflowId: string, data: AddWorkspaceWorkflowStates): Promise<WorkspaceWorkflowState[]>;
+	/**
+	 * Update a chain membership row (type, allow_issue_creation, is_default).
+	 * Changing `type` removes the row's existing transitions server-side.
+	 */
+	update(workspaceSlug: string, workflowId: string, stateId: string, data: UpdateWorkspaceWorkflowState): Promise<WorkspaceWorkflowState>;
+	/**
+	 * Remove a state from the chain.
+	 * Orphan-gated: every work item stranded by the removal must be covered by
+	 * `data.state_mapping` (409 with an orphan report otherwise). Removing the
+	 * default state requires `data.new_default_state_id`; transitions
+	 * referencing the state must be removed first.
+	 */
+	remove(workspaceSlug: string, workflowId: string, stateId: string, data?: RemoveWorkspaceWorkflowState): Promise<void>;
+	/**
+	 * Mark a chain state as the workflow's default.
+	 * Also force-enables work-item creation on that state.
+	 */
+	markDefault(workspaceSlug: string, workflowId: string, stateId: string): Promise<WorkspaceWorkflowState>;
+}
+/**
+ * WorkspaceWorkflows.transitions sub-resource
+ * Manages state transitions within a workspace workflow
+ */
+declare class Transitions$1 extends BaseResource {
+	constructor(config: Configuration);
+	/**
+	 * List all state transitions for a workspace workflow
+	 */
+	list(workspaceSlug: string, workflowId: string): Promise<WorkspaceWorkflowTransition[]>;
+	/**
+	 * Create a state transition for a workspace workflow
+	 */
+	create(workspaceSlug: string, workflowId: string, data: CreateWorkspaceWorkflowTransition): Promise<WorkspaceWorkflowTransition>;
+	/**
+	 * Retrieve a workspace workflow transition by ID
+	 */
+	retrieve(workspaceSlug: string, workflowId: string, transitionId: string): Promise<WorkspaceWorkflowTransition>;
+	/**
+	 * Update a workspace workflow transition
+	 */
+	update(workspaceSlug: string, workflowId: string, transitionId: string, data: UpdateWorkspaceWorkflowTransition): Promise<WorkspaceWorkflowTransition>;
+	/**
+	 * Delete a workspace workflow transition
+	 */
+	del(workspaceSlug: string, workflowId: string, transitionId: string): Promise<void>;
+}
+/**
+ * One execution history entry for a workflow transition hook
+ */
+export interface WorkflowTransitionHookExecution {
+	id: string;
+	status: string;
+	started_at?: string;
+	completed_at?: string;
+	input_data?: unknown;
+	output_data?: unknown;
+	error_message?: string;
+	issue_id?: string;
+}
+/**
+ * WorkspaceWorkflows.hooks sub-resource
+ * Manages hooks attached to workspace workflow transitions
+ */
+declare class Hooks$1 extends BaseResource {
+	constructor(config: Configuration);
+	private basePath;
+	/**
+	 * List hooks on a workspace workflow transition
+	 */
+	list(workspaceSlug: string, workflowId: string, transitionId: string): Promise<WorkflowTransitionHook[]>;
+	/**
+	 * Create a hook on a workspace workflow transition.
+	 * For send_webhook handlers the one-shot `secret_plaintext` is included in
+	 * the response of this call only.
+	 */
+	create(workspaceSlug: string, workflowId: string, transitionId: string, data: CreateWorkflowTransitionHook): Promise<WorkflowTransitionHook>;
+	/**
+	 * Retrieve a hook by ID
+	 */
+	retrieve(workspaceSlug: string, workflowId: string, transitionId: string, hookId: string): Promise<WorkflowTransitionHook>;
+	/**
+	 * Update a hook (`phase` and `handler_name` are immutable)
+	 */
+	update(workspaceSlug: string, workflowId: string, transitionId: string, hookId: string, data: UpdateWorkflowTransitionHook): Promise<WorkflowTransitionHook>;
+	/**
+	 * Delete a hook
+	 */
+	del(workspaceSlug: string, workflowId: string, transitionId: string, hookId: string): Promise<void>;
+	/**
+	 * Regenerate a send_webhook hook's secret.
+	 * The new one-shot `secret_plaintext` is included in this response only.
+	 */
+	regenerateSecret(workspaceSlug: string, workflowId: string, transitionId: string, hookId: string): Promise<WorkflowTransitionHook>;
+	/**
+	 * List a hook's execution history entries
+	 */
+	executions(workspaceSlug: string, workflowId: string, transitionId: string, hookId: string): Promise<WorkflowTransitionHookExecution[]>;
+}
+export type ListWorkspaceWorkflowsParams = {
+	search?: string;
+	is_active?: boolean;
+	sort_by?: "name" | "created_at" | "updated_at";
+	sort_order?: "asc" | "desc";
+	cursor?: string;
+	per_page?: number;
+};
+export type ListWorkspaceWorkflowActivitiesParams = {
+	created_at__gt?: string;
+};
+/**
+ * WorkspaceWorkflows API resource
+ * Manages the workspace workflow catalog (workspace governance) and exposes
+ * states/transitions/hooks sub-resources.
+ *
+ * `list` is dual-mode: under workspace governance it serves the workspace
+ * workflow catalog; in ungoverned workspaces it aggregates project workflows.
+ * All writes require the workspace to own states and workflows — otherwise
+ * the API responds 400 with code `workspace_not_managed`.
+ */
+export declare class WorkspaceWorkflows extends BaseResource {
+	states: States$2;
+	transitions: Transitions$1;
+	hooks: Hooks$1;
+	constructor(config: Configuration);
+	/**
+	 * List workspace workflows
+	 */
+	list(workspaceSlug: string, params?: ListWorkspaceWorkflowsParams): Promise<PaginatedResponse<WorkspaceWorkflow>>;
+	/**
+	 * Create a workspace workflow draft (configure its chain via `states`).
+	 * Workflow names are workspace-unique.
+	 */
+	create(workspaceSlug: string, data: CreateWorkspaceWorkflow): Promise<WorkspaceWorkflow>;
+	/**
+	 * Retrieve a workspace workflow with its full chain
+	 */
+	retrieve(workspaceSlug: string, workflowId: string): Promise<WorkspaceWorkflow>;
+	/**
+	 * Update workspace workflow metadata (name, description, is_active)
+	 */
+	update(workspaceSlug: string, workflowId: string, data: UpdateWorkspaceWorkflow): Promise<WorkspaceWorkflow>;
+	/**
+	 * Delete a workspace workflow.
+	 * The default workflow and workflows in use by projects cannot be deleted.
+	 */
+	delete(workspaceSlug: string, workflowId: string): Promise<void>;
+	/**
+	 * Report which projects/types resolve to this workflow, and which types
+	 * mandate or allow it
+	 */
+	usage(workspaceSlug: string, workflowId: string): Promise<WorkspaceWorkflowUsage>;
+	/**
+	 * List the workflow's activity/audit entries
+	 */
+	activities(workspaceSlug: string, workflowId: string, params?: ListWorkspaceWorkflowActivitiesParams): Promise<WorkflowActivity[]>;
+}
+/**
+ * Minimal workflow shape for embedding (pickers, pins)
+ */
+export interface WorkflowLite {
+	id?: string;
+	name?: string;
+}
+/**
+ * Minimal project reference in governance payloads
+ */
+export interface GovernanceProjectRef {
+	id?: string;
+	name?: string;
+}
+/**
+ * One allowlist/mandate row, enriched with its in-use projects.
+ * `locked` marks workflows a project's pick already uses — a constrained
+ * allowlist must retain them.
+ */
+export interface GovernanceAllowlistEntry {
+	workflow_id?: string;
+	name?: string;
+	in_use_by_projects: GovernanceProjectRef[];
+	locked?: boolean;
+}
+export type TypeGovernanceMode = "any" | "constrained" | "required";
+/**
+ * Governance settings for a work item type: mode, required workflow, and
+ * allowlist. Pins are served by the dedicated pins endpoints.
+ */
+export interface TypeGovernance {
+	mode?: TypeGovernanceMode;
+	required_workflow?: WorkflowLite | null;
+	allowlist: GovernanceAllowlistEntry[];
+}
+/**
+ * Request model for changing a type's governance mode.
+ *
+ * - `any`: no restriction; `workflow_ids`/`required_workflow_id` unused.
+ * - `constrained`: `workflow_ids` is the allowlist (in-use workflows are
+ *   locked in). Removing picks in use requires `acknowledge` and may need a
+ *   `state_mapping` for orphaned work items.
+ * - `required`: `required_workflow_id` mandates one workflow everywhere;
+ *   requires `acknowledge` and may need a `state_mapping`.
+ */
+export interface UpdateTypeGovernance {
+	mode: TypeGovernanceMode;
+	workflow_ids?: string[];
+	required_workflow_id?: string;
+	acknowledge?: boolean;
+	state_mapping?: Record<string, string>;
+}
+/**
+ * Request model for previewing a governance mode change (no writes)
+ */
+export interface TypeGovernancePreviewRequest {
+	mode: TypeGovernanceMode;
+	workflow_ids?: string[];
+	required_workflow_id?: string;
+}
+/**
+ * Dry-run impact report for a governance change or workflow fallback
+ */
+export interface GovernancePreview {
+	total?: number;
+	type_total?: number;
+	per_state?: Record<string, unknown>[];
+}
+/**
+ * A single project-to-workflow pin for a work item type
+ */
+export interface WorkItemTypeWorkflowPin {
+	id?: string;
+	project?: GovernanceProjectRef;
+	workflow?: WorkflowLite;
+}
+/**
+ * Request model for pinning a workflow across one or more projects
+ */
+export interface CreateWorkItemTypeWorkflowPins {
+	workflow_id: string;
+	project_ids: string[];
+}
+/**
+ * A pickable workflow option for a project's type
+ */
+export interface WorkflowOption {
+	workflow_id?: string;
+	name?: string;
+}
+/**
+ * One active type's governance pill, effective workflow, and pickable
+ * options within a project
+ */
+export interface ProjectTypeWorkflow {
+	type_id?: string;
+	/** any | constrained | required | pinned */
+	governance?: string;
+	allowlist_count?: number;
+	allowlist_total?: number;
+	effective_workflow_id?: string;
+	source?: string;
+	options: WorkflowOption[];
+}
+/**
+ * Request model for setting a project's workflow pick for a type.
+ * Orphan-gated: work items whose state falls outside the target chain must
+ * be covered by `state_mapping`.
+ */
+export interface SetProjectWorkflowPick {
+	workflow_id: string;
+	state_mapping?: Record<string, string>;
+}
+/**
+ * Response of setting a project's workflow pick: the workflow now in effect
+ */
+export interface ProjectWorkflowPickResult {
+	workflow_id?: string;
+}
+/**
+ * Request model for previewing the project workflow fallback.
+ * Provide `new_type_id` (+ current `type_id`) for a re-type preview, or
+ * `workflow_id` (+ `type_id`) for a workflow-switch preview.
+ */
+export interface WorkflowFallbackPreviewRequest {
+	type_id?: string;
+	new_type_id?: string;
+	workflow_id?: string;
+}
+/**
+ * WorkItemTypeGovernance.pins sub-resource
+ *
+ * A pin forces one project to resolve a type to a specific workflow,
+ * overriding the workspace default and the constrained allowlist.
+ */
+declare class Pins extends BaseResource {
+	constructor(config: Configuration);
+	/**
+	 * List a type's project-to-workflow pins
+	 */
+	list(workspaceSlug: string, typeId: string): Promise<WorkItemTypeWorkflowPin[]>;
+	/**
+	 * Pin a workflow for this type across one or more projects.
+	 * Returns the type's pins after the change.
+	 */
+	create(workspaceSlug: string, typeId: string, data: CreateWorkItemTypeWorkflowPins): Promise<WorkItemTypeWorkflowPin[]>;
+	/**
+	 * Remove a pin
+	 */
+	delete(workspaceSlug: string, typeId: string, pinId: string): Promise<void>;
+}
+/**
+ * WorkItemTypeGovernance.projectWorkflows sub-resource
+ *
+ * Reports each active type's governance mode and the workflow it effectively
+ * resolves to within a project, and manages the project's own workflow pick
+ * for a type.
+ */
+declare class ProjectWorkflows extends BaseResource {
+	constructor(config: Configuration);
+	/**
+	 * List every active type's governance mode, effective workflow, and
+	 * pickable options for a project
+	 */
+	list(workspaceSlug: string, projectId: string): Promise<ProjectTypeWorkflow[]>;
+	/**
+	 * Retrieve one type's governance mode and effective workflow in a project
+	 */
+	retrieve(workspaceSlug: string, projectId: string, typeId: string): Promise<ProjectTypeWorkflow>;
+	/**
+	 * Retrieve the project's current workflow pick context for a type
+	 */
+	retrievePick(workspaceSlug: string, projectId: string, typeId: string): Promise<ProjectTypeWorkflow>;
+	/**
+	 * Set the project's workflow pick for a type.
+	 * Runs the workflow fallback for stranded work items; every orphan must be
+	 * covered by `data.state_mapping` (400 with an orphan report otherwise).
+	 */
+	updatePick(workspaceSlug: string, projectId: string, typeId: string, data: SetProjectWorkflowPick): Promise<ProjectWorkflowPickResult>;
+	/**
+	 * Dry-run the project's workflow fallback (re-type / switch dialogs)
+	 */
+	previewFallback(workspaceSlug: string, projectId: string, data: WorkflowFallbackPreviewRequest): Promise<GovernancePreview>;
+}
+/**
+ * WorkItemTypeGovernance API resource (workspace governance only)
+ *
+ * Governs which workflows a workspace-level work item type may use
+ * (`any` / `constrained` / `required` modes and allowlists). Per-project pins
+ * live on `.pins`; the project-side view of effective workflows and picks
+ * lives on `.projectWorkflows`. Every endpoint requires the workspace to own
+ * states and workflows — otherwise the API responds 400 with code
+ * `workspace_not_managed`.
+ */
+export declare class WorkItemTypeGovernance extends BaseResource {
+	pins: Pins;
+	projectWorkflows: ProjectWorkflows;
+	constructor(config: Configuration);
+	/**
+	 * Retrieve a type's governance settings (mode, required workflow, allowlist)
+	 */
+	retrieve(workspaceSlug: string, typeId: string): Promise<TypeGovernance>;
+	/**
+	 * Update a type's governance mode / allowlist / required workflow.
+	 * Destructive changes (dropping in-use workflows, mandating one) require
+	 * `data.acknowledge` and may need a `data.state_mapping` for orphaned work
+	 * items.
+	 */
+	update(workspaceSlug: string, typeId: string, data: UpdateTypeGovernance): Promise<TypeGovernance>;
+	/**
+	 * Dry-run a governance change and report affected work items (no writes)
+	 */
+	preview(workspaceSlug: string, typeId: string, data: TypeGovernancePreviewRequest): Promise<GovernancePreview>;
+}
 /**
  * Main Plane Client class
  * Provides access to all Plane API resources
@@ -4136,6 +4954,9 @@ export declare class PlaneClient {
 	releases: Releases;
 	workflows: Workflows;
 	projectTemplates: ProjectTemplates;
+	workspaceStates: WorkspaceStates;
+	workspaceWorkflows: WorkspaceWorkflows;
+	workItemTypeGovernance: WorkItemTypeGovernance;
 	constructor(config: {
 		baseUrl?: string;
 		apiKey?: string;
@@ -4250,6 +5071,8 @@ export {
 	CustomRelations as WorkItemCustomRelations,
 	Dependencies as WorkItemDependencies,
 	Epics$1 as InitiativeEpics,
+	Hooks as WorkflowTransitionHooks,
+	Hooks$1 as WorkspaceWorkflowTransitionHooks,
 	ItemLabels as ReleaseItemLabels,
 	Labels$1 as InitiativeLabels,
 	Labels$2 as ReleaseLabels,
@@ -4263,6 +5086,8 @@ export {
 	Pages$2 as CollectionPagesResource,
 	Pages$3 as WorkspacePageTemplates,
 	Pages$4 as ProjectPageTemplates,
+	Pins as WorkItemTypeWorkflowPins,
+	ProjectWorkflows as ProjectTypeWorkflows,
 	Projects$1 as TeamspaceProjects,
 	Projects$2 as InitiativeProjects,
 	Projects$3 as WorkspaceProjectTemplates,
@@ -4271,8 +5096,10 @@ export {
 	Relations as WorkItemRelations,
 	Requests as CustomerRequests,
 	States$1 as WorkflowStates,
+	States$2 as WorkspaceWorkflowStates,
 	Tags as ReleaseTags,
 	Transitions as WorkflowTransitions,
+	Transitions$1 as WorkspaceWorkflowTransitions,
 	Values as WorkItemPropertyValues,
 	WorkItems$1 as WorkspaceWorkItemTemplates,
 	WorkItems$2 as ReleaseWorkItems,