shred-api-client 2.6.2 → 2.6.3

package/dist/index.d.ts

@@ -1715,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;
@@ -1877,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>;
@@ -1927,6 +1951,10 @@ declare const ProjectSchema: z.ZodObject<{
     } | null | undefined;
     captionSuggestion?: string | undefined;
     isFree?: boolean | undefined;
+    interactions?: {
+        type: InteractionType;
+        timestamp: number;
+    }[] | undefined;
 }, {
     id: string;
     userId: string;
@@ -1974,6 +2002,10 @@ declare const ProjectSchema: z.ZodObject<{
     } | null | undefined;
     captionSuggestion?: string | undefined;
     isFree?: boolean | undefined;
+    interactions?: {
+        type: InteractionType;
+        timestamp: number;
+    }[] | undefined;
 }>;
 type ProjectCreation = Pick<Project, "title" | "instructions" | "captionStyle" | "assets">;
 type SendToApproval = {
@@ -1988,6 +2020,7 @@ type Approve = {
 };
 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 {
@@ -2006,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>;
@@ -2084,6 +2118,10 @@ declare const Endpoints$5: {
         uri: string;
         method: string;
     };
+    Interact: {
+        uri: string;
+        method: string;
+    };
 };
 
 type StatusConfigType = {
@@ -2123,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;
@@ -2133,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<{

package/dist/index.js

@@ -5052,6 +5052,8 @@ __export(project_exports, {
   CaptionStyle: () => CaptionStyle,
   Endpoints: () => Endpoints3,
   FeedbackSchema: () => FeedbackSchema,
+  InteractionSchema: () => InteractionSchema,
+  InteractionType: () => InteractionType,
   ProjectSchema: () => ProjectSchema,
   Status: () => Status2,
   StatusConfig: () => StatusConfig,
@@ -5110,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(),
@@ -5145,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)
@@ -5175,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
@@ -5570,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(