shred-api-client 2.6.2-rc.4 → 2.6.3

package/dist/index.d.ts

@@ -1540,154 +1540,7 @@ declare const ReportViewerUpdateSchema: z.ZodObject<{
     userId: string;
     action: Action;
 }>;
-declare const TenantUpdateSchema: z.ZodObject<{
-    preferences: z.ZodOptional<z.ZodObject<{
-        iconUrl: z.ZodString;
-        logoUrl: z.ZodString;
-        primaryColor: z.ZodString;
-        secondaryColor: z.ZodString;
-        guidelinesUrl: z.ZodOptional<z.ZodString>;
-        description: z.ZodOptional<z.ZodString>;
-        industry: z.ZodOptional<z.ZodString>;
-        assets: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            assetId: z.ZodString;
-            fileName: z.ZodString;
-            extension: z.ZodString;
-            fileSize: z.ZodNumber;
-            assetUrl: z.ZodString;
-            thumbnailUrl: z.ZodString;
-            type: z.ZodString;
-            duration: z.ZodOptional<z.ZodNumber>;
-            progress: z.ZodOptional<z.ZodNumber>;
-            error: z.ZodOptional<z.ZodString>;
-            authorId: z.ZodString;
-            uploadedAt: z.ZodNumber;
-        }, "strip", z.ZodTypeAny, {
-            type: string;
-            assetId: string;
-            fileName: string;
-            extension: string;
-            fileSize: number;
-            assetUrl: string;
-            thumbnailUrl: string;
-            authorId: string;
-            uploadedAt: number;
-            error?: string | undefined;
-            duration?: number | undefined;
-            progress?: number | undefined;
-        }, {
-            type: string;
-            assetId: string;
-            fileName: string;
-            extension: string;
-            fileSize: number;
-            assetUrl: string;
-            thumbnailUrl: string;
-            authorId: string;
-            uploadedAt: number;
-            error?: string | undefined;
-            duration?: number | undefined;
-            progress?: number | undefined;
-        }>, "many">>;
-    }, "strip", z.ZodTypeAny, {
-        iconUrl: string;
-        logoUrl: string;
-        primaryColor: string;
-        secondaryColor: string;
-        description?: string | undefined;
-        guidelinesUrl?: string | undefined;
-        industry?: string | undefined;
-        assets?: {
-            type: string;
-            assetId: string;
-            fileName: string;
-            extension: string;
-            fileSize: number;
-            assetUrl: string;
-            thumbnailUrl: string;
-            authorId: string;
-            uploadedAt: number;
-            error?: string | undefined;
-            duration?: number | undefined;
-            progress?: number | undefined;
-        }[] | undefined;
-    }, {
-        iconUrl: string;
-        logoUrl: string;
-        primaryColor: string;
-        secondaryColor: string;
-        description?: string | undefined;
-        guidelinesUrl?: string | undefined;
-        industry?: string | undefined;
-        assets?: {
-            type: string;
-            assetId: string;
-            fileName: string;
-            extension: string;
-            fileSize: number;
-            assetUrl: string;
-            thumbnailUrl: string;
-            authorId: string;
-            uploadedAt: number;
-            error?: string | undefined;
-            duration?: number | undefined;
-            progress?: number | undefined;
-        }[] | undefined;
-    }>>;
-    reportUrl: z.ZodOptional<z.ZodOptional<z.ZodString>>;
-}, "strip", z.ZodTypeAny, {
-    preferences?: {
-        iconUrl: string;
-        logoUrl: string;
-        primaryColor: string;
-        secondaryColor: string;
-        description?: string | undefined;
-        guidelinesUrl?: string | undefined;
-        industry?: string | undefined;
-        assets?: {
-            type: string;
-            assetId: string;
-            fileName: string;
-            extension: string;
-            fileSize: number;
-            assetUrl: string;
-            thumbnailUrl: string;
-            authorId: string;
-            uploadedAt: number;
-            error?: string | undefined;
-            duration?: number | undefined;
-            progress?: number | undefined;
-        }[] | undefined;
-    } | undefined;
-    reportUrl?: string | undefined;
-}, {
-    preferences?: {
-        iconUrl: string;
-        logoUrl: string;
-        primaryColor: string;
-        secondaryColor: string;
-        description?: string | undefined;
-        guidelinesUrl?: string | undefined;
-        industry?: string | undefined;
-        assets?: {
-            type: string;
-            assetId: string;
-            fileName: string;
-            extension: string;
-            fileSize: number;
-            assetUrl: string;
-            thumbnailUrl: string;
-            authorId: string;
-            uploadedAt: number;
-            error?: string | undefined;
-            duration?: number | undefined;
-            progress?: number | undefined;
-        }[] | undefined;
-    } | undefined;
-    reportUrl?: string | undefined;
-}>;
 type ReportViewerUpdate = z.infer<typeof ReportViewerUpdateSchema>;
