shred-api-client 2.9.7 → 2.9.8

package/dist/index.d.ts

@@ -1940,6 +1940,22 @@ declare const FeedbackSchema: z.ZodObject<{
     }[];
     comment?: string | undefined;
 }>;
+declare const RatingSchema: z.ZodObject<{
+    score: z.ZodNumber;
+    comment: z.ZodOptional<z.ZodString>;
+    timestamp: z.ZodNumber;
+    deliveryIndex: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    timestamp: number;
+    score: number;
+    deliveryIndex: number;
+    comment?: string | undefined;
+}, {
+    timestamp: number;
+    score: number;
+    deliveryIndex: number;
+    comment?: string | undefined;
+}>;
 declare const ProjectSchema: z.ZodObject<{
     id: z.ZodString;
     title: z.ZodString;
@@ -2058,6 +2074,22 @@ declare const ProjectSchema: z.ZodObject<{
         type: InteractionType;
         timestamp: number;
     }>, "many">>;
+    ratings: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        score: z.ZodNumber;
+        comment: z.ZodOptional<z.ZodString>;
+        timestamp: z.ZodNumber;
+        deliveryIndex: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        timestamp: number;
+        score: number;
+        deliveryIndex: number;
+        comment?: string | undefined;
+    }, {
+        timestamp: number;
+        score: number;
+        deliveryIndex: number;
+        comment?: string | undefined;
+    }>, "many">>;
     submitTimestamp: z.ZodNumber;
     tenantId: z.ZodOptional<z.ZodString>;
     status: z.ZodNativeEnum<typeof Status$1>;
@@ -2112,6 +2144,12 @@ declare const ProjectSchema: z.ZodObject<{
         type: InteractionType;
         timestamp: number;
     }[] | undefined;
