shred-api-client 1.14.0 → 1.14.2

package/dist/api/Project.api.d.ts

@@ -1,10 +1,11 @@
 import Environment from "../model/Env";
-import { Approve, Project, ProjectAPISchema, ProjectCreation, Query, SendToApproval } from "../model/Project.schema";
+import { Approve, Goal, Project, ProjectAPISchema, ProjectCreation, Query, SendToApproval } from "../model/Project.schema";
 import Context from "../model/Context";
 declare class ProjectAPI implements ProjectAPISchema {
     private env;
     private clientHTTP;
     constructor(env: Environment);
+    getGoals(context: Context): Promise<Goal[]>;
     find(context: Context, projectId: string): Promise<Project>;
     create(context: Context, createData: ProjectCreation): Promise<Project>;
     review(ctx: Context, pId: string, revision: string): Promise<boolean>;
@@ -12,6 +13,7 @@ declare class ProjectAPI implements ProjectAPISchema {
     list(context: Context, query: Query): Promise<Project[]>;
     deny(ctx: Context, pId: string, denyFB: string, categories?: string[]): Promise<boolean>;
     unschedule(context: Context, projectId: string): Promise<boolean>;
+    rollback(context: Context, projectId: string): Promise<boolean>;
     start(context: Context, projectId: string): Promise<boolean>;
     approve(ctx: Context, pId: string, approve: Approve): Promise<boolean>;
     sendToApproval(context: Context, projectId: string, approval: SendToApproval): Promise<boolean>;

package/dist/api/Project.api.js

@@ -10,6 +10,11 @@ class ProjectAPI {
         this.env = env;
         this.clientHTTP = new HTTPClient_1.default();
     }
+    async getGoals(context) {
+        const endpointData = Project_schema_1.ProjectEndpoints.GetGoals;
+        const data = await this.clientHTTP.makeRequest(this.env, endpointData.uri, endpointData.method, null, context);
+        return data;
+    }
     async find(context, projectId) {
         const endpointData = Project_schema_1.ProjectEndpoints.FindOne;
         const endpoint = endpointData.uri.replace(":projectId", projectId);
@@ -50,6 +55,12 @@ class ProjectAPI {
         const data = await this.clientHTTP.makeRequest(this.env, endpoint, endpointData.method, null, context);
         return data.success;
     }
+    async rollback(context, projectId) {
+        const endpointData = Project_schema_1.ProjectEndpoints.Rollback;
+        const endpoint = endpointData.uri.replace(":projectId", projectId);
+        const data = await this.clientHTTP.makeRequest(this.env, endpoint, endpointData.method, null, context);
+        return data.success;
+    }
     async start(context, projectId) {
         const endpointData = Project_schema_1.ProjectEndpoints.StartEdition;
         const endpoint = endpointData.uri.replace(":projectId", projectId);

package/dist/model/Project.schema.d.ts

@@ -26,6 +26,8 @@ interface ProjectAPISchema {
     approve: (context: Context, projectId: string, data: Approve) => Promise<boolean>;
     deny: (context: Context, projectId: string, denyFeedback: string, categories?: string[]) => Promise<boolean>;
     unschedule: (context: Context, projectId: string) => Promise<boolean>;
+    rollback: (context: Context, projectId: string) => Promise<boolean>;
+    getGoals: (context: Context) => Promise<Goal[]>;
 }
 declare const ProjectEndpoints: {
     List: {
@@ -40,6 +42,10 @@ declare const ProjectEndpoints: {
         uri: string;
         method: string;
     };
+    GetGoals: {
+        uri: string;
+        method: string;
+    };
     Review: {
         uri: string;
         method: string;
@@ -64,6 +70,10 @@ declare const ProjectEndpoints: {
         uri: string;
         method: string;
     };
+    Rollback: {
+        uri: string;
+        method: string;
+    };
     Deny: {
         uri: string;
         method: string;
@@ -117,4 +127,26 @@ type Project = {
     tenantId?: string;
     status: Status;
 };
-export { Project, ProjectAPISchema, ProjectEndpoints, TimelineItem };
+type DailyMilestone = {
+    id: string;
+    date: string;
+    target: number;
+    progress: number;
+};
+type WeeklyMilestone = {
+    id: string;
+    week: string;
+    target: number;
+    progress: number;
+    dailyMilestones: DailyMilestone[];
+};
+type Goal = {
+    id: string;
+    editorId: string;
+    month: string;
+    target: number;
+    progress: number;
+    createdAt: number;
+    weeklyMilestones: WeeklyMilestone[];
+};
+export { Project, DailyMilestone, WeeklyMilestone, Goal, ProjectAPISchema, ProjectEndpoints, TimelineItem, };

package/dist/model/Project.schema.js

@@ -14,6 +14,10 @@ const ProjectEndpoints = {
         uri: `/projects/:projectId/`,
         method: "GET",
     },
+    GetGoals: {
+        uri: `/projects/goals/list/`,
+        method: "GET",
+    },
     Review: {
         uri: "/projects/:projectId/review/",
         method: "POST",
@@ -38,6 +42,10 @@ const ProjectEndpoints = {
         uri: "/projects/:projectId/unschedule/",
         method: "POST",
     },
+    Rollback: {
+        uri: "/projects/:projectId/rollback/",
+        method: "POST",
+    },
     Deny: {
         uri: "/projects/:projectId/deny/",
         method: "POST",

package/dist/namespace.d.ts

@@ -4,7 +4,7 @@ import { APIResponse } from "./model/Api";
 import { System as TSystem, User as TUser, Preferences as UserPreferences, Role as TRole } from "./model/User.schema";
 import { Email as TEmail } from "./model/Email.schema";
 import { Asset as TAsset } from "./model/Asset.schema";
-import { Project as TProject, TimelineItem as TTimlineItem } from "./model/Project.schema";
+import { Project as TProject, TimelineItem as TTimlineItem, WeeklyMilestone as TWeeklyMilestone, DailyMilestone as TDailyMilestone, Goal as TGoal } from "./model/Project.schema";
 import { Tenant as TTenant } from "./model/Tenant.schema";
 import { Track as TTrack } from "./model/Track.schema";
 import { Prompt as TPrompt, Script as TScript, Category as TCategory } from "./model/Prompt.schema";
@@ -30,6 +30,11 @@ export declare namespace Shred {
         type Category = TCategory;
     }
 }
+export declare namespace Goal {
+    type WeeklyMilestone = TWeeklyMilestone;
+    type DailyMilestone = TDailyMilestone;
+    type Month = TGoal;
+}
 export declare namespace Notification {
     enum Frequency {
         DAILY = "daily",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shred-api-client",
-  "version": "1.14.0",
+  "version": "1.14.2",
   "description": "API Client for Shred",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",