-type TenantUpdate = z.infer<typeof TenantUpdateSchema>;
 type Tenant = z.infer<typeof TenantSchema>;
 type Member = z.infer<typeof MemberSchema>;
 type Preferences = z.infer<typeof PreferencesSchema>;
@@ -1698,7 +1551,7 @@ interface IAPI$9 {
     list: (context: Context) => 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>;
+    update: (tenantId: string, data: Pick<Tenant, "preferences">, context: Context) => Promise<boolean>;
     updateReportViewers: (tenantId: string, reportViewerUpdate: ReportViewerUpdate, context: Context) => Promise<boolean>;
 }
 declare const Endpoints$8: {
@@ -1745,10 +1598,8 @@ declare const index$a_PreferencesSchema: typeof PreferencesSchema;
 type index$a_ReportViewerUpdate = ReportViewerUpdate;
 declare const index$a_ReportViewerUpdateSchema: typeof ReportViewerUpdateSchema;
 declare const index$a_TenantSchema: typeof TenantSchema;
-type index$a_TenantUpdate = TenantUpdate;
-declare const index$a_TenantUpdateSchema: typeof TenantUpdateSchema;
 declare namespace index$a {
-  export { index$a_Action as Action, Endpoints$8 as Endpoints, type Tenant as Entity, type IAPI$9 as IAPI, type index$a_Member as Member, index$a_MemberSchema as MemberSchema, type index$a_Preferences as Preferences, index$a_PreferencesSchema as PreferencesSchema, type index$a_ReportViewerUpdate as ReportViewerUpdate, index$a_ReportViewerUpdateSchema as ReportViewerUpdateSchema, index$a_TenantSchema as TenantSchema, type index$a_TenantUpdate as TenantUpdate, index$a_TenantUpdateSchema as TenantUpdateSchema };
+  export { index$a_Action as Action, Endpoints$8 as Endpoints, type Tenant as Entity, type IAPI$9 as IAPI, type index$a_Member as Member, index$a_MemberSchema as MemberSchema, type index$a_Preferences as Preferences, index$a_PreferencesSchema as PreferencesSchema, type index$a_ReportViewerUpdate as ReportViewerUpdate, index$a_ReportViewerUpdateSchema as ReportViewerUpdateSchema, index$a_TenantSchema as TenantSchema };
 }
 
 declare const TrackParamSchema: z.ZodObject<{
@@ -1864,6 +1715,20 @@ type Style = {
     value: CaptionStyle;
     label: string;
 };
+declare enum InteractionType {
+    VIDEO_PLAYED = "video_played",
+    DOWNLOADED = "downloaded"
+}
+declare const InteractionSchema: z.ZodObject<{
+    type: z.ZodNativeEnum<typeof InteractionType>;
+    timestamp: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    type: InteractionType;
+    timestamp: number;
+}, {
+    type: InteractionType;
+    timestamp: number;
+}>;
 declare const TimelineItemSchema: z.ZodObject<{
     status: z.ZodNativeEnum<typeof Status$1>;
     title: z.ZodString;
@@ -1927,7 +1792,7 @@ declare const ProjectSchema: z.ZodObject<{
     finalVideoId: z.ZodOptional<z.ZodString>;
     thumbnailUrl: z.ZodOptional<z.ZodString>;
     modified: z.ZodNumber;
-    feedback: z.ZodOptional<z.ZodObject<{
+    feedback: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         criteria: z.ZodArray<z.ZodObject<{
             id: z.ZodString;
             label: z.ZodString;
@@ -1961,7 +1826,7 @@ declare const ProjectSchema: z.ZodObject<{
             comment?: string | undefined;
         }[];
         comment?: string | undefined;
-    }>>;
+    }>>>;
     captionSuggestion: z.ZodOptional<z.ZodString>;
     editorId: z.ZodOptional<z.ZodString>;
     userId: z.ZodString;
@@ -2026,6 +1891,16 @@ declare const ProjectSchema: z.ZodObject<{
         description: string;
         timestamp: number;
     }>, "many">;
+    interactions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        type: z.ZodNativeEnum<typeof InteractionType>;
+        timestamp: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        type: InteractionType;
+        timestamp: number;
+    }, {
+        type: InteractionType;
+        timestamp: number;
+    }>, "many">>;
     submitTimestamp: z.ZodNumber;
     tenantId: z.ZodOptional<z.ZodString>;
     status: z.ZodNativeEnum<typeof Status$1>;
@@ -2073,9 +1948,13 @@ declare const ProjectSchema: z.ZodObject<{
             comment?: string | undefined;
         }[];
         comment?: string | undefined;
-    } | undefined;
+    } | null | undefined;
     captionSuggestion?: string | undefined;
     isFree?: boolean | undefined;
+    interactions?: {
+        type: InteractionType;
+        timestamp: number;
+    }[] | undefined;
 }, {
     id: string;
     userId: string;
@@ -2120,9 +1999,13 @@ declare const ProjectSchema: z.ZodObject<{
             comment?: string | undefined;
         }[];
         comment?: string | undefined;
-    } | undefined;
+    } | null | undefined;
     captionSuggestion?: string | undefined;
     isFree?: boolean | undefined;
