shred-api-client 2.9.6 → 2.9.8

package/dist/index.d.ts

@@ -1539,25 +1539,15 @@ declare enum Action$1 {
     ADD = "ADD",
     REMOVE = "REMOVE"
 }
-declare const ReportViewerUpdateSchema: z.ZodObject<{
-    userId: z.ZodString;
-    action: z.ZodNativeEnum<typeof Action$1>;
-}, "strip", z.ZodTypeAny, {
-    userId: string;
-    action: Action$1;
-}, {
-    userId: string;
-    action: Action$1;
-}>;
 declare const MemberUpdateSchema: z.ZodObject<{
     userIds: z.ZodArray<z.ZodString, "many">;
     action: z.ZodNativeEnum<typeof Action$1>;
 }, "strip", z.ZodTypeAny, {
-    action: Action$1;
     userIds: string[];
-}, {
     action: Action$1;
+}, {
     userIds: string[];
+    action: Action$1;
 }>;
 declare const TenantUpdateSchema: z.ZodObject<{
     preferences: z.ZodOptional<z.ZodObject<{
@@ -1705,7 +1695,6 @@ declare const TenantUpdateSchema: z.ZodObject<{
     } | undefined;
     reportUrl?: string | undefined;
 }>;
-type ReportViewerUpdate = z.infer<typeof ReportViewerUpdateSchema>;
 type MemberUpdate = z.infer<typeof MemberUpdateSchema>;
 type TenantUpdate = z.infer<typeof TenantUpdateSchema>;
 type Tenant = z.infer<typeof TenantSchema>;
@@ -1719,7 +1708,6 @@ interface IAPI$a {
     getTenant: (context: Context, tenantId?: string) => Promise<Tenant | null>;
     getMembers: (context: Context, tenantId: string) => Promise<Member[]>;
     update: (tenantId: string, data: TenantUpdate, context: Context) => Promise<boolean>;
-    updateReportViewers: (tenantId: string, reportViewerUpdate: ReportViewerUpdate, context: Context) => Promise<boolean>;
     updateMembers: (tenantId: string, memberUpdate: MemberUpdate, context: Context) => Promise<boolean>;
 }
 declare const Endpoints$9: {
@@ -1751,10 +1739,6 @@ declare const Endpoints$9: {
         uri: string;
         method: string;
     };
-    UpdateReportViewers: {
-        uri: string;
-        method: string;
-    };
     UpdateMembers: {
         uri: string;
         method: string;
@@ -1767,13 +1751,11 @@ type index$b_MemberUpdate = MemberUpdate;
 declare const index$b_MemberUpdateSchema: typeof MemberUpdateSchema;
 type index$b_Preferences = Preferences;
 declare const index$b_PreferencesSchema: typeof PreferencesSchema;
-type index$b_ReportViewerUpdate = ReportViewerUpdate;
-declare const index$b_ReportViewerUpdateSchema: typeof ReportViewerUpdateSchema;
 declare const index$b_TenantSchema: typeof TenantSchema;
 type index$b_TenantUpdate = TenantUpdate;
 declare const index$b_TenantUpdateSchema: typeof TenantUpdateSchema;
 declare namespace index$b {
-  export { Action$1 as Action, Endpoints$9 as Endpoints, type Tenant as Entity, type IAPI$a as IAPI, type index$b_Member as Member, index$b_MemberSchema as MemberSchema, type index$b_MemberUpdate as MemberUpdate, index$b_MemberUpdateSchema as MemberUpdateSchema, type index$b_Preferences as Preferences, index$b_PreferencesSchema as PreferencesSchema, type index$b_ReportViewerUpdate as ReportViewerUpdate, index$b_ReportViewerUpdateSchema as ReportViewerUpdateSchema, index$b_TenantSchema as TenantSchema, type index$b_TenantUpdate as TenantUpdate, index$b_TenantUpdateSchema as TenantUpdateSchema };
+  export { Action$1 as Action, Endpoints$9 as Endpoints, type Tenant as Entity, type IAPI$a as IAPI, type index$b_Member as Member, index$b_MemberSchema as MemberSchema, type index$b_MemberUpdate as MemberUpdate, index$b_MemberUpdateSchema as MemberUpdateSchema, type index$b_Preferences as Preferences, index$b_PreferencesSchema as PreferencesSchema, index$b_TenantSchema as TenantSchema, type index$b_TenantUpdate as TenantUpdate, index$b_TenantUpdateSchema as TenantUpdateSchema };
 }
 
 declare const TrackParamSchema: z.ZodObject<{
@@ -1958,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;
@@ -2076,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>;
@@ -2130,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;
@@ -2181,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 = {
@@ -2197,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>;
@@ -2218,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>;
@@ -2312,6 +2341,10 @@ declare const Endpoints$6: {
         uri: string;
         method: string;
     };
+    Rate: {
+        uri: string;
+        method: string;
+    };
 };
 
 type StatusConfigType = {
@@ -2357,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;
@@ -2365,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<{
@@ -3446,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";
@@ -3468,7 +3505,6 @@ declare const Actions: {
     readonly TENANT_UPDATE: "tenant.update";
     readonly TENANT_VIEW_MEMBERS: "tenant.view_members";
     readonly TENANT_UPDATE_MEMBERS: "tenant.update_members";
-    readonly TENANT_UPDATE_REPORT_VIEWERS: "tenant.update_report_viewers";
     readonly TENANT_VIEW_REPORT: "tenant.view_report";
     readonly TENANT_VIEW_MINE: "tenant.view_mine";
     readonly OFFER_LIST: "offer.list";

package/dist/index.js

@@ -4774,18 +4774,6 @@ var TenantAPI = class {
     );
     return data;
   }
-  async updateReportViewers(tenantId, reportViewerUpdate, context) {
-    const endpointInfo = tenant_exports.Endpoints.UpdateReportViewers;
-    const endpoint = endpointInfo.uri.replace(":tenantId", tenantId);
-    const data = await this.clientHTTP.makeRequest(
-      this.env,
-      `${endpoint}`,
-      endpointInfo.method,
-      reportViewerUpdate,
-      context
-    );
-    return data;
-  }
   async updateMembers(tenantId, memberUpdate, context) {
     const endpointInfo = tenant_exports.Endpoints.UpdateMembers;
     const endpoint = endpointInfo.uri.replace(":tenantId", tenantId);
@@ -5067,6 +5055,7 @@ __export(project_exports, {
   InteractionSchema: () => InteractionSchema,
   InteractionType: () => InteractionType,
   ProjectSchema: () => ProjectSchema,
+  RatingSchema: () => RatingSchema,
   Status: () => Status2,
   StatusConfig: () => StatusConfig,
   Styles: () => Styles,
@@ -5152,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(),
@@ -5170,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)
@@ -5204,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
@@ -5630,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(
@@ -6068,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",
@@ -6095,7 +6105,6 @@ var Actions = {
   TENANT_UPDATE: "tenant.update",
   TENANT_VIEW_MEMBERS: "tenant.view_members",
   TENANT_UPDATE_MEMBERS: "tenant.update_members",
-  TENANT_UPDATE_REPORT_VIEWERS: "tenant.update_report_viewers",
   TENANT_VIEW_REPORT: "tenant.view_report",
   TENANT_VIEW_MINE: "tenant.view_mine",
   // — Offers —
@@ -6156,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" },
@@ -6183,7 +6193,6 @@ var ActionCatalog = {
   [Actions.TENANT_UPDATE]: { label: "Update any tenant", group: "Tenants" },
   [Actions.TENANT_VIEW_MEMBERS]: { label: "View a tenant's members", group: "Tenants" },
   [Actions.TENANT_UPDATE_MEMBERS]: { label: "Manage a tenant's members", group: "Tenants" },
-  [Actions.TENANT_UPDATE_REPORT_VIEWERS]: { label: "Manage a tenant's report viewers", group: "Tenants" },
   [Actions.TENANT_VIEW_REPORT]: { label: "View a tenant's report", group: "Tenants", scopeable: true },
   [Actions.TENANT_VIEW_MINE]: { label: "View your own tenant", group: "Tenants" },
   // Offers
@@ -6440,7 +6449,6 @@ __export(tenant_exports, {
   MemberSchema: () => MemberSchema,
   MemberUpdateSchema: () => MemberUpdateSchema,
   PreferencesSchema: () => PreferencesSchema,
-  ReportViewerUpdateSchema: () => ReportViewerUpdateSchema,
   TenantSchema: () => TenantSchema,
   TenantUpdateSchema: () => TenantUpdateSchema
 });
@@ -6555,10 +6563,6 @@ var Action = /* @__PURE__ */ ((Action2) => {
   Action2["REMOVE"] = "REMOVE";
   return Action2;
 })(Action || {});
-var ReportViewerUpdateSchema = external_exports.object({
-  userId: external_exports.string(),
-  action: external_exports.nativeEnum(Action)
-});
 var MemberUpdateSchema = external_exports.object({
   userIds: external_exports.array(external_exports.string()),
   action: external_exports.nativeEnum(Action)
@@ -6598,10 +6602,6 @@ var Endpoints11 = {
     uri: "/tenants/:tenantId/members",
     method: "GET"
   },
-  UpdateReportViewers: {
-    uri: "/tenants/:tenantId/report-viewers",
-    method: "PUT"
-  },
   UpdateMembers: {
     uri: "/tenants/:tenantId/members",
     method: "PUT"