@terminal3/t3n-sdk 5.13.0 → 5.14.0

package/dist/index.d.ts

@@ -5612,48 +5612,41 @@ declare class SessionUsageReportClient {
      */
     getOrgUsageReport(input: OrgUsageReportInput): Promise<OrgUsageReport>;
     /**
-     * How many protected-workflow executions the organisation has completed so
-     * far this calendar year (UTC).
+     * How many protected-workflow executions the organisation's agents ran over
+     * `[fromMs, toMs)`, in milliseconds. Reads the `org-call-count` export.
      *
-     * 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. */
-    getOrgCallCountForYear(orgDid: string, year: number): Promise<number>;
-    /**
-     * As {@link getOrgCallCountThisYear}, over an explicit `[fromMs, toMs)`
-     * window in milliseconds.
+     * A protected workflow is an agent's call to a client contract (`z:` /
+     * `y:`), however it ended: a business-logic failure or a
+     * refused grant is still an execution the agent attempted. Platform traffic
+     * — signing in, profile edits, credential issuance, organisation
+     * administration — and a member's own calls leave this untouched.
+     * Attributed by caller, so an agent's land on its owner's org. Refuses with
+     * `not_org_admin: ...` off the org's admin set.
      *
      * Pass whole UTC days (multiples of 86400000) unless you can live with a
      * figure wider than its label: the counter has day granularity, so the node
      * widens a ragged window to the days it touches and the count then includes
-     * the hours either side of what was asked for.
+     * the hours either side of what was asked for. A calendar year is
+     * `[Date.UTC(y, 0, 1), Date.UTC(y + 1, 0, 1))`.
      *
      * Throws when the window covers more active days than the node reads in one
      * call — roughly eleven years of unbroken daily use — rather than returning
-     * the partial count the node reports. The year forms cannot reach that.
+     * the partial count the node reports.
      */
-    getOrgCallCountForWindow(orgDid: string, fromMs: number, toMs: number): Promise<number>;
+    getOrgWorkflowExecutionsForWindow(orgDid: string, fromMs: number, toMs: number): Promise<number>;
     /**
-     * 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.
+     * How many calls the organisation's agents made over `[fromMs, toMs)` —
+     * every contract, platform ones included, every outcome. The rows
+     * {@link getActivityLog} returns under `caller_type: "agent"`, so the two
+     * agree on a window of whole UTC days, where
+     * {@link getOrgWorkflowExecutionsForWindow} admits protected
+     * workflows alone. A person's calls are in neither figure, which is also why
+     * opening the usage page does not move them.
      *
-     * 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.
+     * Window rules, refusal and truncation throw are
+     * {@link getOrgWorkflowExecutionsForWindow}'s.
      */
-    getOrgAgentCallCountForWindow(orgDid: string, fromMs: number, toMs: number): Promise<number>;
+    getOrgActivityCountForWindow(orgDid: string, fromMs: number, toMs: number): Promise<number>;
 }
 /**
  * Construct a {@link SessionUsageReportClient} from a caller-owned