+    interactions?: {
+        type: InteractionType;
+        timestamp: number;
+    }[] | undefined;
 }>;
 type ProjectCreation = Pick<Project, "title" | "instructions" | "captionStyle" | "assets">;
 type SendToApproval = {
@@ -2133,10 +2016,11 @@ type SendToApproval = {
 type Approve = {
     scheduleTime?: number;
     captionSuggestion: string;
-    feedback?: Feedback;
+    feedback?: Feedback | null;
 };
 type Project = z.infer<typeof ProjectSchema>;
 type TimelineItem = z.infer<typeof TimelineItemSchema>;
+type Interaction = z.infer<typeof InteractionSchema>;
 type Feedback = z.infer<typeof FeedbackSchema>;
 
 interface IAPI$6 {
@@ -2155,6 +2039,7 @@ interface IAPI$6 {
     rollback: (context: Context, projectId: string) => Promise<boolean>;
     getNext: (context: Context, userId: string) => Promise<Project | null>;
     getUserHistory: (context: Context, userId: string) => Promise<APIResponse<Project>>;
+    interact: (context: Context, projectId: string, type: InteractionType) => Promise<boolean>;
     getPoolSize(context: Context): Promise<number>;
     permissions: {
         isEligibleForFreeProject(context: Context): Promise<boolean>;
@@ -2233,6 +2118,10 @@ declare const Endpoints$5: {
         uri: string;
         method: string;
     };
+    Interact: {
+        uri: string;
+        method: string;
+    };
 };
 
 type StatusConfigType = {
@@ -2272,6 +2161,10 @@ type index$7_CaptionStyle = CaptionStyle;
 declare const index$7_CaptionStyle: typeof CaptionStyle;
 type index$7_Feedback = Feedback;
 declare const index$7_FeedbackSchema: typeof FeedbackSchema;
+type index$7_Interaction = Interaction;
+declare const index$7_InteractionSchema: typeof InteractionSchema;
+type index$7_InteractionType = InteractionType;
+declare const index$7_InteractionType: typeof InteractionType;
 type index$7_ProjectCreation = ProjectCreation;
 declare const index$7_ProjectSchema: typeof ProjectSchema;
 type index$7_SendToApproval = SendToApproval;
@@ -2282,7 +2175,7 @@ declare const index$7_Styles: typeof Styles;
 type index$7_TimelineItem = TimelineItem;
 declare const index$7_TimelineItemSchema: typeof TimelineItemSchema;
 declare namespace index$7 {
-  export { type index$7_Approve as Approve, index$7_CaptionStyle as CaptionStyle, Endpoints$5 as Endpoints, type Project as Entity, type index$7_Feedback as Feedback, index$7_FeedbackSchema as FeedbackSchema, type IAPI$6 as IAPI, type index$7_ProjectCreation as ProjectCreation, index$7_ProjectSchema as ProjectSchema, type index$7_SendToApproval as SendToApproval, Status$1 as Status, index$7_StatusConfig as StatusConfig, type index$7_StatusConfigType as StatusConfigType, type index$7_Style as Style, index$7_Styles as Styles, type index$7_TimelineItem as TimelineItem, index$7_TimelineItemSchema as TimelineItemSchema };
+  export { type index$7_Approve as Approve, index$7_CaptionStyle as CaptionStyle, Endpoints$5 as Endpoints, type Project as Entity, type index$7_Feedback as Feedback, index$7_FeedbackSchema as FeedbackSchema, type IAPI$6 as IAPI, type index$7_Interaction as Interaction, index$7_InteractionSchema as InteractionSchema, index$7_InteractionType as InteractionType, type index$7_ProjectCreation as ProjectCreation, index$7_ProjectSchema as ProjectSchema, type index$7_SendToApproval as SendToApproval, Status$1 as Status, index$7_StatusConfig as StatusConfig, type index$7_StatusConfigType as StatusConfigType, type index$7_Style as Style, index$7_Styles as Styles, type index$7_TimelineItem as TimelineItem, index$7_TimelineItemSchema as TimelineItemSchema };
 }
 
 declare const DailyMilestoneSchema: z.ZodObject<{
@@ -2479,7 +2372,7 @@ declare const NotificationItemSchema: z.ZodObject<{
     status: z.ZodEnum<["failed", "delivered", "deleted"]>;
     deliveredAt: z.ZodNumber;
     openedAt: z.ZodOptional<z.ZodNumber>;
-    deletedAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    deletedAt: z.ZodOptional<z.ZodNumber>;
     cta: z.ZodOptional<z.ZodObject<{
         label: z.ZodString;
         url: z.ZodString;
@@ -2503,7 +2396,7 @@ declare const NotificationItemSchema: z.ZodObject<{
     triggerId?: string | undefined;
     type?: NotificationType | undefined;
     openedAt?: number | undefined;
-    deletedAt?: number | null | undefined;
+    deletedAt?: number | undefined;
     cta?: {
         label: string;
         url: string;
@@ -2520,7 +2413,7 @@ declare const NotificationItemSchema: z.ZodObject<{
     triggerId?: string | undefined;
     type?: NotificationType | undefined;
     openedAt?: number | undefined;
-    deletedAt?: number | null | undefined;
+    deletedAt?: number | undefined;
     cta?: {
         label: string;
         url: string;
@@ -2537,7 +2430,7 @@ declare const NotificationDetailSchema: z.ZodObject<Pick<{
     status: z.ZodEnum<["failed", "delivered", "deleted"]>;
     deliveredAt: z.ZodNumber;
     openedAt: z.ZodOptional<z.ZodNumber>;
-    deletedAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    deletedAt: z.ZodOptional<z.ZodNumber>;
     cta: z.ZodOptional<z.ZodObject<{
         label: z.ZodString;
         url: z.ZodString;
@@ -2678,7 +2571,7 @@ declare const TriggerSchema: z.ZodObject<{
         status: z.ZodEnum<["failed", "delivered", "deleted"]>;
         deliveredAt: z.ZodNumber;
         openedAt: z.ZodOptional<z.ZodNumber>;
-        deletedAt: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        deletedAt: z.ZodOptional<z.ZodNumber>;
         cta: z.ZodOptional<z.ZodObject<{
             label: z.ZodString;
             url: z.ZodString;

package/dist/index.js

@@ -4292,7 +4292,7 @@ var NotificationItemSchema = external_exports.object({
   status: external_exports.enum(["failed", "delivered", "deleted"]),
   deliveredAt: external_exports.number(),
   openedAt: external_exports.number().optional(),
-  deletedAt: external_exports.number().nullish(),
+  deletedAt: external_exports.number().optional(),
   cta: external_exports.object({ label: external_exports.string(), url: external_exports.string().url() }).optional(),
   metadata: external_exports.record(external_exports.string(), external_exports.union([external_exports.string(), external_exports.number()])),
   error: external_exports.string().optional()
@@ -4775,7 +4775,8 @@ var TenantAPI = class {
   }
   async updateReportViewers(tenantId, reportViewerUpdate, context) {
     const endpointInfo = tenant_exports.Endpoints.UpdateReportViewers;
-    const endpoint = endpointInfo.uri.replace(":tenantId", tenantId);
+    const endpointData = tenant_exports.Endpoints.UpdateReportViewers;
+    const endpoint = endpointData.uri.replace(":tenantId", tenantId);
     const data = await this.clientHTTP.makeRequest(
       this.env,
       `${endpoint}`,
@@ -5051,6 +5052,8 @@ __export(project_exports, {
   CaptionStyle: () => CaptionStyle,
   Endpoints: () => Endpoints3,
   FeedbackSchema: () => FeedbackSchema,
+  InteractionSchema: () => InteractionSchema,
+  InteractionType: () => InteractionType,
   ProjectSchema: () => ProjectSchema,
   Status: () => Status2,
   StatusConfig: () => StatusConfig,
@@ -5109,6 +5112,15 @@ var Styles = [
   { value: 3 /* TWO_LINES_EMOJIS */, label: "Two Lines + Emojis" },
   { value: 4 /* HOME_HIGHLIGHT */, label: "Home Tour" }
 ];
+var InteractionType = /* @__PURE__ */ ((InteractionType2) => {
+  InteractionType2["VIDEO_PLAYED"] = "video_played";
+  InteractionType2["DOWNLOADED"] = "downloaded";
+  return InteractionType2;
+})(InteractionType || {});
+var InteractionSchema = external_exports.object({
+  type: external_exports.nativeEnum(InteractionType),
+  timestamp: external_exports.number()
+});
 var TimelineItemSchema = external_exports.object({
   status: external_exports.nativeEnum(Status2),
   title: external_exports.string(),
@@ -5136,7 +5148,7 @@ var ProjectSchema = external_exports.object({
   finalVideoId: external_exports.string().optional(),
   thumbnailUrl: external_exports.string().optional(),
   modified: external_exports.number(),
-  feedback: FeedbackSchema.optional(),
+  feedback: FeedbackSchema.nullable().optional(),
   captionSuggestion: external_exports.string().optional(),
   editorId: external_exports.string().optional(),
   userId: external_exports.string(),
@@ -5144,6 +5156,7 @@ var ProjectSchema = external_exports.object({
   expirationTimestamp: external_exports.number(),
   isFree: external_exports.boolean().optional(),
   timeline: external_exports.array(TimelineItemSchema),
+  interactions: external_exports.array(InteractionSchema).optional(),
   submitTimestamp: external_exports.number(),
   tenantId: external_exports.string().optional(),
   status: external_exports.nativeEnum(Status2)
@@ -5174,7 +5187,8 @@ var Endpoints3 = {
   Deny: { uri: "/projects/:projectId/deny/", method: "POST" },
   Assign: { uri: "/projects/:projectId/assign/", method: "POST" },
   GetUserHistory: { uri: "/projects/user/:userId/history/", method: "GET" },
-  GetPoolSize: { uri: "/projects/pool/size/", method: "GET" }
+  GetPoolSize: { uri: "/projects/pool/size/", method: "GET" },
+  Interact: { uri: "/projects/:projectId/interactions/", method: "POST" }
 };
 
 // src/model/project/StatusConfig.ts
@@ -5569,6 +5583,18 @@ var ProjectAPI = class {
     );
     return data.success;
   }
+  async interact(ctx, projectId, type) {
+    const endpointData = Endpoints3.Interact;
+    const endpoint = endpointData.uri.replace(":projectId", projectId);
+    const data = await this.clientHTTP.makeRequest(
+      this.env,
+      endpoint,
+      endpointData.method,
+      { type },
+      ctx
+    );
+    return data.success;
+  }
   async start(context) {
     const endpointData = Endpoints3.StartEdition;
     const data = await this.clientHTTP.makeRequest(
@@ -6075,8 +6101,7 @@ __export(tenant_exports, {
   MemberSchema: () => MemberSchema,
   PreferencesSchema: () => PreferencesSchema,
   ReportViewerUpdateSchema: () => ReportViewerUpdateSchema,
-  TenantSchema: () => TenantSchema,
-  TenantUpdateSchema: () => TenantUpdateSchema
+  TenantSchema: () => TenantSchema
 });
 
 // src/model/subscription/Subscription.schema.ts
@@ -6173,7 +6198,7 @@ var TenantSchema = external_exports.object({
   subscription: external_exports.optional(external_exports.lazy(() => SubscriptionSchema)),
   totalSubscriptions: external_exports.number().optional(),
   totalUsers: external_exports.number().optional(),
-  reportUrl: external_exports.string().url().optional(),
+  reportUrl: external_exports.string().optional(),
   reportViewers: external_exports.array(external_exports.string()).optional()
 });
 var MemberSchema = external_exports.object({
@@ -6191,10 +6216,6 @@ var ReportViewerUpdateSchema = external_exports.object({
   userId: external_exports.string(),
   action: external_exports.nativeEnum(Action)
 });
-var TenantUpdateSchema = TenantSchema.pick({
-  reportUrl: true,
-  preferences: true
-}).partial();
 
 // src/model/tenant/Tenant.api.ts
 var Endpoints10 = {