shred-api-client 2.12.0 → 2.12.2

package/dist/index.d.ts

@@ -4452,49 +4452,6 @@ declare const ScoreMetricSchema: z.ZodObject<{
         key: string;
     } | undefined;
 }>;
-/** The month's score as if it had ended on `day`. The last point equals the month's value. */
-declare const ScoreDaySchema: z.ZodObject<{
-    day: z.ZodNumber;
-    value: z.ZodNumber;
-}, "strip", z.ZodTypeAny, {
-    value: number;
-    day: number;
-}, {
-    value: number;
-    day: number;
-}>;
-/** The month before, for the day-by-day chart. `value` is the score `trend` is measured from. */
-declare const ScoreComparisonSchema: z.ZodObject<{
-    period: z.ZodString;
-    periodLabel: z.ZodString;
-    value: z.ZodNumber;
-    daily: z.ZodArray<z.ZodObject<{
-        day: z.ZodNumber;
-        value: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        value: number;
-        day: number;
-    }, {
-        value: number;
-        day: number;
-    }>, "many">;
-}, "strip", z.ZodTypeAny, {
-    daily: {
-        value: number;
-        day: number;
-    }[];
-    value: number;
-    period: string;
-    periodLabel: string;
-}, {
-    daily: {
-        value: number;
-        day: number;
-    }[];
-    value: number;
-    period: string;
-    periodLabel: string;
-}>;
 declare const ScoreSchema: z.ZodObject<{
     value: z.ZodNumber;
     hasData: z.ZodBoolean;
@@ -4591,54 +4548,11 @@ declare const ScoreSchema: z.ZodObject<{
             key: string;
         } | undefined;
     }>, "many">;
