shred-api-client 2.11.4 → 2.12.1

package/dist/index.d.ts

@@ -4866,6 +4866,9 @@ declare const ScoreRecapSchema: z.ZodObject<{
             key: string;
         } | undefined;
     }>, "many">;
+    /** The neighbouring months that can be opened, taken from `history`. Absent at either edge. */
+    previousPeriod: z.ZodOptional<z.ZodString>;
+    nextPeriod: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     history: {
         value: number;
@@ -4913,6 +4916,8 @@ declare const ScoreRecapSchema: z.ZodObject<{
         pointsToNextBand?: number | undefined;
         trend?: number | undefined;
     };
+    previousPeriod?: string | undefined;
+    nextPeriod?: string | undefined;
 }, {
     history: {
         value: number;
@@ -4960,6 +4965,142 @@ declare const ScoreRecapSchema: z.ZodObject<{
         pointsToNextBand?: number | undefined;
         trend?: number | undefined;
     };
+    previousPeriod?: string | undefined;
+    nextPeriod?: string | undefined;
+}>;
+declare const ScoreGoalOptionSchema: z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodString;
+    target: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    label: string;
+    key: string;
+    target: number;
+}, {
+    label: string;
+    key: string;
+    target: number;
+}>;
+declare const ScoreGoalSchema: z.ZodObject<{
+    /** The goal of the month being lived. */
+    current: z.ZodNumber;
+    /** A goal chosen this month, starting on `from` (`YYYY-MM`). */
+    next: z.ZodOptional<z.ZodObject<{
+        target: z.ZodNumber;
+        from: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        from: string;
+        target: number;
+    }, {
+        from: string;
+        target: number;
+    }>>;
+    /** 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;
+        target: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        key: string;
+        target: number;
+    }, {
+        label: string;
+        key: string;
+        target: number;
+    }>, "many">;
+    /** The `key` of the option offered as recommended. */
+    recommended: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    options: {
+        label: string;
+        key: string;
+        target: number;
+    }[];
+    min: number;
+    current: number;
+    averageMonths: number;
+    next?: {
+        from: string;
+        target: number;
+    } | undefined;
+    average?: number | undefined;
+    recommended?: string | undefined;
+}, {
+    options: {
+        label: string;
+        key: string;
+        target: number;
+    }[];
+    min: number;
+    current: number;
+    averageMonths: number;
+    next?: {
+        from: string;
+        target: number;
+    } | undefined;
+    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;
+    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">;
+}, "strip", z.ZodTypeAny, {
+    period: string;
+    periodLabel: string;
+    computedAt: number;
+    metrics: {
+        value: number;
+        key: string;
+        target: number;
+        available: boolean;
+    }[];
+}, {
+    period: string;
+    periodLabel: string;
+    computedAt: number;
+    metrics: {
+        value: number;
+        key: string;
+        target: number;
+        available: boolean;
+    }[];
 }>;
 type ScoreMetricKey = z.infer<typeof ScoreMetricKeySchema>;
 type ScoreBand = z.infer<typeof ScoreBandSchema>;
@@ -4967,6 +5108,10 @@ 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 ScoreProgressMetric = z.infer<typeof ScoreProgressMetricSchema>;
+type ScoreProgress = z.infer<typeof ScoreProgressSchema>;
+type ScoreGoalOption = z.infer<typeof ScoreGoalOptionSchema>;
+type ScoreGoal = z.infer<typeof ScoreGoalSchema>;
 
 interface IAPI$1 {
     /**
@@ -4975,27 +5120,55 @@ 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 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>;
 }
 declare const Endpoints$1: {
     GetRecap: {
         uri: string;
         method: string;
     };
+    GetProgress: {
+        uri: string;
+        method: string;
+    };
+    GetGoal: {
+        uri: string;
+        method: string;
+    };
+    SetGoal: {
+        uri: string;
+        method: string;
+    };
 };
 
 type index$3_Score = Score;
 type index$3_ScoreBand = ScoreBand;
 declare const index$3_ScoreBandSchema: typeof ScoreBandSchema;
+type index$3_ScoreGoal = ScoreGoal;
+type index$3_ScoreGoalOption = ScoreGoalOption;
+declare const index$3_ScoreGoalOptionSchema: typeof ScoreGoalOptionSchema;
+declare const index$3_ScoreGoalSchema: typeof ScoreGoalSchema;
 type index$3_ScoreHistoryEntry = ScoreHistoryEntry;
 declare const index$3_ScoreHistoryEntrySchema: typeof ScoreHistoryEntrySchema;
 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_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

@@ -6286,7 +6286,10 @@ var ShredU_api_default = ShredUAPI;
 
 // src/model/score/Score.api.ts
 var Endpoints10 = {
-  GetRecap: { uri: "/score/", method: "GET" }
+  GetRecap: { uri: "/score/", method: "GET" },
+  GetProgress: { uri: "/score/progress/", method: "GET" },
+  GetGoal: { uri: "/score/goal/", method: "GET" },
+  SetGoal: { uri: "/score/goal/", method: "PUT" }
 };
 
 // src/model/score/Score.schema.ts
@@ -6337,7 +6340,40 @@ var ScoreHistoryEntrySchema = external_exports.object({
 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)
+  history: external_exports.array(ScoreHistoryEntrySchema),
+  /** The neighbouring months that can be opened, taken from `history`. Absent at either edge. */
+  previousPeriod: external_exports.string().optional(),
+  nextPeriod: external_exports.string().optional()
+});
+var ScoreGoalOptionSchema = external_exports.object({
+  key: external_exports.string(),
+  label: external_exports.string(),
+  target: external_exports.number()
+});
+var ScoreGoalSchema = external_exports.object({
+  /** The goal of the month being lived. */
+  current: external_exports.number(),
+  /** A goal chosen this month, starting on `from` (`YYYY-MM`). */
+  next: external_exports.object({ target: external_exports.number(), from: external_exports.string() }).optional(),
+  /** 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(),
+  metrics: external_exports.array(ScoreProgressMetricSchema)
 });
 
 // src/api/Score.api.ts
@@ -6358,6 +6394,18 @@ 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);
+  }
+  async setGoal(ctx, target) {
+    const { uri, method } = Endpoints10.SetGoal;
+    return this.clientHTTP.makeRequest(this.env, uri, method, { target }, ctx, ScoreGoalSchema);
+  }
 };
 var Score_api_default = ScoreAPI;
 
@@ -7165,9 +7213,13 @@ var score_exports = {};
 __export(score_exports, {
   Endpoints: () => Endpoints10,
   ScoreBandSchema: () => ScoreBandSchema,
+  ScoreGoalOptionSchema: () => ScoreGoalOptionSchema,
+  ScoreGoalSchema: () => ScoreGoalSchema,
   ScoreHistoryEntrySchema: () => ScoreHistoryEntrySchema,
   ScoreMetricKeySchema: () => ScoreMetricKeySchema,
   ScoreMetricSchema: () => ScoreMetricSchema,
+  ScoreProgressMetricSchema: () => ScoreProgressMetricSchema,
+  ScoreProgressSchema: () => ScoreProgressSchema,
   ScoreRecapSchema: () => ScoreRecapSchema,
   ScoreSchema: () => ScoreSchema
 });