+    ratings?: {
+        timestamp: number;
+        score: number;
+        deliveryIndex: number;
+        comment?: string | undefined;
+    }[] | undefined;
 }, {
     id: string;
     userId: string;
@@ -2163,6 +2201,12 @@ declare const ProjectSchema: z.ZodObject<{
         type: InteractionType;
         timestamp: number;
     }[] | undefined;
+    ratings?: {
+        timestamp: number;
+        score: number;
+        deliveryIndex: number;
+        comment?: string | undefined;
+    }[] | undefined;
 }>;
 type ProjectCreation = Pick<Project, "title" | "instructions" | "captionStyle" | "assets">;
 type SendToApproval = {
@@ -2179,6 +2223,8 @@ type Project = z.infer<typeof ProjectSchema>;
 type TimelineItem = z.infer<typeof TimelineItemSchema>;
 type Interaction = z.infer<typeof InteractionSchema>;
 type Feedback = z.infer<typeof FeedbackSchema>;
+type Rating = z.infer<typeof RatingSchema>;
+type RatingInput = Pick<Rating, "score" | "comment">;
 
 interface IAPI$7 {
     reorder: (context: Context, projectId: string, position: number) => Promise<boolean>;
@@ -2200,6 +2246,7 @@ interface IAPI$7 {
     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>;
+    rate: (context: Context, projectId: string, data: RatingInput) => Promise<boolean>;
     getPoolSize(context: Context): Promise<number>;
     permissions: {
         isEligibleForFreeProject(context: Context): Promise<boolean>;
@@ -2294,6 +2341,10 @@ declare const Endpoints$6: {
         uri: string;
         method: string;
     };
+    Rate: {
+        uri: string;
+        method: string;
+    };
 };
 
 type StatusConfigType = {
@@ -2339,6 +2390,9 @@ type index$8_InteractionType = InteractionType;
 declare const index$8_InteractionType: typeof InteractionType;
 type index$8_ProjectCreation = ProjectCreation;
 declare const index$8_ProjectSchema: typeof ProjectSchema;
+type index$8_Rating = Rating;
+type index$8_RatingInput = RatingInput;
+declare const index$8_RatingSchema: typeof RatingSchema;
 type index$8_SendToApproval = SendToApproval;
 declare const index$8_StatusConfig: typeof StatusConfig;
 type index$8_StatusConfigType = StatusConfigType;
@@ -2347,7 +2401,7 @@ declare const index$8_Styles: typeof Styles;
 type index$8_TimelineItem = TimelineItem;
 declare const index$8_TimelineItemSchema: typeof TimelineItemSchema;
 declare namespace index$8 {
-  export { type index$8_Approve as Approve, index$8_CaptionStyle as CaptionStyle, Endpoints$6 as Endpoints, type Project as Entity, type index$8_Feedback as Feedback, index$8_FeedbackSchema as FeedbackSchema, type IAPI$7 as IAPI, type index$8_Interaction as Interaction, index$8_InteractionSchema as InteractionSchema, index$8_InteractionType as InteractionType, type index$8_ProjectCreation as ProjectCreation, index$8_ProjectSchema as ProjectSchema, type index$8_SendToApproval as SendToApproval, Status$1 as Status, index$8_StatusConfig as StatusConfig, type index$8_StatusConfigType as StatusConfigType, type index$8_Style as Style, index$8_Styles as Styles, type index$8_TimelineItem as TimelineItem, index$8_TimelineItemSchema as TimelineItemSchema };
+  export { type index$8_Approve as Approve, index$8_CaptionStyle as CaptionStyle, Endpoints$6 as Endpoints, type Project as Entity, type index$8_Feedback as Feedback, index$8_FeedbackSchema as FeedbackSchema, type IAPI$7 as IAPI, type index$8_Interaction as Interaction, index$8_InteractionSchema as InteractionSchema, index$8_InteractionType as InteractionType, type index$8_ProjectCreation as ProjectCreation, index$8_ProjectSchema as ProjectSchema, type index$8_Rating as Rating, type index$8_RatingInput as RatingInput, index$8_RatingSchema as RatingSchema, type index$8_SendToApproval as SendToApproval, Status$1 as Status, index$8_StatusConfig as StatusConfig, type index$8_StatusConfigType as StatusConfigType, type index$8_Style as Style, index$8_Styles as Styles, type index$8_TimelineItem as TimelineItem, index$8_TimelineItemSchema as TimelineItemSchema };
 }
 
 declare const DailyMilestoneSchema: z.ZodObject<{
@@ -3428,6 +3482,7 @@ declare const Actions: {
     readonly PROJECT_REORDER: "project.reorder";
     readonly PROJECT_REQUEST_REVIEW: "project.request_review";
     readonly PROJECT_RECORD_INTERACTION: "project.record_interaction";
+    readonly PROJECT_RATE: "project.rate";
     readonly PROJECT_CHECK_FREE_QUOTA: "project.check_free_quota";
     readonly EDITOR_LIST: "editor.list";
     readonly EDITOR_GET: "editor.get";

package/dist/index.js

@@ -5055,6 +5055,7 @@ __export(project_exports, {
   InteractionSchema: () => InteractionSchema,
   InteractionType: () => InteractionType,
   ProjectSchema: () => ProjectSchema,
+  RatingSchema: () => RatingSchema,
   Status: () => Status2,
   StatusConfig: () => StatusConfig,
   Styles: () => Styles,
@@ -5140,6 +5141,12 @@ var FeedbackSchema = external_exports.object({
   ),
   comment: external_exports.string().optional()
 });
+var RatingSchema = external_exports.object({
+  score: external_exports.number().int().min(1).max(5),
+  comment: external_exports.string().max(500).optional(),
+  timestamp: external_exports.number(),
+  deliveryIndex: external_exports.number().int().min(0)
+});
 var ProjectSchema = external_exports.object({
   id: external_exports.string(),
   title: external_exports.string(),
@@ -5158,6 +5165,7 @@ var ProjectSchema = external_exports.object({
   isFree: external_exports.boolean().optional(),
   timeline: external_exports.array(TimelineItemSchema),
   interactions: external_exports.array(InteractionSchema).optional(),
+  ratings: external_exports.array(RatingSchema).optional(),
   submitTimestamp: external_exports.number(),
   tenantId: external_exports.string().optional(),
   status: external_exports.nativeEnum(Status2)
@@ -5192,7 +5200,8 @@ var Endpoints3 = {
   Assign: { uri: "/projects/:projectId/assign/", method: "POST" },
   GetUserHistory: { uri: "/projects/user/:userId/history/", method: "GET" },
   GetPoolSize: { uri: "/projects/pool/size/", method: "GET" },
-  Interact: { uri: "/projects/:projectId/interactions/", method: "POST" }
+  Interact: { uri: "/projects/:projectId/interactions/", method: "POST" },
+  Rate: { uri: "/projects/:projectId/rating/", method: "POST" }
 };
 
 // src/model/project/StatusConfig.ts
@@ -5618,6 +5627,18 @@ var ProjectAPI = class {
     );
     return data.success;
   }
+  async rate(ctx, projectId, data) {
+    const endpointData = Endpoints3.Rate;
+    const endpoint = endpointData.uri.replace(":projectId", projectId);
+    const result = await this.clientHTTP.makeRequest(
+      this.env,
+      endpoint,
+      endpointData.method,
+      data,
+      ctx
+    );
+    return result.success;
+  }
   async start(context) {
     const endpointData = Endpoints3.StartEdition;
     const data = await this.clientHTTP.makeRequest(
@@ -6056,6 +6077,7 @@ var Actions = {
   PROJECT_REORDER: "project.reorder",
   PROJECT_REQUEST_REVIEW: "project.request_review",
   PROJECT_RECORD_INTERACTION: "project.record_interaction",
+  PROJECT_RATE: "project.rate",
   PROJECT_CHECK_FREE_QUOTA: "project.check_free_quota",
   // — Editors —
   EDITOR_LIST: "editor.list",
@@ -6143,6 +6165,7 @@ var ActionCatalog = {
   [Actions.PROJECT_REORDER]: { label: "Reorder your own projects", group: "Projects" },
   [Actions.PROJECT_REQUEST_REVIEW]: { label: "Request a review on your own project", group: "Projects" },
   [Actions.PROJECT_RECORD_INTERACTION]: { label: "Record an interaction on your own project", group: "Projects" },
+  [Actions.PROJECT_RATE]: { label: "Rate a delivered video on your own project", group: "Projects" },
   [Actions.PROJECT_CHECK_FREE_QUOTA]: { label: "Check your own free-project quota", group: "Projects" },
   // Editors (staff)
   [Actions.EDITOR_LIST]: { label: "List all editors", group: "Editors" },