@terminal3/t3n-sdk 5.11.0 → 5.12.0

package/dist/index.d.ts

@@ -5610,16 +5610,14 @@ declare class SessionUsageReportClient {
      */
     getOrgUsageReport(input: OrgUsageReportInput): Promise<OrgUsageReport>;
     /**
-     * Fetch how many calls an organisation's members and their agents have
-     * completed so far this calendar year (UTC).
+     * How many protected-workflow executions the organisation has completed so
+     * far this calendar year (UTC).
      *
-     * Counted by CALLER, not by contract owner, so calls into the platform's own
-     * system contracts count as the organisation's usage. Unsuccessful calls and
-     * admin-contract dispatches are excluded, the latter so that reading this
-     * number does not increase it.
-     *
-     * Refuses with `not_org_admin: ...` when the authenticated session DID is
-     * not in the org's admin set, exactly as {@link getOrgUsageReport} does.
+     * A protected workflow is the organisation's **own** registered contract, so
+     * platform traffic — signing in, profile edits, credential issuance,
+     * organisation administration — leaves this untouched, as do unsuccessful
+     * executions. Attributed by caller, so an agent's land on its owner's org.
+     * Refuses with `not_org_admin: ...` off the org's admin set.
      */
     getOrgCallCountThisYear(orgDid: string): Promise<number>;
     /** As {@link getOrgCallCountThisYear}, for a given UTC calendar year. */
@@ -5639,25 +5637,19 @@ declare class SessionUsageReportClient {
      */
     getOrgCallCountForWindow(orgDid: string, fromMs: number, toMs: number): Promise<number>;
     /**
-     * How many calls the organisation's agents made over `[fromMs, toMs)` in
-     * milliseconds — **including the ones that were refused or failed**, since
-     * reviewing agents means seeing what they attempted.
-     *
-     * That makes this figure independent of {@link getOrgCallCountForWindow}
-     * rather than a share of it: a window of nothing but refused agent calls
-     * reads non-zero here and zero there, so do not render one as a percentage
-     * of the other. The node keeps them as two contract exports for that reason,
-     * and each reply carries only its own number — asking for both is two reads.
-     * Both do exclude administrative dispatches, this read included.
-     *
-     * Agent or person comes from the actor classification stamped on each call
-     * when it happened — a call an agent made before its DID was classified as
-     * one stays in the human share for ever.
-     *
-     * Same window rules, same `not_org_admin: ...` refusal, and the same throw
-     * on a window too wide to read in one call as
-     * {@link getOrgCallCountForWindow}. There is no calendar-year form: pass the
-     * window you want, on whole UTC days.
+     * How many protected-workflow executions the organisation's agents ran over
+     * `[fromMs, toMs)` — **refused and failed ones included**, since reviewing
+     * agents means seeing the attempts.
+     *
+     * So this is independent of {@link getOrgCallCountForWindow}, not a share of
+     * it: a window of nothing but refused executions reads non-zero here and
+     * zero there. Never render one as a percentage of the other. Separate reads,
+     * so both figures cost two calls.
+     *
+     * Agent or person comes from the actor classification stamped when the
+     * execution happened, and is never revised: one an agent ran before its DID
+     * was classified stays in the human share. Window rules, refusal and
+     * truncation throw are {@link getOrgCallCountForWindow}'s; no year form.
      */
     getOrgAgentCallCountForWindow(orgDid: string, fromMs: number, toMs: number): Promise<number>;
 }