shred-api-client 2.11.0 → 2.11.2

package/dist/index.d.ts

@@ -3639,6 +3639,7 @@ declare const ShredUSessionSchema: z.ZodObject<{
     }>, "many">>;
     tenantIds: z.ZodArray<z.ZodString, "many">;
     timezone: z.ZodString;
+    reminderLeadMs: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     id: string;
     status: "scheduled" | "cancelled";
@@ -3672,6 +3673,7 @@ declare const ShredUSessionSchema: z.ZodObject<{
     recordingUrl?: string | undefined;
     recordingThumbnailUrl?: string | undefined;
     recordingDurationSeconds?: number | undefined;
+    reminderLeadMs?: number | undefined;
 }, {
     id: string;
     status: "scheduled" | "cancelled";
@@ -3705,6 +3707,7 @@ declare const ShredUSessionSchema: z.ZodObject<{
     recordingUrl?: string | undefined;
     recordingThumbnailUrl?: string | undefined;
     recordingDurationSeconds?: number | undefined;
+    reminderLeadMs?: number | undefined;
 }>;
 /** Subscriber-facing endpoints answer without the Zoom link, who else it is for, or the hub's authoring zone. */
 declare const ShredUSessionCustomerSchema: z.ZodObject<Omit<{
@@ -3777,7 +3780,8 @@ declare const ShredUSessionCustomerSchema: z.ZodObject<Omit<{
     }>, "many">>;
     tenantIds: z.ZodArray<z.ZodString, "many">;
     timezone: z.ZodString;
-}, "timezone" | "tenantIds" | "zoomUrl">, "strip", z.ZodTypeAny, {
+    reminderLeadMs: z.ZodOptional<z.ZodNumber>;
+}, "timezone" | "tenantIds" | "zoomUrl" | "reminderLeadMs">, "strip", z.ZodTypeAny, {
     id: string;
     status: "scheduled" | "cancelled";
     description: string;
@@ -3919,6 +3923,7 @@ declare const CreateShredUSessionSchema: z.ZodObject<{
     }>, "many">>;
     tenantIds: z.ZodArray<z.ZodString, "many">;
     timezone: z.ZodString;
+    reminderLeadMs: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     timezone: string;
     description: string;
@@ -3947,6 +3952,7 @@ declare const CreateShredUSessionSchema: z.ZodObject<{
         topics: string[];
         signoff?: string | undefined;
     } | undefined;
+    reminderLeadMs?: number | undefined;
 }, {
     timezone: string;
     description: string;
@@ -3975,6 +3981,7 @@ declare const CreateShredUSessionSchema: z.ZodObject<{
         topics: string[];
         signoff?: string | undefined;
     } | undefined;
+    reminderLeadMs?: number | undefined;
 }>;
 declare const UpdateShredUSessionSchema: z.ZodObject<{
     topic: z.ZodOptional<z.ZodString>;
@@ -4041,6 +4048,7 @@ declare const UpdateShredUSessionSchema: z.ZodObject<{
     }>, "many">>;
     tenantIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     timezone: z.ZodOptional<z.ZodString>;
+    reminderLeadMs: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     timezone?: string | undefined;
     description?: string | undefined;
@@ -4069,6 +4077,7 @@ declare const UpdateShredUSessionSchema: z.ZodObject<{
     startsAt?: number | undefined;
     durationMin?: number | undefined;
     zoomUrl?: string | undefined;
+    reminderLeadMs?: number | undefined;
 }, {
     timezone?: string | undefined;
     description?: string | undefined;
@@ -4097,6 +4106,7 @@ declare const UpdateShredUSessionSchema: z.ZodObject<{
     startsAt?: number | undefined;
     durationMin?: number | undefined;
     zoomUrl?: string | undefined;
+    reminderLeadMs?: number | undefined;
 }>;
 declare const PreviewShredUEmailSchema: z.ZodObject<{
     sessionId: z.ZodOptional<z.ZodString>;
@@ -4165,7 +4175,97 @@ declare const SetShredUSessionRecordingSchema: z.ZodObject<{
     recordingDurationSeconds: number;
     recordingThumbnailUrl?: string | undefined;
 }>;
+declare const ShredUStageRuleSchema: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+    /** How long before the session starts this goes out. 0 means at start. */
+    leadMs: z.ZodNumber;
+    transport: z.ZodNativeEnum<typeof TransportType>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    label: string;
+    leadMs: number;
+    transport: TransportType;
+}, {
+    id: string;
+    label: string;
+    leadMs: number;
+    transport: TransportType;
+}>;
+declare const ShredUReminderBoundsSchema: z.ZodObject<{
+    defaultLeadMs: z.ZodNumber;
+    minLeadMs: z.ZodNumber;
+    maxLeadMs: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    defaultLeadMs: number;
+    minLeadMs: number;
+    maxLeadMs: number;
+}, {
+    defaultLeadMs: number;
+    minLeadMs: number;
+    maxLeadMs: number;
+}>;
+declare const ShredUDispatchRulesSchema: z.ZodObject<{
+    /** Furthest ahead first, the order they fire in. */
+    stages: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodString;
+        /** How long before the session starts this goes out. 0 means at start. */
+        leadMs: z.ZodNumber;
+        transport: z.ZodNativeEnum<typeof TransportType>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        label: string;
+        leadMs: number;
+        transport: TransportType;
+    }, {
+        id: string;
+        label: string;
+        leadMs: number;
+        transport: TransportType;
+    }>, "many">;
+    reminder: z.ZodObject<{
+        defaultLeadMs: z.ZodNumber;
+        minLeadMs: z.ZodNumber;
+        maxLeadMs: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        defaultLeadMs: number;
+        minLeadMs: number;
+        maxLeadMs: number;
+    }, {
+        defaultLeadMs: number;
+        minLeadMs: number;
+        maxLeadMs: number;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    stages: {
+        id: string;
+        label: string;
+        leadMs: number;
+        transport: TransportType;
+    }[];
+    reminder: {
+        defaultLeadMs: number;
+        minLeadMs: number;
+        maxLeadMs: number;
+    };
+}, {
+    stages: {
+        id: string;
+        label: string;
+        leadMs: number;
+        transport: TransportType;
+    }[];
+    reminder: {
+        defaultLeadMs: number;
+        minLeadMs: number;
+        maxLeadMs: number;
+    };
+}>;
 type SessionAsset = z.infer<typeof SessionAssetSchema>;
+type ShredUStageRule = z.infer<typeof ShredUStageRuleSchema>;
+type ShredUReminderBounds = z.infer<typeof ShredUReminderBoundsSchema>;
+type ShredUDispatchRules = z.infer<typeof ShredUDispatchRulesSchema>;
 type Brief = z.infer<typeof ShredUBriefSchema>;
 type ShredUSessionStatus = z.infer<typeof ShredUSessionStatusSchema>;
 type ShredUSession = z.infer<typeof ShredUSessionSchema>;
@@ -4187,6 +4287,8 @@ interface IAPI$2 {
     cancel: (ctx: Context, id: string) => Promise<void>;
     setRecording: (ctx: Context, id: string, data: SetRecording) => Promise<void>;
     previewEmail: (ctx: Context, data: PreviewEmail) => Promise<void>;
+    /** The lead times the dispatch job runs on. Static: fetch once, not per keystroke. */
+    getDispatchRules: (ctx: Context) => Promise<ShredUDispatchRules>;
 }
 declare const Endpoints$2: {
     List: {
@@ -4229,6 +4331,10 @@ declare const Endpoints$2: {
         uri: string;
         method: string;
     };
+    GetDispatchRules: {
+        uri: string;
+        method: string;
+    };
 };
 
 type index$4_Brief = Brief;
@@ -4243,16 +4349,22 @@ declare const index$4_SessionAssetSchema: typeof SessionAssetSchema;
 type index$4_SetRecording = SetRecording;
 declare const index$4_SetShredUSessionRecordingSchema: typeof SetShredUSessionRecordingSchema;
 declare const index$4_ShredUBriefSchema: typeof ShredUBriefSchema;
+type index$4_ShredUDispatchRules = ShredUDispatchRules;
+declare const index$4_ShredUDispatchRulesSchema: typeof ShredUDispatchRulesSchema;
 declare const index$4_ShredUJoinSchema: typeof ShredUJoinSchema;
+type index$4_ShredUReminderBounds = ShredUReminderBounds;
+declare const index$4_ShredUReminderBoundsSchema: typeof ShredUReminderBoundsSchema;
 type index$4_ShredUSessionCustomer = ShredUSessionCustomer;
 declare const index$4_ShredUSessionCustomerSchema: typeof ShredUSessionCustomerSchema;
 declare const index$4_ShredUSessionSchema: typeof ShredUSessionSchema;
 type index$4_ShredUSessionStatus = ShredUSessionStatus;
 declare const index$4_ShredUSessionStatusSchema: typeof ShredUSessionStatusSchema;
+type index$4_ShredUStageRule = ShredUStageRule;
+declare const index$4_ShredUStageRuleSchema: typeof ShredUStageRuleSchema;
 type index$4_Update = Update;
 declare const index$4_UpdateShredUSessionSchema: typeof UpdateShredUSessionSchema;
 declare namespace index$4 {
-  export { type index$4_Brief as Brief, type index$4_Create as Create, index$4_CreateShredUBriefSchema as CreateShredUBriefSchema, index$4_CreateShredUSessionSchema as CreateShredUSessionSchema, Endpoints$2 as Endpoints, type ShredUSession as Entity, type IAPI$2 as IAPI, type index$4_Join as Join, type index$4_PreviewEmail as PreviewEmail, index$4_PreviewShredUEmailSchema as PreviewShredUEmailSchema, type index$4_SessionAsset as SessionAsset, index$4_SessionAssetSchema as SessionAssetSchema, type index$4_SetRecording as SetRecording, index$4_SetShredUSessionRecordingSchema as SetShredUSessionRecordingSchema, index$4_ShredUBriefSchema as ShredUBriefSchema, index$4_ShredUJoinSchema as ShredUJoinSchema, type index$4_ShredUSessionCustomer as ShredUSessionCustomer, index$4_ShredUSessionCustomerSchema as ShredUSessionCustomerSchema, index$4_ShredUSessionSchema as ShredUSessionSchema, type index$4_ShredUSessionStatus as ShredUSessionStatus, index$4_ShredUSessionStatusSchema as ShredUSessionStatusSchema, type index$4_Update as Update, index$4_UpdateShredUSessionSchema as UpdateShredUSessionSchema };
+  export { type index$4_Brief as Brief, type index$4_Create as Create, index$4_CreateShredUBriefSchema as CreateShredUBriefSchema, index$4_CreateShredUSessionSchema as CreateShredUSessionSchema, Endpoints$2 as Endpoints, type ShredUSession as Entity, type IAPI$2 as IAPI, type index$4_Join as Join, type index$4_PreviewEmail as PreviewEmail, index$4_PreviewShredUEmailSchema as PreviewShredUEmailSchema, type index$4_SessionAsset as SessionAsset, index$4_SessionAssetSchema as SessionAssetSchema, type index$4_SetRecording as SetRecording, index$4_SetShredUSessionRecordingSchema as SetShredUSessionRecordingSchema, index$4_ShredUBriefSchema as ShredUBriefSchema, type index$4_ShredUDispatchRules as ShredUDispatchRules, index$4_ShredUDispatchRulesSchema as ShredUDispatchRulesSchema, index$4_ShredUJoinSchema as ShredUJoinSchema, type index$4_ShredUReminderBounds as ShredUReminderBounds, index$4_ShredUReminderBoundsSchema as ShredUReminderBoundsSchema, type index$4_ShredUSessionCustomer as ShredUSessionCustomer, index$4_ShredUSessionCustomerSchema as ShredUSessionCustomerSchema, index$4_ShredUSessionSchema as ShredUSessionSchema, type index$4_ShredUSessionStatus as ShredUSessionStatus, index$4_ShredUSessionStatusSchema as ShredUSessionStatusSchema, type index$4_ShredUStageRule as ShredUStageRule, index$4_ShredUStageRuleSchema as ShredUStageRuleSchema, type index$4_Update as Update, index$4_UpdateShredUSessionSchema as UpdateShredUSessionSchema };
 }
 
 /** The metrics served today. The list grows, so it never gates parsing — see ScoreMetricSchema. */

package/dist/index.js

@@ -6114,6 +6114,10 @@ var Endpoints9 = {
   PreviewEmail: {
     uri: "/shredu/sessions/preview-email",
     method: "POST"
+  },
+  GetDispatchRules: {
+    uri: "/shredu/dispatch-rules",
+    method: "GET"
   }
 };
 
@@ -6146,13 +6150,16 @@ var ShredUSessionSchema = external_exports.object({
   recordingDurationSeconds: external_exports.number().optional(),
   assets: external_exports.array(SessionAssetSchema).optional(),
   tenantIds: external_exports.array(external_exports.string()),
-  timezone: external_exports.string()
+  timezone: external_exports.string(),
+  reminderLeadMs: external_exports.number().optional()
 });
 var ShredUSessionCustomerSchema = ShredUSessionSchema.omit({
   zoomUrl: true,
   tenantIds: true,
-  timezone: true
+  timezone: true,
+  reminderLeadMs: true
 });
+var ReminderLeadSchema = external_exports.number().int().nonnegative();
 var CreateShredUBriefSchema = external_exports.object({
   hook: external_exports.string().min(1),
   intro: external_exports.array(external_exports.string().min(1)),
@@ -6168,7 +6175,8 @@ var CreateShredUSessionSchema = external_exports.object({
   zoomUrl: external_exports.string().url(),
   assets: external_exports.array(SessionAssetSchema).optional(),
   tenantIds: external_exports.array(external_exports.string().min(1)),
-  timezone: external_exports.string().min(1)
+  timezone: external_exports.string().min(1),
+  reminderLeadMs: ReminderLeadSchema.optional()
 });
 var UpdateShredUSessionSchema = external_exports.object({
   topic: external_exports.string().min(1).optional(),
@@ -6179,7 +6187,8 @@ var UpdateShredUSessionSchema = external_exports.object({
   zoomUrl: external_exports.string().url().optional(),
   assets: external_exports.array(SessionAssetSchema).optional(),
   tenantIds: external_exports.array(external_exports.string().min(1)).optional(),
-  timezone: external_exports.string().min(1).optional()
+  timezone: external_exports.string().min(1).optional(),
+  reminderLeadMs: ReminderLeadSchema.optional()
 });
 var PreviewShredUEmailSchema = external_exports.object({
   sessionId: external_exports.string().min(1).optional(),
@@ -6197,6 +6206,23 @@ var SetShredUSessionRecordingSchema = external_exports.object({
   recordingThumbnailUrl: external_exports.string().url().optional(),
   recordingDurationSeconds: external_exports.number().int().positive()
 });
+var ShredUStageRuleSchema = external_exports.object({
+  id: external_exports.string(),
+  label: external_exports.string(),
+  /** How long before the session starts this goes out. 0 means at start. */
+  leadMs: external_exports.number(),
+  transport: external_exports.nativeEnum(TransportType)
+});
+var ShredUReminderBoundsSchema = external_exports.object({
+  defaultLeadMs: external_exports.number(),
+  minLeadMs: external_exports.number(),
+  maxLeadMs: external_exports.number()
+});
+var ShredUDispatchRulesSchema = external_exports.object({
+  /** Furthest ahead first, the order they fire in. */
+  stages: external_exports.array(ShredUStageRuleSchema),
+  reminder: ShredUReminderBoundsSchema
+});
 
 // src/api/ShredU.api.ts
 var ShredUAPI = class {
@@ -6244,6 +6270,10 @@ var ShredUAPI = class {
     const { uri, method } = Endpoints9.PreviewEmail;
     await this.clientHTTP.makeRequest(this.env, uri, method, data, ctx);
   }
+  async getDispatchRules(ctx) {
+    const { uri, method } = Endpoints9.GetDispatchRules;
+    return this.clientHTTP.makeRequest(this.env, uri, method, null, ctx, ShredUDispatchRulesSchema);
+  }
 };
 var ShredU_api_default = ShredUAPI;
 
@@ -7113,10 +7143,13 @@ __export(shredu_exports, {
   SessionAssetSchema: () => SessionAssetSchema,
   SetShredUSessionRecordingSchema: () => SetShredUSessionRecordingSchema,
   ShredUBriefSchema: () => ShredUBriefSchema,
+  ShredUDispatchRulesSchema: () => ShredUDispatchRulesSchema,
   ShredUJoinSchema: () => ShredUJoinSchema,
+  ShredUReminderBoundsSchema: () => ShredUReminderBoundsSchema,
   ShredUSessionCustomerSchema: () => ShredUSessionCustomerSchema,
   ShredUSessionSchema: () => ShredUSessionSchema,
   ShredUSessionStatusSchema: () => ShredUSessionStatusSchema,
+  ShredUStageRuleSchema: () => ShredUStageRuleSchema,
   UpdateShredUSessionSchema: () => UpdateShredUSessionSchema
 });