shred-api-client 2.13.0 → 2.13.2

package/dist/index.d.ts

@@ -5072,10 +5072,50 @@ declare const ScoreProgressMetricSchema: z.ZodObject<{
     target: number;
     available: boolean;
 }>;
+declare const ScoreProjectionSchema: z.ZodObject<{
+    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;
+    band?: {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    } | undefined;
+}, {
+    value: number;
+    band?: {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    } | undefined;
+}>;
 declare const ScoreProgressSchema: z.ZodObject<{
     period: z.ZodString;
     periodLabel: z.ZodString;
     computedAt: z.ZodNumber;
+    /** The day of the month in the customer's timezone. */
+    day: z.ZodNumber;
+    daysInMonth: z.ZodNumber;
+    /** No closed month in `history` yet. */
+    isFirstMonth: z.ZodBoolean;
     value: z.ZodNumber;
     hasData: z.ZodBoolean;
     band: z.ZodOptional<z.ZodObject<{
@@ -5094,6 +5134,59 @@ declare const ScoreProgressSchema: z.ZodObject<{
         max: number;
         key: string;
     }>>;
+    /** The band above `band`. Absent at the top band and without data. */
+    nextBand: 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;
+    }>>;
+    /** Where the month closes at the pace so far. Absent early in the month, in the first month, or with nothing to measure. */
+    projection: z.ZodOptional<z.ZodObject<{
+        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;
+        band?: {
+            label: string;
+            min: number;
+            max: number;
+            key: string;
+        } | undefined;
+    }, {
+        value: number;
+        band?: {
+            label: string;
+            min: number;
+            max: number;
+            key: string;
+        } | undefined;
+    }>>;
     metrics: z.ZodArray<z.ZodObject<{
         key: z.ZodString;
         value: z.ZodNumber;
@@ -5174,12 +5267,30 @@ declare const ScoreProgressSchema: z.ZodObject<{
         target: number;
         available: boolean;
     }[];
+    day: number;
+    daysInMonth: number;
+    isFirstMonth: boolean;
     band?: {
         label: string;
         min: number;
         max: number;
         key: string;
     } | undefined;
+    nextBand?: {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    } | undefined;
+    projection?: {
+        value: number;
+        band?: {
+            label: string;
+            min: number;
+            max: number;
+            key: string;
+        } | undefined;
+    } | undefined;
 }, {
     value: number;
     history: {
@@ -5203,12 +5314,30 @@ declare const ScoreProgressSchema: z.ZodObject<{
         target: number;
         available: boolean;
     }[];
+    day: number;
+    daysInMonth: number;
+    isFirstMonth: boolean;
     band?: {
         label: string;
         min: number;
         max: number;
         key: string;
     } | undefined;
+    nextBand?: {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    } | undefined;
+    projection?: {
+        value: number;
+        band?: {
+            label: string;
+            min: number;
+            max: number;
+            key: string;
+        } | undefined;
+    } | undefined;
 }>;
 type ScoreMetricKey = z.infer<typeof ScoreMetricKeySchema>;
 type ScoreBand = z.infer<typeof ScoreBandSchema>;
@@ -5217,6 +5346,7 @@ 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 ScoreProjection = z.infer<typeof ScoreProjectionSchema>;
 type ScoreProgress = z.infer<typeof ScoreProgressSchema>;
 type ScoreGoalOption = z.infer<typeof ScoreGoalOptionSchema>;
 type ScoreGoal = z.infer<typeof ScoreGoalSchema>;
@@ -5273,10 +5403,12 @@ type index$3_ScoreProgress = ScoreProgress;
 type index$3_ScoreProgressMetric = ScoreProgressMetric;
 declare const index$3_ScoreProgressMetricSchema: typeof ScoreProgressMetricSchema;
 declare const index$3_ScoreProgressSchema: typeof ScoreProgressSchema;
+type index$3_ScoreProjection = ScoreProjection;
+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, 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, type index$3_ScoreProjection as ScoreProjection, index$3_ScoreProjectionSchema as ScoreProjectionSchema, index$3_ScoreRecapSchema as ScoreRecapSchema, index$3_ScoreSchema as ScoreSchema };
 }
 
 /**

package/dist/index.js

@@ -6382,13 +6382,26 @@ var ScoreProgressMetricSchema = external_exports.object({
   target: external_exports.number(),
   available: external_exports.boolean()
 });
+var ScoreProjectionSchema = external_exports.object({
+  value: external_exports.number(),
+  band: ScoreBandSchema.optional()
+});
 var ScoreProgressSchema = external_exports.object({
   period: external_exports.string(),
   periodLabel: external_exports.string(),
   computedAt: external_exports.number(),
+  /** The day of the month in the customer's timezone. */
+  day: external_exports.number(),
+  daysInMonth: external_exports.number(),
+  /** No closed month in `history` yet. */
+  isFirstMonth: external_exports.boolean(),
   value: external_exports.number(),
   hasData: external_exports.boolean(),
   band: ScoreBandSchema.optional(),
+  /** The band above `band`. Absent at the top band and without data. */
+  nextBand: ScoreBandSchema.optional(),
+  /** Where the month closes at the pace so far. Absent early in the month, in the first month, or with nothing to measure. */
+  projection: ScoreProjectionSchema.optional(),
   metrics: external_exports.array(ScoreProgressMetricSchema),
   history: external_exports.array(ScoreHistoryEntrySchema)
 });
@@ -7243,6 +7256,7 @@ __export(score_exports, {
   ScoreMetricSchema: () => ScoreMetricSchema,
   ScoreProgressMetricSchema: () => ScoreProgressMetricSchema,
   ScoreProgressSchema: () => ScoreProgressSchema,
+  ScoreProjectionSchema: () => ScoreProjectionSchema,
   ScoreRecapSchema: () => ScoreRecapSchema,
   ScoreSchema: () => ScoreSchema
 });