shred-api-client 2.10.6 → 2.11.0

package/dist/index.js

@@ -41,6 +41,7 @@ __export(index_exports, {
   Project: () => project_exports,
   Prompt: () => prompt_exports,
   RBAC: () => rbac_exports,
+  Score: () => score_exports,
   ShredAPI: () => ShredAPI,
   ShredU: () => shredu_exports,
   SpecialOffer: () => special_offer_exports,
@@ -6246,12 +6247,89 @@ var ShredUAPI = class {
 };
 var ShredU_api_default = ShredUAPI;
 
+// src/model/score/Score.api.ts
+var Endpoints10 = {
+  GetRecap: { uri: "/score/", method: "GET" }
+};
+
+// src/model/score/Score.schema.ts
+var ScoreMetricKeySchema = external_exports.enum([
+  "submissions",
+  "interactions",
+  "attendance"
+]);
+var ScoreBandSchema = external_exports.object({
+  key: external_exports.string(),
+  label: external_exports.string(),
+  min: external_exports.number(),
+  max: external_exports.number()
+});
+var ScoreMetricSchema = external_exports.object({
+  /**
+   * Deliberately not the enum: a metric added API-side must not break a client that
+   * predates it. Render the array generically and switch on ScoreMetricKey only where
+   * a known metric needs special treatment.
+   */
+  key: external_exports.string(),
+  /** The share this metric actually carried, after unavailable ones were left out. */
+  weight: external_exports.number(),
+  value: external_exports.number(),
+  target: external_exports.number(),
+  ratio: external_exports.number(),
+  available: external_exports.boolean(),
+  rating: ScoreBandSchema.optional()
+});
+var ScoreSchema = external_exports.object({
+  value: external_exports.number(),
+  hasData: external_exports.boolean(),
+  period: external_exports.string(),
+  periodLabel: external_exports.string(),
+  band: ScoreBandSchema.optional(),
+  nextBand: ScoreBandSchema.optional(),
+  pointsToNextBand: external_exports.number().optional(),
+  trend: external_exports.number().optional(),
+  computedAt: external_exports.number(),
+  metrics: external_exports.array(ScoreMetricSchema)
+});
+var ScoreHistoryEntrySchema = external_exports.object({
+  period: external_exports.string(),
+  label: external_exports.string(),
+  value: external_exports.number(),
+  band: ScoreBandSchema.optional()
+});
+var ScoreRecapSchema = external_exports.object({
+  current: ScoreSchema,
+  /** Oldest first. Months before the customer's first project are absent, not zero. */
+  history: external_exports.array(ScoreHistoryEntrySchema)
+});
+
+// src/api/Score.api.ts
+var ScoreAPI = class {
+  constructor(env) {
+    this.env = env;
+    this.clientHTTP = new HTTPClient();
+  }
+  async getRecap(ctx, period) {
+    const { uri, method } = Endpoints10.GetRecap;
+    const endpoint = period ? `${uri}?period=${encodeURIComponent(period)}` : uri;
+    return this.clientHTTP.makeRequest(
+      this.env,
+      endpoint,
+      method,
+      null,
+      ctx,
+      ScoreRecapSchema
+    );
+  }
+};
+var Score_api_default = ScoreAPI;
+
 // src/model/rbac/index.ts
 var rbac_exports = {};
 __export(rbac_exports, {
   ActionCatalog: () => ActionCatalog,
   Actions: () => Actions,
-  Endpoints: () => Endpoints10,
+  Endpoints: () => Endpoints11,
   PrincipalSchema: () => PrincipalSchema,
   RoleAssignmentSchema: () => RoleAssignmentSchema,
   RoleGrantSchema: () => RoleGrantSchema,
@@ -6495,7 +6573,7 @@ var PrincipalSchema = external_exports.object({
 });
 
 // src/model/rbac/RBAC.api.ts
-var Endpoints10 = {
+var Endpoints11 = {
   GetActions: { uri: "/rbac/actions", method: "GET" },
   ListRoles: { uri: "/rbac/roles", method: "GET" },
   CreateRole: { uri: "/rbac/roles", method: "POST" },
@@ -6514,29 +6592,29 @@ var RBACAPI = class {
     this.clientHTTP = new HTTPClient();
   }
   async getActions(c) {
-    const e = Endpoints10.GetActions;
+    const e = Endpoints11.GetActions;
     return this.clientHTTP.makeRequest(this.env, e.uri, e.method, null, c);
   }
   async listRoles(c) {
-    const e = Endpoints10.ListRoles;
+    const e = Endpoints11.ListRoles;
     return this.clientHTTP.makeRequest(this.env, e.uri, e.method, null, c, external_exports.array(RoleSchema));
   }
   async createRole(c, input) {
-    const e = Endpoints10.CreateRole;
+    const e = Endpoints11.CreateRole;
     return this.clientHTTP.makeRequest(this.env, e.uri, e.method, input, c, RoleSchema);
   }
   async updateRole(c, roleId, input) {
-    const e = Endpoints10.UpdateRole;
+    const e = Endpoints11.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 = Endpoints10.DeleteRole;
+    const e = Endpoints11.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 = Endpoints10.GetAssignments;
+    const e = Endpoints11.GetAssignments;
     const uri = e.uri.replace(":uid", uid);
     return this.clientHTTP.makeRequest(
       this.env,
@@ -6548,17 +6626,17 @@ var RBACAPI = class {
     );
   }
   async assign(c, uid, input) {
-    const e = Endpoints10.Assign;
+    const e = Endpoints11.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 = Endpoints10.Unassign;
+    const e = Endpoints11.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 = Endpoints10.SearchPrincipals;
+    const e = Endpoints11.SearchPrincipals;
     const uri = `${e.uri}?q=${encodeURIComponent(term)}`;
     return this.clientHTTP.makeRequest(this.env, uri, e.method, null, c, external_exports.array(PrincipalSchema));
   }
@@ -6582,6 +6660,7 @@ var ShredAPI = class {
     this.note = new Note_api_default(env);
     this.specialOffer = new SpecialOffer_api_default(env);
     this.shredu = new ShredU_api_default(env);
+    this.score = new Score_api_default(env);
     this.rbac = new RBAC_api_default(env);
   }
 };
@@ -6601,7 +6680,7 @@ __export(exceptions_exports, {
 var prompt_exports = {};
 __export(prompt_exports, {
   CategorySchema: () => CategorySchema,
-  Endpoints: () => Endpoints11,
+  Endpoints: () => Endpoints12,
   PromptSchema: () => PromptSchema,
   ScriptIARequestSchema: () => ScriptIARequestSchema,
   ScriptSchema: () => ScriptSchema
@@ -6637,7 +6716,7 @@ var PromptSchema = external_exports.object({
 });
 
 // src/model/prompt/Prompt.api.ts
-var Endpoints11 = {
+var Endpoints12 = {
   GetPrompt: {
     uri: "/prompts/getPrompt",
     method: "GET"
@@ -6668,7 +6747,7 @@ var Endpoints11 = {
 var tenant_exports = {};
 __export(tenant_exports, {
   Action: () => Action,
-  Endpoints: () => Endpoints12,
+  Endpoints: () => Endpoints13,
   MemberSchema: () => MemberSchema,
   MemberUpdateSchema: () => MemberUpdateSchema,
   PreferencesSchema: () => PreferencesSchema,
@@ -6799,7 +6878,7 @@ var TenantUpdateSchema = TenantSchema.pick({
 }).partial();
 
 // src/model/tenant/Tenant.api.ts
-var Endpoints12 = {
+var Endpoints13 = {
   GetByInviteCode: {
     uri: "/tenants/public/invitation/",
     method: "GET"
@@ -6837,7 +6916,7 @@ var Endpoints12 = {
 // src/model/user/index.ts
 var user_exports = {};
 __export(user_exports, {
-  Endpoints: () => Endpoints13,
+  Endpoints: () => Endpoints14,
   PreferencesSchema: () => PreferencesSchema2,
   Role: () => Role,
   System: () => System,
@@ -6892,7 +6971,7 @@ var UserSchema = external_exports.object({
 });
 
 // src/model/user/User.api.ts
-var Endpoints13 = {
+var Endpoints14 = {
   ChangeEmail: { uri: "/accounts/user/changeEmail", method: "PUT" },
   GetUserInfo: { uri: "/accounts/user/info", method: "GET" },
   GetBindedUsers: { uri: "/accounts/binded/list", method: "GET" },
@@ -6915,7 +6994,7 @@ var Endpoints13 = {
 var subscription_exports = {};
 __export(subscription_exports, {
   ChargeSchema: () => ChargeSchema,
-  Endpoints: () => Endpoints14,
+  Endpoints: () => Endpoints15,
   PlanSchema: () => PlanSchema,
   ProductSchema: () => ProductSchema,
   SubscriptionSchema: () => SubscriptionSchema,
@@ -6924,7 +7003,7 @@ __export(subscription_exports, {
 });
 
 // src/model/subscription/Subscription.api.ts
-var Endpoints14 = {
+var Endpoints15 = {
   GetPortal: {
     uri: "/subscriptions/portal/",
     method: "GET"
@@ -6986,7 +7065,7 @@ var Endpoints14 = {
 // src/model/track/index.ts
 var track_exports = {};
 __export(track_exports, {
-  Endpoints: () => Endpoints15,
+  Endpoints: () => Endpoints16,
   TrackParamSchema: () => TrackParamSchema,
   TrackSchema: () => TrackSchema
 });
@@ -7004,7 +7083,7 @@ var TrackSchema = external_exports.object({
 });
 
 // src/model/track/Track.api.ts
-var Endpoints15 = {
+var Endpoints16 = {
   Track: {
     uri: "/track/public/send/",
     method: "POST"
@@ -7041,6 +7120,18 @@ __export(shredu_exports, {
   UpdateShredUSessionSchema: () => UpdateShredUSessionSchema
 });
 
+// src/model/score/index.ts
+var score_exports = {};
+__export(score_exports, {
+  Endpoints: () => Endpoints10,
+  ScoreBandSchema: () => ScoreBandSchema,
+  ScoreHistoryEntrySchema: () => ScoreHistoryEntrySchema,
+  ScoreMetricKeySchema: () => ScoreMetricKeySchema,
+  ScoreMetricSchema: () => ScoreMetricSchema,
+  ScoreRecapSchema: () => ScoreRecapSchema,
+  ScoreSchema: () => ScoreSchema
+});
+
 // src/index.ts
 var index_default = ShredAPI;
 //# sourceMappingURL=index.js.map