shred-api-client 1.12.1-rc.3 → 1.12.2

package/dist/api/Notification.api.d.ts

@@ -1,10 +1,15 @@
 import Environment from "../model/Env";
-import { NotificationSchema, NotificationDetail } from "../model/Notification.schema";
+import { NotificationSchema, NotificationDetail, Trigger } from "../model/Notification.schema";
 import Context from "../model/Context";
+import { APIResponse } from "../model/Api";
 declare class NotificationAPI implements NotificationSchema {
     private env;
     private clientHTTP;
     constructor(env: Environment);
+    deleteTrigger(ctx: Context, triggerId: string): Promise<boolean>;
+    updateTrigger(ctx: Context, triggerId: string, t: Partial<Trigger>): Promise<Trigger>;
+    createTrigger(ctx: Context, t: Trigger): Promise<Trigger>;
+    getTriggers(ctx: Context): Promise<APIResponse<Trigger>>;
     push(ctx: Context, notification: NotificationDetail): Promise<boolean>;
 }
 export default NotificationAPI;

package/dist/api/Notification.api.js

@@ -10,6 +10,28 @@ class NotificationAPI {
         this.env = env;
         this.clientHTTP = new HTTPClient_1.default();
     }
+    async deleteTrigger(ctx, triggerId) {
+        const endpointData = Notification_schema_1.NotificationEndpoints.Delete;
+        const endpoint = endpointData.uri.replace(":id", triggerId);
+        const data = await this.clientHTTP.makeRequest(this.env, endpoint, endpointData.method, null, ctx);
+        return data;
+    }
+    async updateTrigger(ctx, triggerId, t) {
+        const endpointData = Notification_schema_1.NotificationEndpoints.Update;
+        const endpoint = endpointData.uri.replace(":id", triggerId);
+        const data = await this.clientHTTP.makeRequest(this.env, endpoint, endpointData.method, t, ctx);
+        return data;
+    }
+    async createTrigger(ctx, t) {
+        const endpointData = Notification_schema_1.NotificationEndpoints.Create;
+        const data = await this.clientHTTP.makeRequest(this.env, endpointData.uri, endpointData.method, t, ctx);
+        return data;
+    }
+    async getTriggers(ctx) {
+        const endpointInfo = Notification_schema_1.NotificationEndpoints.List;
+        const data = await this.clientHTTP.makeRequest(this.env, endpointInfo.uri, endpointInfo.method, null, ctx);
+        return data;
+    }
     async push(ctx, notification) {
         const endpointInfo = Notification_schema_1.NotificationEndpoints.Push;
         const data = await this.clientHTTP.makeRequest(this.env, endpointInfo.uri, endpointInfo.method, notification, ctx);

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

@@ -10,7 +10,7 @@ declare class ProjectAPI implements ProjectAPISchema {
     review(ctx: Context, pId: string, revision: string): Promise<boolean>;
     cancel(ctx: Context, projectId: string): Promise<boolean>;
     list(context: Context, query: Query): Promise<Project[]>;
-    deny(ctx: Context, pId: string, denyFB: string): Promise<boolean>;
+    deny(ctx: Context, pId: string, denyFB: string, categories?: string[]): Promise<boolean>;
     unschedule(context: Context, projectId: string): Promise<boolean>;
     start(context: Context, projectId: string): Promise<boolean>;
     approve(ctx: Context, pId: string, approve: Approve): Promise<boolean>;

package/dist/api/Project.api.js

@@ -38,10 +38,10 @@ class ProjectAPI {
         const data = await this.clientHTTP.makeRequest(this.env, `${endpointData.uri}?startDate=${query.startDate}&endDate=${query.endDate}&timezone=${query.timeZone}`, endpointData.method, null, context);
         return data;
     }
-    async deny(ctx, pId, denyFB) {
+    async deny(ctx, pId, denyFB, categories) {
         const endpointData = Project_schema_1.ProjectEndpoints.Deny;
         const endpoint = endpointData.uri.replace(":projectId", pId);
-        const data = await this.clientHTTP.makeRequest(this.env, endpoint, endpointData.method, { denyFeedback: denyFB }, ctx);
+        const data = await this.clientHTTP.makeRequest(this.env, endpoint, endpointData.method, { denyFeedback: denyFB, categories: categories || [] }, ctx);
         return data.success;
     }
     async unschedule(context, projectId) {

package/dist/api/Subscription.api.d.ts

@@ -5,11 +5,13 @@ declare class SubscriptionAPI implements SubscriptionAPISchema {
     private env;
     private clientHTTP;
     constructor(env: Environment);
+    updatePlan(ctx: Context, planId: string): Promise<boolean>;
     getProduct(id: string, context?: Context): Promise<Product>;
     getCharges(ctx: Context): Promise<Charge[]>;
     getSubscription(context: Context, userId?: string): Promise<Subscription | null>;
     charge(ctx: Context): Promise<boolean>;
-    disableAutomaticRenew(ctx: Context): Promise<boolean>;
+    pause(ctx: Context): Promise<boolean>;
+    resume(ctx: Context): Promise<boolean>;
     getProducts(ctx?: Context): Promise<Product[]>;
     createCheckout(planId: string | null, ctx: Context): Promise<string>;
 }

package/dist/api/Subscription.api.js

@@ -10,6 +10,11 @@ class SubscriptionAPI {
         this.env = env;
         this.clientHTTP = new HTTPClient_1.default();
     }
+    async updatePlan(ctx, planId) {
+        const endpointInfo = Subscription_schema_1.SubscriptionEndpoints.UpdatePlan;
+        const data = await this.clientHTTP.makeRequest(this.env, endpointInfo.uri, endpointInfo.method, { planId }, ctx);
+        return data;
+    }
     async getProduct(id, context) {
         const endpointInfo = Subscription_schema_1.SubscriptionEndpoints.GetProduct;
         const data = await this.clientHTTP.makeRequest(this.env, `${endpointInfo.uri}/${id}`, endpointInfo.method, null, context);
@@ -38,8 +43,13 @@ class SubscriptionAPI {
         const data = await this.clientHTTP.makeRequest(this.env, endpointInfo.uri, endpointInfo.method, null, ctx);
         return data.success;
     }
-    async disableAutomaticRenew(ctx) {
-        const endpointInfo = Subscription_schema_1.SubscriptionEndpoints.DisableAutomaticRenew;
+    async pause(ctx) {
+        const endpointInfo = Subscription_schema_1.SubscriptionEndpoints.Pause;
+        const data = await this.clientHTTP.makeRequest(this.env, endpointInfo.uri, endpointInfo.method, null, ctx);
+        return data;
+    }
+    async resume(ctx) {
+        const endpointInfo = Subscription_schema_1.SubscriptionEndpoints.Resume;
         const data = await this.clientHTTP.makeRequest(this.env, endpointInfo.uri, endpointInfo.method, null, ctx);
         return data;
     }

package/dist/model/Api.d.ts

@@ -8,6 +8,12 @@ import { TenantAPISchema } from "./Tenant.schema";
 import { ProjectAPISchema } from "./Project.schema";
 import { APPConfigSchema } from "./AppConfig.schema";
 import { TrackAPISchema } from "./Track.schema";
+export type APIResponse<T> = {
+    perPage: number;
+    last?: T;
+    data: T[];
+    count: number;
+};
 export declare class ShredAPI {
     user: UserAPISchema;
     subscription: SubscriptionAPISchema;

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

@@ -1,9 +1,30 @@
 import Context from "./Context";
 import { Notification } from "./../namespace";
+import { APIResponse } from "./Api";
 interface NotificationSchema {
+    getTriggers: (ctx: Context) => Promise<APIResponse<Trigger>>;
+    createTrigger: (ctx: Context, t: Trigger) => Promise<Trigger>;
+    deleteTrigger: (ctx: Context, triggerId: string) => Promise<boolean>;
+    updateTrigger: (ctx: Context, triggerId: string, trigger: Partial<Trigger>) => Promise<Trigger>;
     push: (context: Context, notification: NotificationDetail) => Promise<boolean>;
 }
 declare const NotificationEndpoints: {
+    Create: {
+        uri: string;
+        method: string;
+    };
+    List: {
+        uri: string;
+        method: string;
+    };
+    Update: {
+        uri: string;
+        method: string;
+    };
+    Delete: {
+        uri: string;
+        method: string;
+    };
     Push: {
         uri: string;
         method: string;
@@ -23,30 +44,54 @@ type History = {
         success: number;
         error: number;
     };
-    errorList?: string[];
+    errorList?: {
+        token: string;
+        error: string;
+    }[];
     executionTimeDuration?: number;
 };
+type RecurrenceRule = {
+    frequency: Notification.Frequency;
+    interval: number;
+    weekDays?: Notification.WeekDay[];
+    dayOfMonth?: number;
+    endDate?: string;
+    ocurrences?: number;
+};
 type Trigger = {
     id: string;
     title: string;
     description: string;
     transportType: Notification.TransportType[];
     notification: NotificationDetail;
-    executionTime: string;
-    repeatDays: Notification.WeekDay[];
     history?: History[];
     status: Notification.Status;
-    isRecurring: boolean;
-    executionDate?: number;
+    recurrence?: RecurrenceRule;
+    timezone?: string | null;
+    tenantIds?: string[];
+    executionDate?: string;
+    timeOfDay: string;
     criteria: Criteria;
     nextExecution?: number;
     createdAt?: number;
     modified?: number;
 };
+type NotificationItem = {
+    id: string;
+    userId: string;
+    triggerId?: string;
+    title: string;
+    body: string;
+    status: "failed" | "delivered";
+    deliveredAt: number;
+    openedAt?: number;
+    metadata: Record<string, string | number>;
+    error?: string;
+};
 type NotificationDetail = {
     title: string;
     body: string;
     userToken?: string;
-    metadata?: any;
+    metadata?: Record<string, any>;
 };
-export { NotificationSchema, NotificationEndpoints, NotificationDetail, Trigger, Criteria, History, };
+export { NotificationItem, NotificationSchema, NotificationEndpoints, NotificationDetail, RecurrenceRule, Trigger, Criteria, History, };

package/dist/model/Notification.schema.js

@@ -2,6 +2,22 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotificationEndpoints = void 0;
 const NotificationEndpoints = {
+    Create: {
+        uri: "/notifications/trigger/",
+        method: "POST",
+    },
+    List: {
+        uri: "/notifications/trigger/list/",
+        method: "GET",
+    },
+    Update: {
+        uri: "/notifications/trigger/:id/",
+        method: "PUT",
+    },
+    Delete: {
+        uri: "/notifications/trigger/:id/",
+        method: "DELETE",
+    },
     Push: {
         uri: "/notifications/push/",
         method: "POST",

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

@@ -24,7 +24,7 @@ interface ProjectAPISchema {
     start: (context: Context, projectId: string) => Promise<boolean>;
     sendToApproval: (context: Context, projectId: string, data: SendToApproval) => Promise<boolean>;
     approve: (context: Context, projectId: string, data: Approve) => Promise<boolean>;
-    deny: (context: Context, projectId: string, denyFeedback: string) => Promise<boolean>;
+    deny: (context: Context, projectId: string, denyFeedback: string, categories?: string[]) => Promise<boolean>;
     unschedule: (context: Context, projectId: string) => Promise<boolean>;
 }
 declare const ProjectEndpoints: {
@@ -80,46 +80,58 @@ export declare enum Status {
     SCHEDULED = 7
 }
 export declare enum CaptionStyle {
-    ONE_LINE = "1",
-    ONE_LINE_EMOJIS = "2",
-    TWO_LINES = "5",
-    TWO_LINES_EMOJIS = "3",
-    HOME_HIGHLIGHT = "4"
+    ONE_LINE = 1,
+    ONE_LINE_EMOJIS = 2,
+    TWO_LINES = 5,
+    TWO_LINES_EMOJIS = 3,
+    HOME_HIGHLIGHT = 4
 }
-export declare const Styles: Record<CaptionStyle, string>;
+interface Style {
+    value: CaptionStyle;
+    label: string;
+}
+export declare const Styles: Style[];
 type DenyFeedback = {
     timestamp: number;
     feedback: string;
     resolved: boolean;
+    categories?: string[];
+};
+type TimelineItem = {
+    status: Status;
+    title: string;
+    description: string;
+    timestamp: number;
+    metadata: Record<string, any>;
 };
 type Project = {
     id: string;
     title: string;
     instructions: string;
     submitMonth: string;
-    status: Status;
     captionStyle: CaptionStyle;
     finalVideoId?: string;
-    canRevision: boolean;
     thumbnailUrl?: string;
-    revision?: string;
     modified: number;
     captionSuggestion?: string;
     editorId: string;
     userId: string;
     assets?: Asset[];
-    denyFeedback?: DenyFeedback[];
-    approvedBy?: string;
-    approveTimestamp?: number;
     expirationTimestamp: number;
+    timeline?: TimelineItem[];
+    approveTimestamp?: number;
     sentToApproveTimestamp?: number;
     submitTimestamp: number;
     editTimestamp?: number;
     completeTimestamp?: number;
     revisedAt?: number;
-    isFreeProject?: boolean;
     scheduledAt?: number;
     scheduledTime?: number;
+    revision?: string;
+    canRevision: boolean;
+    denyFeedback?: DenyFeedback[];
+    approvedBy?: string;
+    status: Status;
     tenantId?: string;
 };
-export { Project, ProjectAPISchema, ProjectEndpoints };
+export { Project, ProjectAPISchema, ProjectEndpoints, TimelineItem };

package/dist/model/Project.schema.js

@@ -12,7 +12,7 @@ const ProjectEndpoints = {
     },
     FindOne: {
         uri: `/projects/:projectId/`,
-        method: "POST",
+        method: "GET",
     },
     Review: {
         uri: "/projects/:projectId/review/",
@@ -57,16 +57,16 @@ var Status;
 })(Status || (exports.Status = Status = {}));
 var CaptionStyle;
 (function (CaptionStyle) {
-    CaptionStyle["ONE_LINE"] = "1";
-    CaptionStyle["ONE_LINE_EMOJIS"] = "2";
-    CaptionStyle["TWO_LINES"] = "5";
-    CaptionStyle["TWO_LINES_EMOJIS"] = "3";
-    CaptionStyle["HOME_HIGHLIGHT"] = "4";
+    CaptionStyle[CaptionStyle["ONE_LINE"] = 1] = "ONE_LINE";
+    CaptionStyle[CaptionStyle["ONE_LINE_EMOJIS"] = 2] = "ONE_LINE_EMOJIS";
+    CaptionStyle[CaptionStyle["TWO_LINES"] = 5] = "TWO_LINES";
+    CaptionStyle[CaptionStyle["TWO_LINES_EMOJIS"] = 3] = "TWO_LINES_EMOJIS";
+    CaptionStyle[CaptionStyle["HOME_HIGHLIGHT"] = 4] = "HOME_HIGHLIGHT";
 })(CaptionStyle || (exports.CaptionStyle = CaptionStyle = {}));
-exports.Styles = {
-    [CaptionStyle.ONE_LINE]: "One Line",
-    [CaptionStyle.ONE_LINE_EMOJIS]: "One Line + Emojis",
-    [CaptionStyle.TWO_LINES]: "Two Lines",
-    [CaptionStyle.TWO_LINES_EMOJIS]: "Two Lines + Emojis",
-    [CaptionStyle.HOME_HIGHLIGHT]: "Home Highlight",
-};
+exports.Styles = [
+    { value: CaptionStyle.ONE_LINE, label: "One Line" },
+    { value: CaptionStyle.ONE_LINE_EMOJIS, label: "One Line + Emojis" },
+    { value: CaptionStyle.TWO_LINES, label: "Two Lines" },
+    { value: CaptionStyle.TWO_LINES_EMOJIS, label: "Two Lines + Emojis" },
+    { value: CaptionStyle.HOME_HIGHLIGHT, label: "Home Tour" },
+];

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

@@ -5,7 +5,9 @@ interface SubscriptionAPISchema {
     getProduct: (id: string, context?: Context) => Promise<Product>;
     getProducts: (ctx?: Context) => Promise<Product[]>;
     charge: (ctx: Context) => Promise<boolean>;
-    disableAutomaticRenew: (ctx: Context) => Promise<boolean>;
+    pause: (ctx: Context) => Promise<boolean>;
+    resume: (ctx: Context) => Promise<boolean>;
+    updatePlan: (ctx: Context, planId: string) => Promise<boolean>;
     createCheckout: (planId: string | null, ctx: Context) => Promise<string>;
 }
 declare const SubscriptionEndpoints: {
@@ -41,7 +43,15 @@ declare const SubscriptionEndpoints: {
         uri: string;
         method: string;
     };
-    DisableAutomaticRenew: {
+    Pause: {
+        uri: string;
+        method: string;
+    };
+    Resume: {
+        uri: string;
+        method: string;
+    };
+    UpdatePlan: {
         uri: string;
         method: string;
     };
@@ -51,7 +61,8 @@ type Plan = {
     currency: string;
     price: string;
     interval: string;
-    metadata: any;
+    metadata: Record<string, string>;
+    subscriptionItemId: string;
 };
 type Description = {
     description: string;

package/dist/model/Subscription.schema.js

@@ -34,9 +34,17 @@ const SubscriptionEndpoints = {
         uri: "/subscriptions/payment/charge/",
         method: "POST",
     },
-    DisableAutomaticRenew: {
-        uri: "/subscriptions/payment/disableAutomaticRenew",
-        method: "POST",
+    Pause: {
+        uri: "/subscriptions/pause/",
+        method: "PUT",
+    },
+    Resume: {
+        uri: "/subscriptions/resume/",
+        method: "PUT",
+    },
+    UpdatePlan: {
+        uri: "/subscriptions/plan/update/",
+        method: "PUT",
     },
 };
 exports.SubscriptionEndpoints = SubscriptionEndpoints;

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

@@ -1,5 +1,5 @@
 import Context from "./Context";
-export type Update = Pick<User, "name" | "profession" | "preferences" | "photoUrl" | "fcmToken">;
+export type Update = Pick<User, "name" | "profession" | "preferences" | "photoUrl" | "fcmToken" | "timezone" | "experienceId">;
 interface UserAPISchema {
     getUserInfo: (context: Context) => Promise<User>;
     isEmailAvaliable: (email: string) => Promise<boolean>;
@@ -109,6 +109,7 @@ type User = {
     tenantId?: string;
     editorId?: string;
     timezone?: string;
+    experienceId?: string;
     customerId: string;
     role: Role;
 };

package/dist/namespace.d.ts

@@ -1,9 +1,10 @@
 import { Product as TProduct, Subscription as TSubscription, Charge as TCharge } from "./model/Subscription.schema";
-import { Trigger as TTrigger, Criteria as TCriteria, NotificationDetail as TNContent, History as THistory } from "./model/Notification.schema";
+import { Trigger as TTrigger, Criteria as TCriteria, NotificationDetail as TNContent, RecurrenceRule as TRRule, NotificationItem as TNotificaitonItem, History as THistory } from "./model/Notification.schema";
+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 } from "./model/Project.schema";
+import { Project as TProject, TimelineItem as TTimlineItem } 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";
@@ -11,6 +12,7 @@ export declare namespace Permissions {
     type Role = TRole;
 }
 export declare namespace Shred {
+    type Response<T> = APIResponse<T>;
     type Tenant = TTenant;
     type Product = TProduct;
     type Subscription = TSubscription;
@@ -19,6 +21,7 @@ export declare namespace Shred {
     type Email = TEmail;
     type System = TSystem;
     type Project = TProject;
+    type TimelineItem = TTimlineItem;
     type Asset = TAsset;
     type Track = TTrack;
     namespace PromptTypes {
@@ -28,21 +31,25 @@ export declare namespace Shred {
     }
 }
 export declare namespace Notification {
+    enum Frequency {
+        DAILY = "daily",
+        WEEKLY = "weekly",
+        MONTHLY = "monthly"
+    }
     enum WeekDay {
-        MONDAY = "monday",
-        TUESDAY = "tuesday",
-        WEDNESDAY = "wednesday",
-        THURSDAY = "thursday",
-        FRIDAY = "friday",
-        SATURDAY = "saturday",
-        SUNDAY = "sunday"
+        MONDAY = 1,
+        TUESDAY = 2,
+        WEDNESDAY = 3,
+        THURSDAY = 4,
+        FRIDAY = 5,
+        SATURDAY = 6,
+        SUNDAY = 7
     }
     enum CriteriaType {
-        NoLogin = "noLogin",
         AllUsers = "allUsers",
         NoProjects = "noProjects",
-        InactiveUsers = "inactiveUsers",
-        NoSubscription = "noSubscription"
+        NoSubscription = "noSubscription",
+        UsersFromTier = "usersFromTier"
     }
     enum TransportType {
         Push = "push",
@@ -58,9 +65,11 @@ export declare namespace Notification {
         ACTIVE = "active",
         EXPIRED = "expired"
     }
+    type RecurrenceRule = TRRule;
     type Trigger = TTrigger;
     type Criteria = TCriteria;
     type History = THistory;
+    type Item = TNotificaitonItem;
     type Detail = TNContent;
 }
 export declare namespace User {

package/dist/namespace.js

@@ -3,23 +3,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Notification = void 0;
 var Notification;
 (function (Notification) {
+    let Frequency;
+    (function (Frequency) {
+        Frequency["DAILY"] = "daily";
+        Frequency["WEEKLY"] = "weekly";
+        Frequency["MONTHLY"] = "monthly";
+    })(Frequency = Notification.Frequency || (Notification.Frequency = {}));
     let WeekDay;
     (function (WeekDay) {
-        WeekDay["MONDAY"] = "monday";
-        WeekDay["TUESDAY"] = "tuesday";
-        WeekDay["WEDNESDAY"] = "wednesday";
-        WeekDay["THURSDAY"] = "thursday";
-        WeekDay["FRIDAY"] = "friday";
-        WeekDay["SATURDAY"] = "saturday";
-        WeekDay["SUNDAY"] = "sunday";
+        WeekDay[WeekDay["MONDAY"] = 1] = "MONDAY";
+        WeekDay[WeekDay["TUESDAY"] = 2] = "TUESDAY";
+        WeekDay[WeekDay["WEDNESDAY"] = 3] = "WEDNESDAY";
+        WeekDay[WeekDay["THURSDAY"] = 4] = "THURSDAY";
+        WeekDay[WeekDay["FRIDAY"] = 5] = "FRIDAY";
+        WeekDay[WeekDay["SATURDAY"] = 6] = "SATURDAY";
+        WeekDay[WeekDay["SUNDAY"] = 7] = "SUNDAY";
     })(WeekDay = Notification.WeekDay || (Notification.WeekDay = {}));
     let CriteriaType;
     (function (CriteriaType) {
-        CriteriaType["NoLogin"] = "noLogin";
         CriteriaType["AllUsers"] = "allUsers";
         CriteriaType["NoProjects"] = "noProjects";
-        CriteriaType["InactiveUsers"] = "inactiveUsers";
         CriteriaType["NoSubscription"] = "noSubscription";
+        CriteriaType["UsersFromTier"] = "usersFromTier";
     })(CriteriaType = Notification.CriteriaType || (Notification.CriteriaType = {}));
     let TransportType;
     (function (TransportType) {

package/package.json

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