-    /** Served on the recap's `current` only. */
-    daily: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        day: z.ZodNumber;
-        value: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        value: number;
-        day: number;
-    }, {
-        value: number;
-        day: number;
-    }>, "many">>;
-    /** Absent when the month before predates the customer's first project. */
-    comparison: z.ZodOptional<z.ZodObject<{
-        period: z.ZodString;
-        periodLabel: z.ZodString;
-        value: z.ZodNumber;
-        daily: z.ZodArray<z.ZodObject<{
-            day: z.ZodNumber;
-            value: z.ZodNumber;
-        }, "strip", z.ZodTypeAny, {
-            value: number;
-            day: number;
-        }, {
-            value: number;
-            day: number;
-        }>, "many">;
-    }, "strip", z.ZodTypeAny, {
-        daily: {
-            value: number;
-            day: number;
-        }[];
-        value: number;
-        period: string;
-        periodLabel: string;
-    }, {
-        daily: {
-            value: number;
-            day: number;
-        }[];
-        value: number;
-        period: string;
-        periodLabel: string;
-    }>>;
 }, "strip", z.ZodTypeAny, {
     value: number;
+    hasData: boolean;
     period: string;
     periodLabel: string;
-    hasData: boolean;
     computedAt: number;
     metrics: {
         value: number;
@@ -4654,10 +4568,6 @@ declare const ScoreSchema: z.ZodObject<{
             key: string;
         } | undefined;
     }[];
-    daily?: {
-        value: number;
-        day: number;
-    }[] | undefined;
     band?: {
         label: string;
         min: number;
@@ -4672,20 +4582,11 @@ declare const ScoreSchema: z.ZodObject<{
     } | undefined;
     pointsToNextBand?: number | undefined;
     trend?: number | undefined;
-    comparison?: {
-        daily: {
-            value: number;
-            day: number;
-        }[];
-        value: number;
-        period: string;
-        periodLabel: string;
-    } | undefined;
 }, {
     value: number;
+    hasData: boolean;
     period: string;
     periodLabel: string;
-    hasData: boolean;
     computedAt: number;
     metrics: {
         value: number;
@@ -4701,10 +4602,6 @@ declare const ScoreSchema: z.ZodObject<{
             key: string;
         } | undefined;
     }[];
-    daily?: {
-        value: number;
-        day: number;
-    }[] | undefined;
     band?: {
         label: string;
         min: number;
@@ -4719,15 +4616,6 @@ declare const ScoreSchema: z.ZodObject<{
     } | undefined;
     pointsToNextBand?: number | undefined;
     trend?: number | undefined;
-    comparison?: {
-        daily: {
-            value: number;
-            day: number;
-        }[];
-        value: number;
-        period: string;
-        periodLabel: string;
-    } | undefined;
 }>;
 declare const ScoreHistoryEntrySchema: z.ZodObject<{
     period: z.ZodString;
@@ -4867,54 +4755,11 @@ declare const ScoreRecapSchema: z.ZodObject<{
                 key: string;
             } | undefined;
         }>, "many">;
-        /** Served on the recap's `current` only. */
-        daily: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            day: z.ZodNumber;
-            value: z.ZodNumber;
-        }, "strip", z.ZodTypeAny, {
-            value: number;
-            day: number;
-        }, {
-            value: number;
-            day: number;
-        }>, "many">>;
-        /** Absent when the month before predates the customer's first project. */
-        comparison: z.ZodOptional<z.ZodObject<{
-            period: z.ZodString;
-            periodLabel: z.ZodString;
-            value: z.ZodNumber;
-            daily: z.ZodArray<z.ZodObject<{
-                day: z.ZodNumber;
-                value: z.ZodNumber;
-            }, "strip", z.ZodTypeAny, {
-                value: number;
-                day: number;
-            }, {
-                value: number;
-                day: number;
-            }>, "many">;
-        }, "strip", z.ZodTypeAny, {
-            daily: {
-                value: number;
-                day: number;
-            }[];
-            value: number;
-            period: string;
-            periodLabel: string;
-        }, {
-            daily: {
-                value: number;
-                day: number;
-            }[];
-            value: number;
-            period: string;
-            periodLabel: string;
-        }>>;
     }, "strip", z.ZodTypeAny, {
         value: number;
+        hasData: boolean;
         period: string;
         periodLabel: string;
-        hasData: boolean;
         computedAt: number;
         metrics: {
             value: number;
@@ -4930,10 +4775,6 @@ declare const ScoreRecapSchema: z.ZodObject<{
                 key: string;
             } | undefined;
         }[];
-        daily?: {
-            value: number;
-            day: number;
-        }[] | undefined;
         band?: {
             label: string;
             min: number;
@@ -4948,20 +4789,11 @@ declare const ScoreRecapSchema: z.ZodObject<{
         } | undefined;
         pointsToNextBand?: number | undefined;
         trend?: number | undefined;
-        comparison?: {
-            daily: {
-                value: number;
-                day: number;
-            }[];
-            value: number;
-            period: string;
-            periodLabel: string;
-        } | undefined;
     }, {
         value: number;
+        hasData: boolean;
         period: string;
         periodLabel: string;
-        hasData: boolean;
         computedAt: number;
         metrics: {
             value: number;
@@ -4977,10 +4809,6 @@ declare const ScoreRecapSchema: z.ZodObject<{
                 key: string;
             } | undefined;
         }[];
-        daily?: {
-            value: number;
-            day: number;
-        }[] | undefined;
         band?: {
             label: string;
             min: number;
@@ -4995,15 +4823,6 @@ declare const ScoreRecapSchema: z.ZodObject<{
         } | undefined;
         pointsToNextBand?: number | undefined;
         trend?: number | undefined;
-        comparison?: {
-            daily: {
-                value: number;
-                day: number;
-            }[];
-            value: number;
-            period: string;
-            periodLabel: string;
-        } | undefined;
     }>;
     /** Oldest first. Months before the customer's first project are absent, not zero. */
     history: z.ZodArray<z.ZodObject<{
@@ -5064,9 +4883,9 @@ declare const ScoreRecapSchema: z.ZodObject<{
     }[];
     current: {
         value: number;
+        hasData: boolean;
         period: string;
         periodLabel: string;
-        hasData: boolean;
         computedAt: number;
         metrics: {
             value: number;
@@ -5082,10 +4901,6 @@ declare const ScoreRecapSchema: z.ZodObject<{
                 key: string;
             } | undefined;
         }[];
-        daily?: {
-            value: number;
-            day: number;
-        }[] | undefined;
         band?: {
             label: string;
             min: number;
@@ -5100,15 +4915,6 @@ declare const ScoreRecapSchema: z.ZodObject<{
         } | undefined;
         pointsToNextBand?: number | undefined;
         trend?: number | undefined;
-        comparison?: {
-            daily: {
-                value: number;
-                day: number;
-            }[];
-            value: number;
-            period: string;
-            periodLabel: string;
-        } | undefined;
     };
     previousPeriod?: string | undefined;
     nextPeriod?: string | undefined;
@@ -5126,9 +4932,9 @@ declare const ScoreRecapSchema: z.ZodObject<{
     }[];
     current: {
         value: number;
+        hasData: boolean;
         period: string;
         periodLabel: string;
-        hasData: boolean;
         computedAt: number;
         metrics: {
             value: number;
@@ -5144,10 +4950,6 @@ declare const ScoreRecapSchema: z.ZodObject<{
                 key: string;
             } | undefined;
         }[];
-        daily?: {
-            value: number;
-            day: number;
-        }[] | undefined;
         band?: {
             label: string;
             min: number;
@@ -5162,15 +4964,6 @@ declare const ScoreRecapSchema: z.ZodObject<{
         } | undefined;
         pointsToNextBand?: number | undefined;
         trend?: number | undefined;
-        comparison?: {
-            daily: {
-                value: number;
-                day: number;
-            }[];
-            value: number;
-            period: string;
-            periodLabel: string;
-        } | undefined;
     };
     previousPeriod?: string | undefined;
     nextPeriod?: string | undefined;
@@ -5205,6 +4998,7 @@ declare const ScoreGoalSchema: z.ZodObject<{
     /** Projects a month over the last `averageMonths` closed months; absent when there are none. */
     average: z.ZodOptional<z.ZodNumber>;
     averageMonths: z.ZodNumber;
+    min: z.ZodNumber;
     options: z.ZodArray<z.ZodObject<{
         key: z.ZodString;
         label: z.ZodString;
@@ -5226,6 +5020,7 @@ declare const ScoreGoalSchema: z.ZodObject<{
         key: string;
         target: number;
     }[];
+    min: number;
     current: number;
     averageMonths: number;
     next?: {
@@ -5240,6 +5035,7 @@ declare const ScoreGoalSchema: z.ZodObject<{
         key: string;
         target: number;
     }[];
+    min: number;
     current: number;
     averageMonths: number;
     next?: {
@@ -5249,14 +5045,168 @@ declare const ScoreGoalSchema: z.ZodObject<{
     average?: number | undefined;
     recommended?: string | undefined;
 }>;
+declare const ScoreProgressMetricSchema: z.ZodObject<{
+    key: z.ZodString;
+    value: z.ZodNumber;
+    target: z.ZodNumber;
+    available: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    value: number;
+    key: string;
+    target: number;
+    available: boolean;
+}, {
+    value: number;
+    key: string;
+    target: number;
+    available: boolean;
+}>;
+declare const ScoreProgressSchema: z.ZodObject<{
+    period: z.ZodString;
+    periodLabel: z.ZodString;
+    computedAt: z.ZodNumber;
+    value: z.ZodNumber;
+    hasData: z.ZodBoolean;
+    band: z.ZodOptional<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        min: z.ZodNumber;
+        max: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    }, {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    }>>;
+    metrics: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        value: z.ZodNumber;
+        target: z.ZodNumber;
+        available: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        value: number;
+        key: string;
+        target: number;
+        available: boolean;
+    }, {
+        value: number;
+        key: string;
+        target: number;
+        available: boolean;
+    }>, "many">;
+    history: z.ZodArray<z.ZodObject<{
+        period: z.ZodString;
+        label: z.ZodString;
+        value: z.ZodNumber;
+        band: z.ZodOptional<z.ZodObject<{
+            key: z.ZodString;
+            label: z.ZodString;
+            min: z.ZodNumber;
+            max: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            label: string;
+            min: number;
+            max: number;
+            key: string;
+        }, {
+            label: string;
+            min: number;
+            max: number;
+            key: string;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        value: number;
+        label: string;
+        period: string;
+        band?: {
+            label: string;
+            min: number;
+            max: number;
+            key: string;
+        } | undefined;
+    }, {
+        value: number;
+        label: string;
+        period: string;
+        band?: {
+            label: string;
+            min: number;
+            max: number;
+            key: string;
+        } | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    value: number;
+    history: {
+        value: number;
+        label: string;
+        period: string;
+        band?: {
+            label: string;
+            min: number;
+            max: number;
+            key: string;
+        } | undefined;
+    }[];
+    hasData: boolean;
+    period: string;
+    periodLabel: string;
+    computedAt: number;
+    metrics: {
+        value: number;
+        key: string;
+        target: number;
+        available: boolean;
+    }[];
+    band?: {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    } | undefined;
+}, {
+    value: number;
+    history: {
+        value: number;
+        label: string;
+        period: string;
+        band?: {
+            label: string;
+            min: number;
+            max: number;
+            key: string;
+        } | undefined;
+    }[];
+    hasData: boolean;
+    period: string;
+    periodLabel: string;
+    computedAt: number;
+    metrics: {
+        value: number;
+        key: string;
+        target: number;
+        available: boolean;
+    }[];
+    band?: {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    } | undefined;
+}>;
 type ScoreMetricKey = z.infer<typeof ScoreMetricKeySchema>;
 type ScoreBand = z.infer<typeof ScoreBandSchema>;
 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 ScoreDay = z.infer<typeof ScoreDaySchema>;
-type ScoreComparison = z.infer<typeof ScoreComparisonSchema>;
+type ScoreProgressMetric = z.infer<typeof ScoreProgressMetricSchema>;
+type ScoreProgress = z.infer<typeof ScoreProgressSchema>;
 type ScoreGoalOption = z.infer<typeof ScoreGoalOptionSchema>;
 type ScoreGoal = z.infer<typeof ScoreGoalSchema>;
 
@@ -5267,11 +5217,12 @@ interface IAPI$1 {
      * and a month still being lived is rejected.
      */
     getRecap: (context: Context, period?: string) => Promise<ScoreRecap>;
+    getProgress: (context: Context) => Promise<ScoreProgress>;
     /** The caller's monthly project goal, the options and their recent average. */
     getGoal: (context: Context) => Promise<ScoreGoal>;
     /**
-     * Chooses a goal, which starts next month. `target` must be one of the options;
-     * choosing the goal in effect cancels a pending one. Answers with the updated goal.
+     * Chooses a goal, which starts next month. `target` must be a whole number of at least
+     * `min`; choosing the goal in effect cancels a pending one. Answers with the updated goal.
      */
     setGoal: (context: Context, target: number) => Promise<ScoreGoal>;
 }
@@ -5280,6 +5231,10 @@ declare const Endpoints$1: {
         uri: string;
         method: string;
     };
+    GetProgress: {
+        uri: string;
+        method: string;
+    };
     GetGoal: {
         uri: string;
         method: string;
@@ -5293,10 +5248,6 @@ declare const Endpoints$1: {
 type index$3_Score = Score;
 type index$3_ScoreBand = ScoreBand;
 declare const index$3_ScoreBandSchema: typeof ScoreBandSchema;
-type index$3_ScoreComparison = ScoreComparison;
-declare const index$3_ScoreComparisonSchema: typeof ScoreComparisonSchema;
-type index$3_ScoreDay = ScoreDay;
-declare const index$3_ScoreDaySchema: typeof ScoreDaySchema;
 type index$3_ScoreGoal = ScoreGoal;
 type index$3_ScoreGoalOption = ScoreGoalOption;
 declare const index$3_ScoreGoalOptionSchema: typeof ScoreGoalOptionSchema;
@@ -5307,10 +5258,14 @@ 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_ScoreProgress = ScoreProgress;
+type index$3_ScoreProgressMetric = ScoreProgressMetric;
+declare const index$3_ScoreProgressMetricSchema: typeof ScoreProgressMetricSchema;
+declare const index$3_ScoreProgressSchema: typeof ScoreProgressSchema;
 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_ScoreComparison as ScoreComparison, index$3_ScoreComparisonSchema as ScoreComparisonSchema, type index$3_ScoreDay as ScoreDay, index$3_ScoreDaySchema as ScoreDaySchema, 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, 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_ScoreProgress as ScoreProgress, type index$3_ScoreProgressMetric as ScoreProgressMetric, index$3_ScoreProgressMetricSchema as ScoreProgressMetricSchema, index$3_ScoreProgressSchema as ScoreProgressSchema, index$3_ScoreRecapSchema as ScoreRecapSchema, index$3_ScoreSchema as ScoreSchema };
 }
 
 /**

package/dist/index.js

@@ -6287,6 +6287,7 @@ var ShredU_api_default = ShredUAPI;
 // src/model/score/Score.api.ts
 var Endpoints10 = {
   GetRecap: { uri: "/score/", method: "GET" },
+  GetProgress: { uri: "/score/progress/", method: "GET" },
   GetGoal: { uri: "/score/goal/", method: "GET" },
   SetGoal: { uri: "/score/goal/", method: "PUT" }
 };
@@ -6318,16 +6319,6 @@ var ScoreMetricSchema = external_exports.object({
   available: external_exports.boolean(),
   rating: ScoreBandSchema.optional()
 });
-var ScoreDaySchema = external_exports.object({
-  day: external_exports.number(),
-  value: external_exports.number()
-});
-var ScoreComparisonSchema = external_exports.object({
-  period: external_exports.string(),
-  periodLabel: external_exports.string(),
-  value: external_exports.number(),
-  daily: external_exports.array(ScoreDaySchema)
-});
 var ScoreSchema = external_exports.object({
   value: external_exports.number(),
   hasData: external_exports.boolean(),
@@ -6338,11 +6329,7 @@ var ScoreSchema = external_exports.object({
   pointsToNextBand: external_exports.number().optional(),
   trend: external_exports.number().optional(),
   computedAt: external_exports.number(),
-  metrics: external_exports.array(ScoreMetricSchema),
-  /** Served on the recap's `current` only. */
-  daily: external_exports.array(ScoreDaySchema).optional(),
-  /** Absent when the month before predates the customer's first project. */
-  comparison: ScoreComparisonSchema.optional()
+  metrics: external_exports.array(ScoreMetricSchema)
 });
 var ScoreHistoryEntrySchema = external_exports.object({
   period: external_exports.string(),
@@ -6371,10 +6358,27 @@ var ScoreGoalSchema = external_exports.object({
   /** Projects a month over the last `averageMonths` closed months; absent when there are none. */
   average: external_exports.number().optional(),
   averageMonths: external_exports.number(),
+  min: external_exports.number(),
   options: external_exports.array(ScoreGoalOptionSchema),
   /** The `key` of the option offered as recommended. */
   recommended: external_exports.string().optional()
 });
+var ScoreProgressMetricSchema = external_exports.object({
+  key: external_exports.string(),
+  value: external_exports.number(),
+  target: external_exports.number(),
+  available: external_exports.boolean()
+});
+var ScoreProgressSchema = external_exports.object({
+  period: external_exports.string(),
+  periodLabel: external_exports.string(),
+  computedAt: external_exports.number(),
+  value: external_exports.number(),
+  hasData: external_exports.boolean(),
+  band: ScoreBandSchema.optional(),
+  metrics: external_exports.array(ScoreProgressMetricSchema),
+  history: external_exports.array(ScoreHistoryEntrySchema)
+});
 
 // src/api/Score.api.ts
 var ScoreAPI = class {
@@ -6394,6 +6398,10 @@ var ScoreAPI = class {
       ScoreRecapSchema
     );
   }
+  async getProgress(ctx) {
+    const { uri, method } = Endpoints10.GetProgress;
+    return this.clientHTTP.makeRequest(this.env, uri, method, null, ctx, ScoreProgressSchema);
+  }
   async getGoal(ctx) {
     const { uri, method } = Endpoints10.GetGoal;
     return this.clientHTTP.makeRequest(this.env, uri, method, null, ctx, ScoreGoalSchema);
@@ -7209,13 +7217,13 @@ var score_exports = {};
 __export(score_exports, {
   Endpoints: () => Endpoints10,
   ScoreBandSchema: () => ScoreBandSchema,
-  ScoreComparisonSchema: () => ScoreComparisonSchema,
-  ScoreDaySchema: () => ScoreDaySchema,
   ScoreGoalOptionSchema: () => ScoreGoalOptionSchema,
   ScoreGoalSchema: () => ScoreGoalSchema,
   ScoreHistoryEntrySchema: () => ScoreHistoryEntrySchema,
   ScoreMetricKeySchema: () => ScoreMetricKeySchema,
   ScoreMetricSchema: () => ScoreMetricSchema,
+  ScoreProgressMetricSchema: () => ScoreProgressMetricSchema,
+  ScoreProgressSchema: () => ScoreProgressSchema,
   ScoreRecapSchema: () => ScoreRecapSchema,
   ScoreSchema: () => ScoreSchema
 });