@terminal3/t3n-sdk 5.3.0 → 5.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cli/index.js +1 -1
- package/dist/index.d.ts +47 -0
- package/dist/index.esm.js +1 -1
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1327,6 +1327,15 @@ interface ListAgentsResponse {
|
|
|
1327
1327
|
agents: AgentSummary[];
|
|
1328
1328
|
/** Opaque cursor for the next page; absent on the last page. */
|
|
1329
1329
|
next_cursor?: string;
|
|
1330
|
+
/**
|
|
1331
|
+
* Members on THIS page that carry no kind row, so they appear in neither
|
|
1332
|
+
* `listAgents` nor `listHumanMembers`. Non-zero means the page is not the
|
|
1333
|
+
* whole membership — surface it rather than showing a silently short list.
|
|
1334
|
+
*
|
|
1335
|
+
* Absent when the environment runs a contract that predates the field; that
|
|
1336
|
+
* is "not reported", not "none".
|
|
1337
|
+
*/
|
|
1338
|
+
unclassified?: number;
|
|
1330
1339
|
}
|
|
1331
1340
|
/** A human member's org role. The closed wire domain of {@link HumanMember}. */
|
|
1332
1341
|
type MemberRole = "admin" | "member";
|
|
@@ -1359,6 +1368,15 @@ interface ListHumanMembersResponse {
|
|
|
1359
1368
|
members: HumanMember[];
|
|
1360
1369
|
/** Opaque cursor for the next page; absent on the last page. */
|
|
1361
1370
|
next_cursor?: string;
|
|
1371
|
+
/**
|
|
1372
|
+
* Members on THIS page that carry no kind row, so they appear in neither
|
|
1373
|
+
* `listAgents` nor `listHumanMembers`. Non-zero means the page is not the
|
|
1374
|
+
* whole membership — surface it rather than showing a silently short list.
|
|
1375
|
+
*
|
|
1376
|
+
* Absent when the environment runs a contract that predates the field; that
|
|
1377
|
+
* is "not reported", not "none".
|
|
1378
|
+
*/
|
|
1379
|
+
unclassified?: number;
|
|
1362
1380
|
}
|
|
1363
1381
|
/** Shallow runtime guard for {@link ListHumanMembersResponse}. */
|
|
1364
1382
|
declare function isListHumanMembersResponse(value: unknown): value is ListHumanMembersResponse;
|
|
@@ -5256,6 +5274,35 @@ declare class SessionUsageReportClient {
|
|
|
5256
5274
|
* org's usage.
|
|
5257
5275
|
*/
|
|
5258
5276
|
getOrgUsageReport(input: OrgUsageReportInput): Promise<OrgUsageReport>;
|
|
5277
|
+
/**
|
|
5278
|
+
* Fetch how many calls an organisation's members and their agents have
|
|
5279
|
+
* completed so far this calendar year (UTC).
|
|
5280
|
+
*
|
|
5281
|
+
* Counted by CALLER, not by contract owner, so calls into the platform's own
|
|
5282
|
+
* system contracts count as the organisation's usage. Unsuccessful calls and
|
|
5283
|
+
* admin-contract dispatches are excluded, the latter so that reading this
|
|
5284
|
+
* number does not increase it.
|
|
5285
|
+
*
|
|
5286
|
+
* Refuses with `not_org_admin: ...` when the authenticated session DID is
|
|
5287
|
+
* not in the org's admin set, exactly as {@link getOrgUsageReport} does.
|
|
5288
|
+
*/
|
|
5289
|
+
getOrgCallCountThisYear(orgDid: string): Promise<number>;
|
|
5290
|
+
/** As {@link getOrgCallCountThisYear}, for a given UTC calendar year. */
|
|
5291
|
+
getOrgCallCountForYear(orgDid: string, year: number): Promise<number>;
|
|
5292
|
+
/**
|
|
5293
|
+
* As {@link getOrgCallCountThisYear}, over an explicit `[fromMs, toMs)`
|
|
5294
|
+
* window in milliseconds.
|
|
5295
|
+
*
|
|
5296
|
+
* Pass whole UTC days (multiples of 86400000) unless you can live with a
|
|
5297
|
+
* figure wider than its label: the counter has day granularity, so the node
|
|
5298
|
+
* widens a ragged window to the days it touches and the count then includes
|
|
5299
|
+
* the hours either side of what was asked for.
|
|
5300
|
+
*
|
|
5301
|
+
* Throws when the window covers more active days than the node reads in one
|
|
5302
|
+
* call — roughly eleven years of unbroken daily use — rather than returning
|
|
5303
|
+
* the partial count the node reports. The year forms cannot reach that.
|
|
5304
|
+
*/
|
|
5305
|
+
getOrgCallCountForWindow(orgDid: string, fromMs: number, toMs: number): Promise<number>;
|
|
5259
5306
|
}
|
|
5260
5307
|
/**
|
|
5261
5308
|
* Construct a {@link SessionUsageReportClient} from a caller-owned
|