Interface CloudSupportApi

Community issue reads/writes. Every method resolves a typed union — a refusal is DATA the app branches on, never a thrown transport error.

interface CloudSupportApi {
    collectEvidence(): Promise<CloudSupportEvidenceCollectResult>;
    createIssue(
        args: CloudSupportIssueCreateArgs,
    ): Promise<CloudSupportIssueCreateResult>;
    getIssue(ref: string): Promise<CloudSupportIssueResult>;
    listIssues(
        args?: CloudSupportIssueListArgs,
    ): Promise<CloudSupportIssueListResult>;
    markAffected(
        ref: string,
        affected: boolean,
    ): Promise<CloudSupportAffectedResult>;
    setIssueStatus(
        ref: string,
        status:
            | "fixed"
            | "open"
            | "in-progress"
            | "closed"
            | "needs-info"
            | "confirmed",
    ): Promise<CloudSupportIssueStatusResult>;
}

Index

Methods

collectEvidence createIssue getIssue listIssues markAffected setIssueStatus

Methods

collectEvidence

collectEvidence(): Promise<CloudSupportEvidenceCollectResult>

Open the host evidence composer. Resolves opaque refs, never bytes.

Returns Promise<CloudSupportEvidenceCollectResult>

createIssue

createIssue(
args: CloudSupportIssueCreateArgs,
): Promise<CloudSupportIssueCreateResult>
File a new issue. Rate-limited per account by the cloud API; at most 8 evidence refs, and a banned account is refused with banned.
Parameters
- args: CloudSupportIssueCreateArgs
Returns Promise<CloudSupportIssueCreateResult>

getIssue

getIssue(ref: string): Promise<CloudSupportIssueResult>
Read one issue. Available to signed-out readers; evidence comes back only for the reporter or an operator.
Parameters
- ref: string
Returns Promise<CloudSupportIssueResult>

listIssues

listIssues(
args?: CloudSupportIssueListArgs,
): Promise<CloudSupportIssueListResult>
List public issues, newest first. Available to signed-out readers; the result's viewer posture says whether account-scoped actions are available.
Parameters
- Optionalargs: CloudSupportIssueListArgs
Returns Promise<CloudSupportIssueListResult>

markAffected

markAffected(
ref: string,
affected: boolean,
): Promise<CloudSupportAffectedResult>
Add/remove the signed-in account from an issue's affected list. The reporter is always counted, so un-affecting is a no-op for them.
Parameters
- ref: string
- affected: boolean
Returns Promise<CloudSupportAffectedResult>

setIssueStatus

setIssueStatus(
    ref: string,
    status:
        | "fixed"
        | "open"
        | "in-progress"
        | "closed"
        | "needs-info"
        | "confirmed",
): Promise<CloudSupportIssueStatusResult>
Operator-only triage write; anyone else gets not-operator.
Parameters
- ref: string
- status: "fixed" | "open" | "in-progress" | "closed" | "needs-info" | "confirmed"
Returns Promise<CloudSupportIssueStatusResult>