shred-api-client 2.10.3 → 2.10.5

package/dist/index.d.ts

@@ -2246,7 +2246,15 @@ type Approve = {
     captionSuggestion: string;
     feedback?: Feedback | null;
 };
+declare const StreamTicketSchema: z.ZodObject<{
+    ticket: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    ticket: string;
+}, {
+    ticket: string;
+}>;
 type Project = z.infer<typeof ProjectSchema>;
+type StreamTicket = z.infer<typeof StreamTicketSchema>;
 type TimelineItem = z.infer<typeof TimelineItemSchema>;
 type Interaction = z.infer<typeof InteractionSchema>;
 type Feedback = z.infer<typeof FeedbackSchema>;
@@ -2254,6 +2262,8 @@ type Rating = z.infer<typeof RatingSchema>;
 type RatingInput = Pick<Rating, "score" | "tags" | "comment">;
 
 interface IAPI$8 {
+    /** Single-use credential for the SSE stream, which cannot carry a header. */
+    streamTicket: (context: Context) => Promise<string>;
     reorder: (context: Context, projectId: string, position: number) => Promise<boolean>;
     find: (context: Context, projectId: string) => Promise<Project>;
     create: (context: Context, data: ProjectCreation) => Promise<Project>;
@@ -2284,6 +2294,10 @@ declare const Endpoints$7: {
         uri: string;
         method: string;
     };
+    StreamTicket: {
+        uri: string;
+        method: string;
+    };
     List: {
         uri: string;
         method: string;
@@ -2425,12 +2439,14 @@ declare const index$9_RatingTag: typeof RatingTag;
 type index$9_SendToApproval = SendToApproval;
 declare const index$9_StatusConfig: typeof StatusConfig;
 type index$9_StatusConfigType = StatusConfigType;
+type index$9_StreamTicket = StreamTicket;
+declare const index$9_StreamTicketSchema: typeof StreamTicketSchema;
 type index$9_Style = Style;
 declare const index$9_Styles: typeof Styles;
 type index$9_TimelineItem = TimelineItem;
 declare const index$9_TimelineItemSchema: typeof TimelineItemSchema;
 declare namespace index$9 {
-  export { type index$9_Approve as Approve, index$9_CaptionStyle as CaptionStyle, Endpoints$7 as Endpoints, type Project as Entity, type index$9_Feedback as Feedback, index$9_FeedbackSchema as FeedbackSchema, type IAPI$8 as IAPI, type index$9_Interaction as Interaction, index$9_InteractionSchema as InteractionSchema, index$9_InteractionType as InteractionType, type index$9_ProjectCreation as ProjectCreation, index$9_ProjectSchema as ProjectSchema, type index$9_Rating as Rating, type index$9_RatingInput as RatingInput, index$9_RatingSchema as RatingSchema, index$9_RatingTag as RatingTag, type index$9_SendToApproval as SendToApproval, Status$1 as Status, index$9_StatusConfig as StatusConfig, type index$9_StatusConfigType as StatusConfigType, type index$9_Style as Style, index$9_Styles as Styles, type index$9_TimelineItem as TimelineItem, index$9_TimelineItemSchema as TimelineItemSchema };
+  export { type index$9_Approve as Approve, index$9_CaptionStyle as CaptionStyle, Endpoints$7 as Endpoints, type Project as Entity, type index$9_Feedback as Feedback, index$9_FeedbackSchema as FeedbackSchema, type IAPI$8 as IAPI, type index$9_Interaction as Interaction, index$9_InteractionSchema as InteractionSchema, index$9_InteractionType as InteractionType, type index$9_ProjectCreation as ProjectCreation, index$9_ProjectSchema as ProjectSchema, type index$9_Rating as Rating, type index$9_RatingInput as RatingInput, index$9_RatingSchema as RatingSchema, index$9_RatingTag as RatingTag, type index$9_SendToApproval as SendToApproval, Status$1 as Status, index$9_StatusConfig as StatusConfig, type index$9_StatusConfigType as StatusConfigType, type index$9_StreamTicket as StreamTicket, index$9_StreamTicketSchema as StreamTicketSchema, type index$9_Style as Style, index$9_Styles as Styles, type index$9_TimelineItem as TimelineItem, index$9_TimelineItemSchema as TimelineItemSchema };
 }
 
 declare const DailyMilestoneSchema: z.ZodObject<{
@@ -4082,6 +4098,53 @@ declare const UpdateShredUSessionSchema: z.ZodObject<{
     durationMin?: number | undefined;
     zoomUrl?: string | undefined;
 }>;
+declare const PreviewShredUEmailSchema: z.ZodObject<{
+    sessionId: z.ZodOptional<z.ZodString>;
+    topic: z.ZodString;
+    startsAt: z.ZodNumber;
+    durationMin: z.ZodNumber;
+    timezone: z.ZodString;
+    brief: z.ZodOptional<z.ZodObject<{
+        hook: z.ZodString;
+        intro: z.ZodArray<z.ZodString, "many">;
+        topics: z.ZodArray<z.ZodString, "many">;
+        signoff: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        hook: string;
+        intro: string[];
+        topics: string[];
+        signoff?: string | undefined;
+    }, {
+        hook: string;
+        intro: string[];
+        topics: string[];
+        signoff?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    timezone: string;
+    topic: string;
+    startsAt: number;
+    durationMin: number;
+    brief?: {
+        hook: string;
+        intro: string[];
+        topics: string[];
+        signoff?: string | undefined;
+    } | undefined;
+    sessionId?: string | undefined;
+}, {
+    timezone: string;
+    topic: string;
+    startsAt: number;
+    durationMin: number;
+    brief?: {
+        hook: string;
+        intro: string[];
+        topics: string[];
+        signoff?: string | undefined;
+    } | undefined;
+    sessionId?: string | undefined;
+}>;
 declare const SetShredUSessionRecordingSchema: z.ZodObject<{
     recordingUrl: z.ZodString;
     recordingThumbnailUrl: z.ZodOptional<z.ZodString>;
@@ -4103,6 +4166,7 @@ type ShredUSessionCustomer = z.infer<typeof ShredUSessionCustomerSchema>;
 type Create = z.infer<typeof CreateShredUSessionSchema>;
 type Update = z.infer<typeof UpdateShredUSessionSchema>;
 type SetRecording = z.infer<typeof SetShredUSessionRecordingSchema>;
+type PreviewEmail = z.infer<typeof PreviewShredUEmailSchema>;
 
 interface IAPI$1 {
     list: (ctx: Context) => Promise<ShredUSession[]>;
@@ -4113,6 +4177,7 @@ interface IAPI$1 {
     update: (ctx: Context, id: string, data: Update) => Promise<void>;
     cancel: (ctx: Context, id: string) => Promise<void>;
     setRecording: (ctx: Context, id: string, data: SetRecording) => Promise<void>;
+    previewEmail: (ctx: Context, data: PreviewEmail) => Promise<void>;
 }
 declare const Endpoints$1: {
     List: {
@@ -4147,12 +4212,18 @@ declare const Endpoints$1: {
         uri: string;
         method: string;
     };
+    PreviewEmail: {
+        uri: string;
+        method: string;
+    };
 };
 
 type index$3_Brief = Brief;
 type index$3_Create = Create;
 declare const index$3_CreateShredUBriefSchema: typeof CreateShredUBriefSchema;
 declare const index$3_CreateShredUSessionSchema: typeof CreateShredUSessionSchema;
+type index$3_PreviewEmail = PreviewEmail;
+declare const index$3_PreviewShredUEmailSchema: typeof PreviewShredUEmailSchema;
 type index$3_SessionAsset = SessionAsset;
 declare const index$3_SessionAssetSchema: typeof SessionAssetSchema;
 type index$3_SetRecording = SetRecording;
@@ -4166,7 +4237,7 @@ declare const index$3_ShredUSessionStatusSchema: typeof ShredUSessionStatusSchem
 type index$3_Update = Update;
 declare const index$3_UpdateShredUSessionSchema: typeof UpdateShredUSessionSchema;
 declare namespace index$3 {
-  export { type index$3_Brief as Brief, type index$3_Create as Create, index$3_CreateShredUBriefSchema as CreateShredUBriefSchema, index$3_CreateShredUSessionSchema as CreateShredUSessionSchema, Endpoints$1 as Endpoints, type ShredUSession as Entity, type IAPI$1 as IAPI, type index$3_SessionAsset as SessionAsset, index$3_SessionAssetSchema as SessionAssetSchema, type index$3_SetRecording as SetRecording, index$3_SetShredUSessionRecordingSchema as SetShredUSessionRecordingSchema, index$3_ShredUBriefSchema as ShredUBriefSchema, type index$3_ShredUSessionCustomer as ShredUSessionCustomer, index$3_ShredUSessionCustomerSchema as ShredUSessionCustomerSchema, index$3_ShredUSessionSchema as ShredUSessionSchema, type index$3_ShredUSessionStatus as ShredUSessionStatus, index$3_ShredUSessionStatusSchema as ShredUSessionStatusSchema, type index$3_Update as Update, index$3_UpdateShredUSessionSchema as UpdateShredUSessionSchema };
+  export { type index$3_Brief as Brief, type index$3_Create as Create, index$3_CreateShredUBriefSchema as CreateShredUBriefSchema, index$3_CreateShredUSessionSchema as CreateShredUSessionSchema, Endpoints$1 as Endpoints, type ShredUSession as Entity, type IAPI$1 as IAPI, type index$3_PreviewEmail as PreviewEmail, index$3_PreviewShredUEmailSchema as PreviewShredUEmailSchema, type index$3_SessionAsset as SessionAsset, index$3_SessionAssetSchema as SessionAssetSchema, type index$3_SetRecording as SetRecording, index$3_SetShredUSessionRecordingSchema as SetShredUSessionRecordingSchema, index$3_ShredUBriefSchema as ShredUBriefSchema, type index$3_ShredUSessionCustomer as ShredUSessionCustomer, index$3_ShredUSessionCustomerSchema as ShredUSessionCustomerSchema, index$3_ShredUSessionSchema as ShredUSessionSchema, type index$3_ShredUSessionStatus as ShredUSessionStatus, index$3_ShredUSessionStatusSchema as ShredUSessionStatusSchema, type index$3_Update as Update, index$3_UpdateShredUSessionSchema as UpdateShredUSessionSchema };
 }
 
 /**
@@ -4236,6 +4307,7 @@ declare const Actions: {
     readonly SHREDU_SESSION_UPDATE: "shredu.session.update";
     readonly SHREDU_SESSION_CANCEL: "shredu.session.cancel";
     readonly SHREDU_SESSION_SET_RECORDING: "shredu.session.set_recording";
+    readonly SHREDU_SESSION_PREVIEW_EMAIL: "shredu.session.preview_email";
     readonly SUBSCRIPTION_VIEW_USER: "subscription.view_user";
     readonly SUBSCRIPTION_VIEW_SUMMARY: "subscription.view_summary";
     readonly SUBSCRIPTION_LIST_PROMO_CODES: "subscription.list_promo_codes";

package/dist/index.js

@@ -5060,6 +5060,7 @@ __export(project_exports, {
   RatingTag: () => RatingTag,
   Status: () => Status2,
   StatusConfig: () => StatusConfig,
+  StreamTicketSchema: () => StreamTicketSchema,
   Styles: () => Styles,
   TimelineItemSchema: () => TimelineItemSchema
 });
@@ -5184,10 +5185,12 @@ var ProjectSchema = external_exports.object({
   tenantId: external_exports.string().optional(),
   status: external_exports.nativeEnum(Status2)
 });
+var StreamTicketSchema = external_exports.object({ ticket: external_exports.string().min(1) });
 
 // src/model/project/Project.api.ts
 var Endpoints3 = {
   Reorder: { uri: "/projects/reorder/", method: "POST" },
+  StreamTicket: { uri: "/projects/stream/ticket/", method: "POST" },
   List: { uri: "/projects/list", method: "GET" },
   Mine: { uri: "/projects/mine", method: "GET" },
   Assigned: { uri: "/projects/assigned", method: "GET" },
@@ -5550,6 +5553,18 @@ var ProjectAPI = class {
     );
     return data.success;
   }
+  async streamTicket(ctx) {
+    const endpointData = Endpoints3.StreamTicket;
+    const data = await this.clientHTTP.makeRequest(
+      this.env,
+      endpointData.uri,
+      endpointData.method,
+      null,
+      ctx,
+      StreamTicketSchema
+    );
+    return data.ticket;
+  }
   async cancel(ctx, projectId) {
     const endpointData = Endpoints3.Cancel;
     const endpoint = endpointData.uri.replace(":projectId", projectId);
@@ -6090,6 +6105,10 @@ var Endpoints9 = {
   SetRecording: {
     uri: "/shredu/sessions/:id/recording",
     method: "PUT"
+  },
+  PreviewEmail: {
+    uri: "/shredu/sessions/preview-email",
+    method: "POST"
   }
 };
 
@@ -6157,6 +6176,14 @@ var UpdateShredUSessionSchema = external_exports.object({
   tenantIds: external_exports.array(external_exports.string().min(1)).optional(),
   timezone: external_exports.string().min(1).optional()
 });
+var PreviewShredUEmailSchema = external_exports.object({
+  sessionId: external_exports.string().min(1).optional(),
+  topic: external_exports.string().min(1),
+  startsAt: external_exports.number().int().positive(),
+  durationMin: external_exports.number().int().positive(),
+  timezone: external_exports.string().min(1),
+  brief: CreateShredUBriefSchema.optional()
+});
 var SetShredUSessionRecordingSchema = external_exports.object({
   recordingUrl: external_exports.string().url(),
   recordingThumbnailUrl: external_exports.string().url().optional(),
@@ -6201,6 +6228,10 @@ var ShredUAPI = class {
     const { uri, method } = Endpoints9.SetRecording;
     await this.clientHTTP.makeRequest(this.env, uri.replace(":id", id), method, data, ctx);
   }
+  async previewEmail(ctx, data) {
+    const { uri, method } = Endpoints9.PreviewEmail;
+    await this.clientHTTP.makeRequest(this.env, uri, method, data, ctx);
+  }
 };
 var ShredU_api_default = ShredUAPI;
 
@@ -6286,6 +6317,7 @@ var Actions = {
   SHREDU_SESSION_UPDATE: "shredu.session.update",
   SHREDU_SESSION_CANCEL: "shredu.session.cancel",
   SHREDU_SESSION_SET_RECORDING: "shredu.session.set_recording",
+  SHREDU_SESSION_PREVIEW_EMAIL: "shredu.session.preview_email",
   // — Subscriptions —
   SUBSCRIPTION_VIEW_USER: "subscription.view_user",
   SUBSCRIPTION_VIEW_SUMMARY: "subscription.view_summary",
@@ -6381,6 +6413,7 @@ var ActionCatalog = {
   [Actions.SHREDU_SESSION_UPDATE]: { label: "Update a ShredU session", group: "ShredU" },
   [Actions.SHREDU_SESSION_CANCEL]: { label: "Cancel a ShredU session", group: "ShredU" },
   [Actions.SHREDU_SESSION_SET_RECORDING]: { label: "Attach a recording to a ShredU session", group: "ShredU" },
+  [Actions.SHREDU_SESSION_PREVIEW_EMAIL]: { label: "Send themselves a preview of the ShredU reminder email", group: "ShredU" },
   // Subscriptions
   [Actions.SUBSCRIPTION_VIEW_USER]: { label: "View a user's subscription", group: "Subscriptions" },
   [Actions.SUBSCRIPTION_VIEW_SUMMARY]: { label: "View a user's subscription summary", group: "Subscriptions" },
@@ -6986,6 +7019,7 @@ __export(shredu_exports, {
   CreateShredUBriefSchema: () => CreateShredUBriefSchema,
   CreateShredUSessionSchema: () => CreateShredUSessionSchema,
   Endpoints: () => Endpoints9,
+  PreviewShredUEmailSchema: () => PreviewShredUEmailSchema,
   SessionAssetSchema: () => SessionAssetSchema,
   SetShredUSessionRecordingSchema: () => SetShredUSessionRecordingSchema,
   ShredUBriefSchema: () => ShredUBriefSchema,