shred-api-client 2.10.2 → 2.10.4

package/dist/index.d.ts

@@ -3537,10 +3537,42 @@ declare const SessionAssetSchema: z.ZodObject<{
     uploadedAt?: number | undefined;
 }>;
 declare const ShredUSessionStatusSchema: z.ZodEnum<["scheduled", "cancelled"]>;
+declare const ShredUBriefSchema: 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;
+}>;
 declare const ShredUSessionSchema: z.ZodObject<{
     id: z.ZodString;
     topic: z.ZodString;
     description: 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;
+    }>>;
     startsAt: z.ZodNumber;
     durationMin: z.ZodNumber;
     zoomUrl: z.ZodString;
@@ -3615,6 +3647,12 @@ declare const ShredUSessionSchema: z.ZodObject<{
         authorId?: string | undefined;
         uploadedAt?: number | undefined;
     }[] | undefined;
+    brief?: {
+        hook: string;
+        intro: string[];
+        topics: string[];
+        signoff?: string | undefined;
+    } | undefined;
     recordingUrl?: string | undefined;
     recordingThumbnailUrl?: string | undefined;
     recordingDurationSeconds?: number | undefined;
@@ -3642,6 +3680,12 @@ declare const ShredUSessionSchema: z.ZodObject<{
         authorId?: string | undefined;
         uploadedAt?: number | undefined;
     }[] | undefined;
+    brief?: {
+        hook: string;
+        intro: string[];
+        topics: string[];
+        signoff?: string | undefined;
+    } | undefined;
     recordingUrl?: string | undefined;
     recordingThumbnailUrl?: string | undefined;
     recordingDurationSeconds?: number | undefined;
@@ -3651,6 +3695,22 @@ declare const ShredUSessionCustomerSchema: z.ZodObject<Omit<{
     id: z.ZodString;
     topic: z.ZodString;
     description: 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;
+    }>>;
     startsAt: z.ZodNumber;
     durationMin: z.ZodNumber;
     zoomUrl: z.ZodString;
@@ -3722,6 +3782,12 @@ declare const ShredUSessionCustomerSchema: z.ZodObject<Omit<{
         authorId?: string | undefined;
         uploadedAt?: number | undefined;
     }[] | undefined;
+    brief?: {
+        hook: string;
+        intro: string[];
+        topics: string[];
+        signoff?: string | undefined;
+    } | undefined;
     recordingUrl?: string | undefined;
     recordingThumbnailUrl?: string | undefined;
     recordingDurationSeconds?: number | undefined;
@@ -3746,13 +3812,51 @@ declare const ShredUSessionCustomerSchema: z.ZodObject<Omit<{
         authorId?: string | undefined;
         uploadedAt?: number | undefined;
     }[] | undefined;
+    brief?: {
+        hook: string;
+        intro: string[];
+        topics: string[];
+        signoff?: string | undefined;
+    } | undefined;
     recordingUrl?: string | undefined;
     recordingThumbnailUrl?: string | undefined;
     recordingDurationSeconds?: number | undefined;
 }>;
+declare const CreateShredUBriefSchema: 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;
+}>;
 declare const CreateShredUSessionSchema: z.ZodObject<{
     topic: z.ZodString;
     description: 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;
+    }>>;
     startsAt: z.ZodNumber;
     durationMin: z.ZodNumber;
     zoomUrl: z.ZodString;
@@ -3821,6 +3925,12 @@ declare const CreateShredUSessionSchema: z.ZodObject<{
         authorId?: string | undefined;
         uploadedAt?: number | undefined;
     }[] | undefined;
+    brief?: {
+        hook: string;
+        intro: string[];
+        topics: string[];
+        signoff?: string | undefined;
+    } | undefined;
 }, {
     timezone: string;
     description: string;
@@ -3843,10 +3953,32 @@ declare const CreateShredUSessionSchema: z.ZodObject<{
         authorId?: string | undefined;
         uploadedAt?: number | undefined;
     }[] | undefined;
+    brief?: {
+        hook: string;
+        intro: string[];
+        topics: string[];
+        signoff?: string | undefined;
+    } | undefined;
 }>;
 declare const UpdateShredUSessionSchema: z.ZodObject<{
     topic: z.ZodOptional<z.ZodString>;
     description: z.ZodOptional<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;
+    }>>;
     startsAt: z.ZodOptional<z.ZodNumber>;
     durationMin: z.ZodOptional<z.ZodNumber>;
     zoomUrl: z.ZodOptional<z.ZodString>;
@@ -3912,6 +4044,12 @@ declare const UpdateShredUSessionSchema: z.ZodObject<{
         uploadedAt?: number | undefined;
     }[] | undefined;
     topic?: string | undefined;
+    brief?: {
+        hook: string;
+        intro: string[];
+        topics: string[];
+        signoff?: string | undefined;
+    } | undefined;
     startsAt?: number | undefined;
     durationMin?: number | undefined;
     zoomUrl?: string | undefined;
