Interface IPolicyClient

Namespace

OpenShell

Assembly

OpenShell.Sdk.dll

Draft policy review and policy revision history for sandboxes.

public interface IPolicyClient

Methods

ApproveAllAsync(string, ApproveAllOptions?, CancellationToken)

Approves pending chunks in one write.

ValueTask<ApproveAllResult> ApproveAllAsync(string sandbox, ApproveAllOptions? options = null, CancellationToken cancellationToken = default)

Parameters

sandbox string

options ApproveAllOptions

cancellationToken CancellationToken

Returns

ValueTask<ApproveAllResult>

ApproveChunkAsync(string, string, string, string?, CancellationToken)

Approves one chunk. Fails with a conflict when live inputs no longer match reviewToken.

ValueTask<PolicyChangeResult> ApproveChunkAsync(string sandbox, string chunkId, string reviewToken, string? requestId = null, CancellationToken cancellationToken = default)

Parameters

sandbox string

chunkId string

reviewToken string

requestId string

cancellationToken CancellationToken

Returns

ValueTask<PolicyChangeResult>

ClearChunksAsync(string, string?, CancellationToken)

Clears every pending chunk and returns how many were cleared.

ValueTask<uint> ClearChunksAsync(string sandbox, string? requestId = null, CancellationToken cancellationToken = default)

Parameters

sandbox string

requestId string

cancellationToken CancellationToken

Returns

ValueTask<uint>

EditChunkAsync(string, string, NetworkPolicyRule, string?, CancellationToken)

Replaces the proposed rule of a pending chunk.

ValueTask EditChunkAsync(string sandbox, string chunkId, NetworkPolicyRule proposedRule, string? requestId = null, CancellationToken cancellationToken = default)

Parameters

sandbox string

chunkId string

proposedRule NetworkPolicyRule

requestId string

cancellationToken CancellationToken

Returns

ValueTask

GetDraftAsync(string, string?, CancellationToken)

Gets the draft policy, optionally filtered by chunk status (pending, approved, rejected).

ValueTask<DraftPolicy> GetDraftAsync(string sandbox, string? statusFilter = null, CancellationToken cancellationToken = default)

Parameters

sandbox string

statusFilter string

cancellationToken CancellationToken

Returns

ValueTask<DraftPolicy>

GetDraftHistoryAsync(string, CancellationToken)

Gets the chronological draft decision history.

ValueTask<IReadOnlyList<DraftHistoryEntry>> GetDraftHistoryAsync(string sandbox, CancellationToken cancellationToken = default)

Parameters

sandbox string

cancellationToken CancellationToken

Returns

ValueTask<IReadOnlyList<DraftHistoryEntry>>

GetStatusAsync(string, PolicyStatusOptions?, CancellationToken)

Gets the status of a policy revision and the sandbox's active version.

ValueTask<PolicyStatusResult> GetStatusAsync(string sandbox, PolicyStatusOptions? options = null, CancellationToken cancellationToken = default)

Parameters

sandbox string

options PolicyStatusOptions

cancellationToken CancellationToken

Returns

ValueTask<PolicyStatusResult>

ListRevisions(string, PolicyListOptions?)

Lists policy revisions lazily, newest first as returned by the gateway.

Pager<PolicyRevision> ListRevisions(string sandbox, PolicyListOptions? options = null)

Parameters

sandbox string

options PolicyListOptions

Returns

Pager<PolicyRevision>

RejectChunkAsync(string, string, string?, string?, CancellationToken)

Rejects one chunk with an optional reason that is surfaced back to the in-sandbox agent.

ValueTask RejectChunkAsync(string sandbox, string chunkId, string? reason = null, string? requestId = null, CancellationToken cancellationToken = default)

Parameters

sandbox string

chunkId string

reason string

requestId string

cancellationToken CancellationToken

Returns

ValueTask

UndoChunkAsync(string, string, string?, CancellationToken)

Reverses an approval, removing the merged rule from the active policy.

ValueTask<PolicyChangeResult> UndoChunkAsync(string sandbox, string chunkId, string? requestId = null, CancellationToken cancellationToken = default)

Parameters

sandbox string

chunkId string

requestId string

cancellationToken CancellationToken

Returns

ValueTask<PolicyChangeResult>