shred-api-client 2.12.2 → 2.13.1

package/dist/index.d.ts

@@ -1713,11 +1713,17 @@ type Preferences = z.infer<typeof PreferencesSchema>;
 interface IAPI$c {
     getByInviteCode: (code: string, context?: Context) => Promise<Tenant | null>;
     create: (tenant: Tenant, context: Context) => Promise<boolean>;
-    list: (context: Context) => Promise<Tenant[]>;
+    /** Deleted tenants are left out unless `includeInactive` is true. */
+    list: (context: Context, options?: ListOptions) => Promise<Tenant[]>;
     getTenant: (context: Context, tenantId?: string) => Promise<Tenant | null>;
     getMembers: (context: Context, tenantId: string) => Promise<Member[]>;
     update: (tenantId: string, data: TenantUpdate, context: Context) => Promise<boolean>;
     updateMembers: (tenantId: string, memberUpdate: MemberUpdate, context: Context) => Promise<boolean>;
+    /** Logical delete: the tenant becomes inactive and every member leaves it. */
+    delete: (tenantId: string, context: Context) => Promise<boolean>;
+}
+interface ListOptions {
+    includeInactive?: boolean;
 }
 declare const Endpoints$b: {
     GetByInviteCode: {
@@ -1752,8 +1758,13 @@ declare const Endpoints$b: {
         uri: string;
         method: string;
     };
+    DeleteTenant: {
+        uri: string;
+        method: string;
+    };
 };
 
+type index$d_ListOptions = ListOptions;
 type index$d_Member = Member;
 declare const index$d_MemberSchema: typeof MemberSchema;
 type index$d_MemberUpdate = MemberUpdate;
@@ -1764,7 +1775,7 @@ declare const index$d_TenantSchema: typeof TenantSchema;
 type index$d_TenantUpdate = TenantUpdate;
 declare const index$d_TenantUpdateSchema: typeof TenantUpdateSchema;
 declare namespace index$d {
-  export { Action$1 as Action, Endpoints$b as Endpoints, type Tenant as Entity, type IAPI$c as IAPI, type index$d_Member as Member, index$d_MemberSchema as MemberSchema, type index$d_MemberUpdate as MemberUpdate, index$d_MemberUpdateSchema as MemberUpdateSchema, type index$d_Preferences as Preferences, index$d_PreferencesSchema as PreferencesSchema, index$d_TenantSchema as TenantSchema, type index$d_TenantUpdate as TenantUpdate, index$d_TenantUpdateSchema as TenantUpdateSchema };
+  export { Action$1 as Action, Endpoints$b as Endpoints, type Tenant as Entity, type IAPI$c as IAPI, type index$d_ListOptions as ListOptions, type index$d_Member as Member, index$d_MemberSchema as MemberSchema, type index$d_MemberUpdate as MemberUpdate, index$d_MemberUpdateSchema as MemberUpdateSchema, type index$d_Preferences as Preferences, index$d_PreferencesSchema as PreferencesSchema, index$d_TenantSchema as TenantSchema, type index$d_TenantUpdate as TenantUpdate, index$d_TenantUpdateSchema as TenantUpdateSchema };
 }
 
 declare const TrackParamSchema: z.ZodObject<{
@@ -5061,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<{
@@ -5083,6 +5134,42 @@ declare const ScoreProgressSchema: z.ZodObject<{
         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;
@@ -5163,12 +5250,24 @@ 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;
+    projection?: {
+        value: number;
+        band?: {
+            label: string;
+            min: number;
+            max: number;
+            key: string;
+        } | undefined;
+    } | undefined;
 }, {
     value: number;
     history: {
@@ -5192,12 +5291,24 @@ 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;
+    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>;
@@ -5206,6 +5317,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>;
@@ -5262,10 +5374,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 };
 }
 
 /**
@@ -5318,6 +5432,7 @@ declare const Actions: {
     readonly TENANT_LIST: "tenant.list";
     readonly TENANT_VIEW: "tenant.view";
     readonly TENANT_UPDATE: "tenant.update";
+    readonly TENANT_DELETE: "tenant.delete";
     readonly TENANT_VIEW_MEMBERS: "tenant.view_members";
     readonly TENANT_UPDATE_MEMBERS: "tenant.update_members";
     readonly TENANT_VIEW_REPORT: "tenant.view_report";

package/dist/index.js

@@ -4747,11 +4747,12 @@ var TenantAPI = class {
     );
     return data;
   }
-  async list(context) {
+  async list(context, options) {
     const endpointInfo = tenant_exports.Endpoints.ListAll;
+    const endpoint = (options == null ? void 0 : options.includeInactive) ? `${endpointInfo.uri}?includeInactive=true` : endpointInfo.uri;
     const data = await this.clientHTTP.makeRequest(
       this.env,
-      `${endpointInfo.uri}`,
+      endpoint,
       endpointInfo.method,
       null,
       context
@@ -4793,6 +4794,18 @@ var TenantAPI = class {
     );
     return data;
   }
+  async delete(tenantId, context) {
+    const endpointInfo = tenant_exports.Endpoints.DeleteTenant;
+    const endpoint = endpointInfo.uri.replace(":tenantId", tenantId);
+    const data = await this.clientHTTP.makeRequest(
+      this.env,
+      endpoint,
+      endpointInfo.method,
+      null,
+      context
+    );
+    return data;
+  }
 };
 var Tenant_api_default = TenantAPI;
 
@@ -6369,13 +6382,24 @@ 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(),
+  /** 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)
 });
@@ -6476,6 +6500,7 @@ var Actions = {
   TENANT_LIST: "tenant.list",
   TENANT_VIEW: "tenant.view",
   TENANT_UPDATE: "tenant.update",
+  TENANT_DELETE: "tenant.delete",
   TENANT_VIEW_MEMBERS: "tenant.view_members",
   TENANT_UPDATE_MEMBERS: "tenant.update_members",
   TENANT_VIEW_REPORT: "tenant.view_report",
@@ -6572,6 +6597,7 @@ var ActionCatalog = {
   [Actions.TENANT_LIST]: { label: "List all tenants", group: "Tenants" },
   [Actions.TENANT_VIEW]: { label: "View any tenant", group: "Tenants" },
   [Actions.TENANT_UPDATE]: { label: "Update any tenant", group: "Tenants" },
+  [Actions.TENANT_DELETE]: { label: "Delete a tenant", group: "Tenants" },
   [Actions.TENANT_VIEW_MEMBERS]: { label: "View a tenant's members", group: "Tenants" },
   [Actions.TENANT_UPDATE_MEMBERS]: { label: "Manage a tenant's members", group: "Tenants" },
   [Actions.TENANT_VIEW_REPORT]: { label: "View a tenant's report", group: "Tenants", scopeable: true },
@@ -6999,6 +7025,10 @@ var Endpoints13 = {
   UpdateMembers: {
     uri: "/tenants/:tenantId/members",
     method: "PUT"
+  },
+  DeleteTenant: {
+    uri: "/tenants/:tenantId",
+    method: "DELETE"
   }
 };
 
@@ -7224,6 +7254,7 @@ __export(score_exports, {
   ScoreMetricSchema: () => ScoreMetricSchema,
   ScoreProgressMetricSchema: () => ScoreProgressMetricSchema,
   ScoreProgressSchema: () => ScoreProgressSchema,
+  ScoreProjectionSchema: () => ScoreProjectionSchema,
   ScoreRecapSchema: () => ScoreRecapSchema,
   ScoreSchema: () => ScoreSchema
 });