@@ -3934,10 +4072,63 @@ declare const UpdateShredUSessionSchema: z.ZodObject<{
         uploadedAt?: number | undefined;
     }[] | undefined;
     topic?: string | undefined;
+    brief?: {
+        hook: string;
+        intro: string[];
+        topics: string[];
+        signoff?: string | undefined;
+    } | undefined;
     startsAt?: number | undefined;
     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>;
@@ -3952,12 +4143,14 @@ declare const SetShredUSessionRecordingSchema: z.ZodObject<{
     recordingThumbnailUrl?: string | undefined;
 }>;
 type SessionAsset = z.infer<typeof SessionAssetSchema>;
+type Brief = z.infer<typeof ShredUBriefSchema>;
 type ShredUSessionStatus = z.infer<typeof ShredUSessionStatusSchema>;
 type ShredUSession = z.infer<typeof ShredUSessionSchema>;
 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[]>;
@@ -3968,6 +4161,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: {
@@ -4002,14 +4196,23 @@ 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;
 declare const index$3_SetShredUSessionRecordingSchema: typeof SetShredUSessionRecordingSchema;
+declare const index$3_ShredUBriefSchema: typeof ShredUBriefSchema;
 type index$3_ShredUSessionCustomer = ShredUSessionCustomer;
 declare const index$3_ShredUSessionCustomerSchema: typeof ShredUSessionCustomerSchema;
 declare const index$3_ShredUSessionSchema: typeof ShredUSessionSchema;
@@ -4018,7 +4221,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_Create as Create, 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, 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 };
 }
 
 /**
@@ -4088,6 +4291,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

@@ -6090,6 +6090,10 @@ var Endpoints9 = {
   SetRecording: {
     uri: "/shredu/sessions/:id/recording",
     method: "PUT"
+  },
+  PreviewEmail: {
+    uri: "/shredu/sessions/preview-email",
+    method: "POST"
   }
 };
 
@@ -6102,10 +6106,17 @@ var SessionAssetSchema = AssetSchema.extend({
   uploadedAt: external_exports.number().optional()
 });
 var ShredUSessionStatusSchema = external_exports.enum(["scheduled", "cancelled"]);
+var ShredUBriefSchema = external_exports.object({
+  hook: external_exports.string(),
+  intro: external_exports.array(external_exports.string()),
+  topics: external_exports.array(external_exports.string()),
+  signoff: external_exports.string().optional()
+});
 var ShredUSessionSchema = external_exports.object({
   id: external_exports.string(),
   topic: external_exports.string(),
   description: external_exports.string(),
+  brief: ShredUBriefSchema.optional(),
   startsAt: external_exports.number(),
   durationMin: external_exports.number(),
   zoomUrl: external_exports.string(),
@@ -6122,9 +6133,16 @@ var ShredUSessionCustomerSchema = ShredUSessionSchema.omit({
   tenantIds: true,
   timezone: true
 });
+var CreateShredUBriefSchema = external_exports.object({
+  hook: external_exports.string().min(1),
+  intro: external_exports.array(external_exports.string().min(1)),
+  topics: external_exports.array(external_exports.string().min(1)),
+  signoff: external_exports.string().min(1).optional()
+});
 var CreateShredUSessionSchema = external_exports.object({
   topic: external_exports.string().min(1),
   description: external_exports.string().min(1),
+  brief: CreateShredUBriefSchema.optional(),
   startsAt: external_exports.number().int().positive(),
   durationMin: external_exports.number().int().positive(),
   zoomUrl: external_exports.string().url(),
@@ -6135,6 +6153,7 @@ var CreateShredUSessionSchema = external_exports.object({
 var UpdateShredUSessionSchema = external_exports.object({
   topic: external_exports.string().min(1).optional(),
   description: external_exports.string().min(1).optional(),
+  brief: CreateShredUBriefSchema.optional(),
   startsAt: external_exports.number().int().positive().optional(),
   durationMin: external_exports.number().int().positive().optional(),
   zoomUrl: external_exports.string().url().optional(),
@@ -6142,6 +6161,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(),
@@ -6186,6 +6213,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;
 
@@ -6271,6 +6302,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",
@@ -6366,6 +6398,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" },
@@ -6968,10 +7001,13 @@ __export(special_offer_exports, {
 // src/model/shredu/index.ts
 var shredu_exports = {};
 __export(shredu_exports, {
+  CreateShredUBriefSchema: () => CreateShredUBriefSchema,
   CreateShredUSessionSchema: () => CreateShredUSessionSchema,
   Endpoints: () => Endpoints9,
+  PreviewShredUEmailSchema: () => PreviewShredUEmailSchema,
   SessionAssetSchema: () => SessionAssetSchema,
   SetShredUSessionRecordingSchema: () => SetShredUSessionRecordingSchema,
+  ShredUBriefSchema: () => ShredUBriefSchema,
   ShredUSessionCustomerSchema: () => ShredUSessionCustomerSchema,
   ShredUSessionSchema: () => ShredUSessionSchema,
   ShredUSessionStatusSchema: () => ShredUSessionStatusSchema,