shred-api-client 2.13.4 → 2.13.6

package/dist/index.d.ts

@@ -4669,6 +4669,25 @@ declare const ScoreHistoryEntrySchema: z.ZodObject<{
         key: string;
     } | undefined;
 }>;
+declare const ScoreMostSharedSchema: z.ZodObject<{
+    projectId: z.ZodString;
+    title: z.ZodString;
+    thumbnailUrl: z.ZodOptional<z.ZodString>;
+    previewGifUrl: z.ZodOptional<z.ZodString>;
+    shares: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    projectId: string;
+    shares: number;
+    thumbnailUrl?: string | undefined;
+    previewGifUrl?: string | undefined;
+}, {
+    title: string;
+    projectId: string;
+    shares: number;
+    thumbnailUrl?: string | undefined;
+    previewGifUrl?: string | undefined;
+}>;
 declare const ScoreRecapSchema: z.ZodObject<{
     current: z.ZodObject<{
         value: z.ZodNumber;
@@ -4897,6 +4916,26 @@ declare const ScoreRecapSchema: z.ZodObject<{
         max: number;
         key: string;
     }>, "many">;
+    /** Absent when nothing was downloaded or shared in the month. */
+    mostShared: z.ZodOptional<z.ZodObject<{
+        projectId: z.ZodString;
+        title: z.ZodString;
+        thumbnailUrl: z.ZodOptional<z.ZodString>;
+        previewGifUrl: z.ZodOptional<z.ZodString>;
+        shares: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        projectId: string;
+        shares: number;
+        thumbnailUrl?: string | undefined;
+        previewGifUrl?: string | undefined;
+    }, {
+        title: string;
+        projectId: string;
+        shares: number;
+        thumbnailUrl?: string | undefined;
+        previewGifUrl?: string | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     history: {
         value: number;
@@ -4952,6 +4991,13 @@ declare const ScoreRecapSchema: z.ZodObject<{
     }[];
     previousPeriod?: string | undefined;
     nextPeriod?: string | undefined;
+    mostShared?: {
+        title: string;
+        projectId: string;
+        shares: number;
+        thumbnailUrl?: string | undefined;
+        previewGifUrl?: string | undefined;
+    } | undefined;
 }, {
     history: {
         value: number;
@@ -5007,6 +5053,13 @@ declare const ScoreRecapSchema: z.ZodObject<{
     }[];
     previousPeriod?: string | undefined;
     nextPeriod?: string | undefined;
+    mostShared?: {
+        title: string;
+        projectId: string;
+        shares: number;
+        thumbnailUrl?: string | undefined;
+        previewGifUrl?: string | undefined;
+    } | undefined;
 }>;
 declare const ScoreGoalOptionSchema: z.ZodObject<{
     key: z.ZodString;
@@ -5471,6 +5524,7 @@ type ScoreMetric = z.infer<typeof ScoreMetricSchema>;
 type Score = z.infer<typeof ScoreSchema>;
 type ScoreHistoryEntry = z.infer<typeof ScoreHistoryEntrySchema>;
 type ScoreRecap = z.infer<typeof ScoreRecapSchema>;
+type ScoreMostShared = z.infer<typeof ScoreMostSharedSchema>;
 type ScoreProgressMetric = z.infer<typeof ScoreProgressMetricSchema>;
 type ScoreProjection = z.infer<typeof ScoreProjectionSchema>;
 type ScoreProgress = z.infer<typeof ScoreProgressSchema>;
@@ -5525,6 +5579,8 @@ type index$3_ScoreMetric = ScoreMetric;
 type index$3_ScoreMetricKey = ScoreMetricKey;
 declare const index$3_ScoreMetricKeySchema: typeof ScoreMetricKeySchema;
 declare const index$3_ScoreMetricSchema: typeof ScoreMetricSchema;
+type index$3_ScoreMostShared = ScoreMostShared;
+declare const index$3_ScoreMostSharedSchema: typeof ScoreMostSharedSchema;
 type index$3_ScoreProgress = ScoreProgress;
 type index$3_ScoreProgressMetric = ScoreProgressMetric;
 declare const index$3_ScoreProgressMetricSchema: typeof ScoreProgressMetricSchema;
@@ -5534,7 +5590,7 @@ declare const index$3_ScoreProjectionSchema: typeof ScoreProjectionSchema;
 declare const index$3_ScoreRecapSchema: typeof ScoreRecapSchema;
 declare const index$3_ScoreSchema: typeof ScoreSchema;
 declare namespace index$3 {
-  export { Endpoints$1 as Endpoints, type ScoreRecap as Entity, type IAPI$1 as IAPI, type index$3_Score as Score, type index$3_ScoreBand as ScoreBand, index$3_ScoreBandSchema as ScoreBandSchema, type index$3_ScoreGoal as ScoreGoal, type index$3_ScoreGoalOption as ScoreGoalOption, index$3_ScoreGoalOptionSchema as ScoreGoalOptionSchema, index$3_ScoreGoalSchema as ScoreGoalSchema, type index$3_ScoreHistoryEntry as ScoreHistoryEntry, index$3_ScoreHistoryEntrySchema as ScoreHistoryEntrySchema, type index$3_ScoreMetric as ScoreMetric, type index$3_ScoreMetricKey as ScoreMetricKey, index$3_ScoreMetricKeySchema as ScoreMetricKeySchema, index$3_ScoreMetricSchema as ScoreMetricSchema, type index$3_ScoreProgress as ScoreProgress, type index$3_ScoreProgressMetric as ScoreProgressMetric, index$3_ScoreProgressMetricSchema as ScoreProgressMetricSchema, index$3_ScoreProgressSchema as ScoreProgressSchema, type index$3_ScoreProjection as ScoreProjection, index$3_ScoreProjectionSchema as ScoreProjectionSchema, index$3_ScoreRecapSchema as ScoreRecapSchema, index$3_ScoreSchema as ScoreSchema };
+  export { Endpoints$1 as Endpoints, type ScoreRecap as Entity, type IAPI$1 as IAPI, type index$3_Score as Score, type index$3_ScoreBand as ScoreBand, index$3_ScoreBandSchema as ScoreBandSchema, type index$3_ScoreGoal as ScoreGoal, type index$3_ScoreGoalOption as ScoreGoalOption, index$3_ScoreGoalOptionSchema as ScoreGoalOptionSchema, index$3_ScoreGoalSchema as ScoreGoalSchema, type index$3_ScoreHistoryEntry as ScoreHistoryEntry, index$3_ScoreHistoryEntrySchema as ScoreHistoryEntrySchema, type index$3_ScoreMetric as ScoreMetric, type index$3_ScoreMetricKey as ScoreMetricKey, index$3_ScoreMetricKeySchema as ScoreMetricKeySchema, index$3_ScoreMetricSchema as ScoreMetricSchema, type index$3_ScoreMostShared as ScoreMostShared, index$3_ScoreMostSharedSchema as ScoreMostSharedSchema, type index$3_ScoreProgress as ScoreProgress, type index$3_ScoreProgressMetric as ScoreProgressMetric, index$3_ScoreProgressMetricSchema as ScoreProgressMetricSchema, index$3_ScoreProgressSchema as ScoreProgressSchema, type index$3_ScoreProjection as ScoreProjection, index$3_ScoreProjectionSchema as ScoreProjectionSchema, index$3_ScoreRecapSchema as ScoreRecapSchema, index$3_ScoreSchema as ScoreSchema };
 }
 
 /**
@@ -5626,6 +5682,7 @@ declare const Actions: {
     readonly USER_CHANGE_EMAIL: "user.change_email";
     readonly USER_GET_TOKEN: "user.get_token";
     readonly USER_CREATE_TOKEN: "user.create_token";
+    readonly KPI_VIEW: "kpi.view";
     readonly ROLE_MANAGE: "role.manage";
     readonly USER_ASSIGN_ROLE: "user.assign_role";
 };
@@ -5641,7 +5698,7 @@ type Scope = {
     type: "tenant";
     id: string;
 };
-type ActionGroup = "Projects" | "Editors" | "Goals" | "Notes" | "Notifications" | "Tenants" | "Offers" | "ShredU" | "Subscriptions" | "Scripts" | "Prompts" | "Email" | "Users" | "Administration";
+type ActionGroup = "Projects" | "Editors" | "Goals" | "Notes" | "Notifications" | "Tenants" | "Offers" | "ShredU" | "Subscriptions" | "Scripts" | "Prompts" | "Email" | "Users" | "KPIs" | "Administration";
 type ActionMeta = {
     label: string;
     group: ActionGroup;

package/dist/index.js

@@ -6350,6 +6350,13 @@ var ScoreHistoryEntrySchema = external_exports.object({
   value: external_exports.number(),
   band: ScoreBandSchema.optional()
 });
+var ScoreMostSharedSchema = external_exports.object({
+  projectId: external_exports.string(),
+  title: external_exports.string(),
+  thumbnailUrl: external_exports.string().optional(),
+  previewGifUrl: external_exports.string().optional(),
+  shares: external_exports.number()
+});
 var ScoreRecapSchema = external_exports.object({
   current: ScoreSchema,
   /** Oldest first. Months before the customer's first project are absent, not zero. */
@@ -6358,7 +6365,9 @@ var ScoreRecapSchema = external_exports.object({
   previousPeriod: external_exports.string().optional(),
   nextPeriod: external_exports.string().optional(),
   /** The whole score scale, lowest first. */
-  bands: external_exports.array(ScoreBandSchema)
+  bands: external_exports.array(ScoreBandSchema),
+  /** Absent when nothing was downloaded or shared in the month. */
+  mostShared: ScoreMostSharedSchema.optional()
 });
 var ScoreGoalOptionSchema = external_exports.object({
   key: external_exports.string(),
@@ -6545,6 +6554,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"
@@ -6642,6 +6653,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" }
@@ -7251,6 +7264,7 @@ __export(score_exports, {
   ScoreHistoryEntrySchema: () => ScoreHistoryEntrySchema,
   ScoreMetricKeySchema: () => ScoreMetricKeySchema,
   ScoreMetricSchema: () => ScoreMetricSchema,
+  ScoreMostSharedSchema: () => ScoreMostSharedSchema,
   ScoreProgressMetricSchema: () => ScoreProgressMetricSchema,
   ScoreProgressSchema: () => ScoreProgressSchema,
   ScoreProjectionSchema: () => ScoreProjectionSchema,