shred-api-client 2.13.5 → 2.14.0

package/dist/index.js

@@ -36,6 +36,7 @@ __export(index_exports, {
   Email: () => email_exports,
   Exceptions: () => exceptions_exports,
   Goal: () => goal_exports,
+  Kpi: () => kpi_exports,
   Note: () => note_exports,
   Notification: () => notification_exports,
   Project: () => project_exports,
@@ -6445,12 +6446,88 @@ var ScoreAPI = class {
 };
 var Score_api_default = ScoreAPI;
 
+// src/model/kpi/Kpi.api.ts
+var Endpoints11 = {
+  ListBoards: { uri: "/kpis/boards/", method: "GET" },
+  GetBoard: { uri: "/kpis/boards/:board/", method: "GET" }
+};
+
+// src/model/kpi/Kpi.schema.ts
+var KpiBoardSchema = external_exports.object({
+  id: external_exports.string(),
+  kpiCount: external_exports.number()
+});
+var KpiEntrySchema = external_exports.object({
+  kpiId: external_exports.string(),
+  kpiName: external_exports.string(),
+  category: external_exports.string(),
+  /** `num`, `pct` (percentage points: 5.5 means 5.5%), `dec`, `score`, `stars` or `usd`. */
+  unit: external_exports.string(),
+  /** `up` or `down`. */
+  better: external_exports.string(),
+  /** `stock` (level at the end of the month), `flow` (volume in the month) or `rate`. */
+  kpiType: external_exports.string(),
+  sortOrder: external_exports.number().nullable(),
+  /** YYYY-MM-DD, always the first day of the month. */
+  periodStart: external_exports.string(),
+  actualValue: external_exports.number().nullable(),
+  targetValue: external_exports.number().nullable(),
+  /** `typed` or `derived` (from the plan assumptions). */
+  targetSource: external_exports.string().nullable(),
+  /** Only alongside a typed target. */
+  baseline: external_exports.number().nullable(),
+  /** True for the month still being lived. */
+  isPartial: external_exports.boolean(),
+  /** `no_data`, `no_target`, `in_progress`, `met` or `missed`. */
+  status: external_exports.string(),
+  /** Against the previous month's value. */
+  delta: external_exports.number().nullable(),
+  /** Direction-aware: at or above 1 means the target was met, whichever way `better` points. */
+  attainment: external_exports.number().nullable()
+});
+var KpiMonthSummarySchema = external_exports.object({
+  periodStart: external_exports.string(),
+  met: external_exports.number(),
+  missed: external_exports.number(),
+  judged: external_exports.number(),
+  inProgress: external_exports.number(),
+  noTarget: external_exports.number(),
+  noData: external_exports.number(),
+  /** Null when no KPI was judged in the month. */
+  scoreOutOf10: external_exports.number().nullable()
+});
+var KpiBoardHistorySchema = external_exports.object({
+  board: external_exports.string(),
+  /** ISO timestamp of the last automatic calculation. */
+  calculatedAt: external_exports.string().nullable(),
+  entries: external_exports.array(KpiEntrySchema),
+  summaries: external_exports.array(KpiMonthSummarySchema)
+});
+
+// src/api/Kpi.api.ts
+var KpiAPI = class {
+  constructor(env) {
+    this.env = env;
+    this.clientHTTP = new HTTPClient();
+  }
+  async listBoards(ctx) {
+    const { uri, method } = Endpoints11.ListBoards;
+    return this.clientHTTP.makeRequest(this.env, uri, method, null, ctx, external_exports.array(KpiBoardSchema));
+  }
+  async getBoard(ctx, board) {
+    const { uri, method } = Endpoints11.GetBoard;
+    const endpoint = uri.replace(":board", encodeURIComponent(board));
+    return this.clientHTTP.makeRequest(this.env, endpoint, method, null, ctx, KpiBoardHistorySchema);
+  }
+};
+var Kpi_api_default = KpiAPI;
+
 // src/model/rbac/index.ts
 var rbac_exports = {};
 __export(rbac_exports, {
   ActionCatalog: () => ActionCatalog,
   Actions: () => Actions,
-  Endpoints: () => Endpoints11,
+  Endpoints: () => Endpoints12,
   PrincipalSchema: () => PrincipalSchema,
   RoleAssignmentSchema: () => RoleAssignmentSchema,
   RoleGrantSchema: () => RoleGrantSchema,
@@ -6554,6 +6631,8 @@ var Actions = {
   USER_CHANGE_EMAIL: "user.change_email",
   USER_GET_TOKEN: "user.get_token",
   USER_CREATE_TOKEN: "user.create_token",
+  // — KPIs —
+  KPI_VIEW: "kpi.view",
   // — RBAC administration —
   ROLE_MANAGE: "role.manage",
   USER_ASSIGN_ROLE: "user.assign_role"
@@ -6651,6 +6730,8 @@ var ActionCatalog = {
   [Actions.USER_CHANGE_EMAIL]: { label: "Change your own email", group: "Users" },
   [Actions.USER_GET_TOKEN]: { label: "Get your own API token", group: "Users" },
   [Actions.USER_CREATE_TOKEN]: { label: "Create your own API token", group: "Users" },
+  // KPIs
+  [Actions.KPI_VIEW]: { label: "View the KPI scorecards", group: "KPIs" },
   // Administration
   [Actions.ROLE_MANAGE]: { label: "Manage roles (create, edit, delete)", group: "Administration" },
   [Actions.USER_ASSIGN_ROLE]: { label: "Assign roles to users", group: "Administration" }
@@ -6696,7 +6777,7 @@ var PrincipalSchema = external_exports.object({
 });
 
 // src/model/rbac/RBAC.api.ts
-var Endpoints11 = {
+var Endpoints12 = {
   GetActions: { uri: "/rbac/actions", method: "GET" },
   ListRoles: { uri: "/rbac/roles", method: "GET" },
   CreateRole: { uri: "/rbac/roles", method: "POST" },
@@ -6715,29 +6796,29 @@ var RBACAPI = class {
     this.clientHTTP = new HTTPClient();
   }
   async getActions(c) {
-    const e = Endpoints11.GetActions;
+    const e = Endpoints12.GetActions;
     return this.clientHTTP.makeRequest(this.env, e.uri, e.method, null, c);
   }
   async listRoles(c) {
-    const e = Endpoints11.ListRoles;
+    const e = Endpoints12.ListRoles;
     return this.clientHTTP.makeRequest(this.env, e.uri, e.method, null, c, external_exports.array(RoleSchema));
   }
   async createRole(c, input) {
-    const e = Endpoints11.CreateRole;
+    const e = Endpoints12.CreateRole;
     return this.clientHTTP.makeRequest(this.env, e.uri, e.method, input, c, RoleSchema);
   }
   async updateRole(c, roleId, input) {
-    const e = Endpoints11.UpdateRole;
+    const e = Endpoints12.UpdateRole;
     const uri = e.uri.replace(":roleId", roleId);
     return this.clientHTTP.makeRequest(this.env, uri, e.method, input, c, RoleSchema);
   }
   async deleteRole(c, roleId) {
-    const e = Endpoints11.DeleteRole;
+    const e = Endpoints12.DeleteRole;
     const uri = e.uri.replace(":roleId", roleId);
     return this.clientHTTP.makeRequest(this.env, uri, e.method, null, c, external_exports.boolean());
   }
   async getAssignments(c, uid) {
-    const e = Endpoints11.GetAssignments;
+    const e = Endpoints12.GetAssignments;
     const uri = e.uri.replace(":uid", uid);
     return this.clientHTTP.makeRequest(
       this.env,
@@ -6749,17 +6830,17 @@ var RBACAPI = class {
     );
   }
   async assign(c, uid, input) {
-    const e = Endpoints11.Assign;
+    const e = Endpoints12.Assign;
     const uri = e.uri.replace(":uid", uid);
     return this.clientHTTP.makeRequest(this.env, uri, e.method, input, c, RoleAssignmentSchema);
   }
   async unassign(c, uid, input) {
-    const e = Endpoints11.Unassign;
+    const e = Endpoints12.Unassign;
     const uri = e.uri.replace(":uid", uid);
     return this.clientHTTP.makeRequest(this.env, uri, e.method, input, c, RoleAssignmentSchema);
   }
   async searchPrincipals(c, term) {
-    const e = Endpoints11.SearchPrincipals;
+    const e = Endpoints12.SearchPrincipals;
     const uri = `${e.uri}?q=${encodeURIComponent(term)}`;
     return this.clientHTTP.makeRequest(this.env, uri, e.method, null, c, external_exports.array(PrincipalSchema));
   }
@@ -6784,6 +6865,7 @@ var ShredAPI = class {
     this.specialOffer = new SpecialOffer_api_default(env);
     this.shredu = new ShredU_api_default(env);
     this.score = new Score_api_default(env);
+    this.kpi = new Kpi_api_default(env);
     this.rbac = new RBAC_api_default(env);
   }
 };
@@ -6803,7 +6885,7 @@ __export(exceptions_exports, {
 var prompt_exports = {};
 __export(prompt_exports, {
   CategorySchema: () => CategorySchema,
-  Endpoints: () => Endpoints12,
+  Endpoints: () => Endpoints13,
   PromptSchema: () => PromptSchema,
   ScriptIARequestSchema: () => ScriptIARequestSchema,
   ScriptSchema: () => ScriptSchema
@@ -6839,7 +6921,7 @@ var PromptSchema = external_exports.object({
 });
 
 // src/model/prompt/Prompt.api.ts
-var Endpoints12 = {
+var Endpoints13 = {
   GetPrompt: {
     uri: "/prompts/getPrompt",
     method: "GET"
@@ -6870,7 +6952,7 @@ var Endpoints12 = {
 var tenant_exports = {};
 __export(tenant_exports, {
   Action: () => Action,
-  Endpoints: () => Endpoints13,
+  Endpoints: () => Endpoints14,
   MemberSchema: () => MemberSchema,
   MemberUpdateSchema: () => MemberUpdateSchema,
   PreferencesSchema: () => PreferencesSchema,
@@ -7001,7 +7083,7 @@ var TenantUpdateSchema = TenantSchema.pick({
 }).partial();
 
 // src/model/tenant/Tenant.api.ts
-var Endpoints13 = {
+var Endpoints14 = {
   GetByInviteCode: {
     uri: "/tenants/public/invitation/",
     method: "GET"
@@ -7043,7 +7125,7 @@ var Endpoints13 = {
 // src/model/user/index.ts
 var user_exports = {};
 __export(user_exports, {
-  Endpoints: () => Endpoints14,
+  Endpoints: () => Endpoints15,
   PreferencesSchema: () => PreferencesSchema2,
   Role: () => Role,
   System: () => System,
@@ -7098,7 +7180,7 @@ var UserSchema = external_exports.object({
 });
 
 // src/model/user/User.api.ts
-var Endpoints14 = {
+var Endpoints15 = {
   ChangeEmail: { uri: "/accounts/user/changeEmail", method: "PUT" },
   GetUserInfo: { uri: "/accounts/user/info", method: "GET" },
   GetBindedUsers: { uri: "/accounts/binded/list", method: "GET" },
@@ -7121,7 +7203,7 @@ var Endpoints14 = {
 var subscription_exports = {};
 __export(subscription_exports, {
   ChargeSchema: () => ChargeSchema,
-  Endpoints: () => Endpoints15,
+  Endpoints: () => Endpoints16,
   PlanSchema: () => PlanSchema,
   ProductSchema: () => ProductSchema,
   SubscriptionSchema: () => SubscriptionSchema,
@@ -7130,7 +7212,7 @@ __export(subscription_exports, {
 });
 
 // src/model/subscription/Subscription.api.ts
-var Endpoints15 = {
+var Endpoints16 = {
   GetPortal: {
     uri: "/subscriptions/portal/",
     method: "GET"
@@ -7192,7 +7274,7 @@ var Endpoints15 = {
 // src/model/track/index.ts
 var track_exports = {};
 __export(track_exports, {
-  Endpoints: () => Endpoints16,
+  Endpoints: () => Endpoints17,
   TrackParamSchema: () => TrackParamSchema,
   TrackSchema: () => TrackSchema
 });
@@ -7210,7 +7292,7 @@ var TrackSchema = external_exports.object({
 });
 
 // src/model/track/Track.api.ts
-var Endpoints16 = {
+var Endpoints17 = {
   Track: {
     uri: "/track/public/send/",
     method: "POST"
@@ -7268,6 +7350,16 @@ __export(score_exports, {
   ScoreSchema: () => ScoreSchema
 });
 
+// src/model/kpi/index.ts
+var kpi_exports = {};
+__export(kpi_exports, {
+  Endpoints: () => Endpoints11,
+  KpiBoardHistorySchema: () => KpiBoardHistorySchema,
+  KpiBoardSchema: () => KpiBoardSchema,
+  KpiEntrySchema: () => KpiEntrySchema,
+  KpiMonthSummarySchema: () => KpiMonthSummarySchema
+});
+
 // src/index.ts
 var index_default = ShredAPI;
 //# sourceMappingURL=index.js.map