shred-api-client 1.14.3 → 1.14.4-rc.2

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

@@ -0,0 +1,117 @@
+import { z } from "zod";
+export declare enum Role {
+    USER = "User",
+    EDITOR = "Editor",
+    QA = "QA",
+    ADMIN = "ADMIN",
+    SYSTEM = "SYSTEM"
+}
+export declare enum System {
+    APP = "APP",
+    EDITOR = "EDITOR",
+    QA = "QA",
+    ADMIN = "ADMIN"
+}
+export declare const PreferencesSchema: z.ZodObject<{
+    primaryColor: z.ZodOptional<z.ZodString>;
+    secondaryColor: z.ZodOptional<z.ZodString>;
+    facebookLink: z.ZodOptional<z.ZodString>;
+    instagramLink: z.ZodOptional<z.ZodString>;
+    bRoll: z.ZodOptional<z.ZodBoolean>;
+    logo: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    primaryColor?: string | undefined;
+    secondaryColor?: string | undefined;
+    facebookLink?: string | undefined;
+    instagramLink?: string | undefined;
+    bRoll?: boolean | undefined;
+    logo?: string | undefined;
+}, {
+    primaryColor?: string | undefined;
+    secondaryColor?: string | undefined;
+    facebookLink?: string | undefined;
+    instagramLink?: string | undefined;
+    bRoll?: boolean | undefined;
+    logo?: string | undefined;
+}>;
+export declare const UserSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    email: z.ZodString;
+    fcmToken: z.ZodOptional<z.ZodString>;
+    profession: z.ZodOptional<z.ZodString>;
+    photoUrl: z.ZodOptional<z.ZodString>;
+    preferences: z.ZodOptional<z.ZodObject<{
+        primaryColor: z.ZodOptional<z.ZodString>;
+        secondaryColor: z.ZodOptional<z.ZodString>;
+        facebookLink: z.ZodOptional<z.ZodString>;
+        instagramLink: z.ZodOptional<z.ZodString>;
+        bRoll: z.ZodOptional<z.ZodBoolean>;
+        logo: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        primaryColor?: string | undefined;
+        secondaryColor?: string | undefined;
+        facebookLink?: string | undefined;
+        instagramLink?: string | undefined;
+        bRoll?: boolean | undefined;
+        logo?: string | undefined;
+    }, {
+        primaryColor?: string | undefined;
+        secondaryColor?: string | undefined;
+        facebookLink?: string | undefined;
+        instagramLink?: string | undefined;
+        bRoll?: boolean | undefined;
+        logo?: string | undefined;
+    }>>;
+    tenantId: z.ZodOptional<z.ZodString>;
+    editorId: z.ZodOptional<z.ZodString>;
+    timezone: z.ZodOptional<z.ZodString>;
+    experienceId: z.ZodOptional<z.ZodString>;
+    customerId: z.ZodString;
+    role: z.ZodNativeEnum<typeof Role>;
+}, "strip", z.ZodTypeAny, {
+    email: string;
+    id: string;
+    name: string;
+    customerId: string;
+    role: Role;
+    timezone?: string | undefined;
+    tenantId?: string | undefined;
+    preferences?: {
+        primaryColor?: string | undefined;
+        secondaryColor?: string | undefined;
+        facebookLink?: string | undefined;
+        instagramLink?: string | undefined;
+        bRoll?: boolean | undefined;
+        logo?: string | undefined;
+    } | undefined;
+    fcmToken?: string | undefined;
+    profession?: string | undefined;
+    photoUrl?: string | undefined;
+    editorId?: string | undefined;
+    experienceId?: string | undefined;
+}, {
+    email: string;
+    id: string;
+    name: string;
+    customerId: string;
+    role: Role;
+    timezone?: string | undefined;
+    tenantId?: string | undefined;
+    preferences?: {
+        primaryColor?: string | undefined;
+        secondaryColor?: string | undefined;
+        facebookLink?: string | undefined;
+        instagramLink?: string | undefined;
+        bRoll?: boolean | undefined;
+        logo?: string | undefined;
+    } | undefined;
+    fcmToken?: string | undefined;
+    profession?: string | undefined;
+    photoUrl?: string | undefined;
+    editorId?: string | undefined;
+    experienceId?: string | undefined;
+}>;
+export type User = z.infer<typeof UserSchema>;
+export type Preferences = z.infer<typeof PreferencesSchema>;
+export type Update = Pick<User, "name" | "profession" | "preferences" | "photoUrl" | "fcmToken" | "timezone" | "experienceId">;

package/dist/model/user/User.schema.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserSchema = exports.PreferencesSchema = exports.System = exports.Role = void 0;
+const zod_1 = require("zod");
+var Role;
+(function (Role) {
+    Role["USER"] = "User";
+    Role["EDITOR"] = "Editor";
+    Role["QA"] = "QA";
+    Role["ADMIN"] = "ADMIN";
+    Role["SYSTEM"] = "SYSTEM";
+})(Role || (exports.Role = Role = {}));
+var System;
+(function (System) {
+    System["APP"] = "APP";
+    System["EDITOR"] = "EDITOR";
+    System["QA"] = "QA";
+    System["ADMIN"] = "ADMIN";
+})(System || (exports.System = System = {}));
+exports.PreferencesSchema = zod_1.z.object({
+    primaryColor: zod_1.z.string().optional(),
+    secondaryColor: zod_1.z.string().optional(),
+    facebookLink: zod_1.z.string().optional(),
+    instagramLink: zod_1.z.string().optional(),
+    bRoll: zod_1.z.boolean().optional(),
+    logo: zod_1.z.string().optional(),
+});
+exports.UserSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    name: zod_1.z.string(),
+    email: zod_1.z.string().email(),
+    fcmToken: zod_1.z.string().optional(),
+    profession: zod_1.z.string().optional(),
+    photoUrl: zod_1.z.string().optional(),
+    preferences: exports.PreferencesSchema.optional(),
+    tenantId: zod_1.z.string().optional(),
+    editorId: zod_1.z.string().optional(),
+    timezone: zod_1.z.string().optional(),
+    experienceId: zod_1.z.string().optional(),
+    customerId: zod_1.z.string(),
+    role: zod_1.z.nativeEnum(Role),
+});

package/dist/model/user/index.d.ts

@@ -0,0 +1,3 @@
+export type { User as Entity, Preferences, Update } from "./User.schema";
+export { UserSchema, PreferencesSchema, Role, System } from "./User.schema";
+export * from "./User.api";

package/dist/model/user/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.System = exports.Role = exports.PreferencesSchema = exports.UserSchema = void 0;
+var User_schema_1 = require("./User.schema");
+Object.defineProperty(exports, "UserSchema", { enumerable: true, get: function () { return User_schema_1.UserSchema; } });
+Object.defineProperty(exports, "PreferencesSchema", { enumerable: true, get: function () { return User_schema_1.PreferencesSchema; } });
+Object.defineProperty(exports, "Role", { enumerable: true, get: function () { return User_schema_1.Role; } });
+Object.defineProperty(exports, "System", { enumerable: true, get: function () { return User_schema_1.System; } });
+__exportStar(require("./User.api"), exports);

package/dist/util/parseQuery.d.ts

@@ -1,2 +1,2 @@
-import { QueryOptions } from "../model/Api";
-export declare const buildQueryString: <T>(query: Partial<QueryOptions<T>>) => string;
+import * as Core from "../model/core";
+export declare const buildQueryString: <T>(query: Partial<Core.QueryOptions<T>>) => string;

package/package.json

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

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

@@ -1,10 +0,0 @@
-interface APPConfigSchema {
-    version: () => Promise<string>;
-}
-declare const AppConfigEndpoints: {
-    Version: {
-        uri: string;
-        method: string;
-    };
-};
-export { AppConfigEndpoints, APPConfigSchema };

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

@@ -1,17 +0,0 @@
-import Context from "./Context";
-interface EmailAPISchema {
-    send: (email: Email, ctx?: Context) => Promise<boolean>;
-}
-declare const EmailEndpoints: {
-    SendEmail: {
-        uri: string;
-        method: string;
-    };
-};
-type Email = {
-    to?: string;
-    subject: string;
-    body: string;
-};
-export default Email;
-export { Email, EmailEndpoints, EmailAPISchema };

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

@@ -1,112 +0,0 @@
-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>;
-    getNotifications: (ctx: Context) => Promise<APIResponse<NotificationItem>>;
-    markAsRead: (ctx: Context, id: string) => Promise<boolean>;
-    clearNotifications: (ctx: Context) => 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;
-    };
-    ListNotifications: {
-        uri: string;
-        method: string;
-    };
-    MarkAsRead: {
-        uri: string;
-        method: string;
-    };
-    ClearNotifications: {
-        uri: string;
-        method: string;
-    };
-};
-type Criteria = {
-    type: Notification.CriteriaType;
-    params: Record<string, any>;
-};
-type History = {
-    batchId: string;
-    executedAt: number;
-    timezone: string;
-    status: "success" | "failed" | "info" | "warn";
-    users: {
-        total: number;
-        success: number;
-        error: number;
-    };
-    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;
-    history?: History[];
-    status: Notification.Status;
-    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" | "deleted";
-    deliveredAt: number;
-    openedAt?: number;
-    deletedAt?: number;
-    cta?: {
-        label: string;
-        url: string;
-    };
-    metadata: Record<string, string | number>;
-    error?: string;
-};
-type NotificationDetail = Pick<NotificationItem, "title" | "body" | "userId" | "metadata">;
-export { NotificationItem, NotificationSchema, NotificationEndpoints, NotificationDetail, RecurrenceRule, Trigger, Criteria, History, };

package/dist/model/Notification.schema.js

@@ -1,38 +0,0 @@
-"use strict";
-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",
-    },
-    ListNotifications: {
-        uri: "/notifications/list/",
-        method: "GET",
-    },
-    MarkAsRead: {
-        uri: "/notifications/:id/read/",
-        method: "PUT",
-    },
-    ClearNotifications: {
-        uri: "/notifications/clear/",
-        method: "DELETE",
-    },
-};
-exports.NotificationEndpoints = NotificationEndpoints;

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

@@ -1,152 +0,0 @@
-import { Asset } from "./Asset.schema";
-import Context from "./Context";
-export type ProjectCreation = Pick<Project, "title" | "instructions" | "captionStyle" | "assets">;
-export type SendToApproval = {
-    video: string;
-    thumbnail: string;
-    captionSuggestion: string;
-};
-export type Approve = {
-    scheduleTime?: number;
-    captionSuggestion: string;
-};
-export type Query = {
-    startDate: string;
-    endDate: string;
-    timeZone?: string;
-};
-interface ProjectAPISchema {
-    find: (context: Context, projectId: string) => Promise<Project>;
-    create: (context: Context, data: ProjectCreation) => Promise<Project>;
-    review: (context: Context, projectId: string, revision: string) => Promise<boolean>;
-    cancel: (context: Context, projectId: string) => Promise<boolean>;
-    list: (context: Context, query: Query) => Promise<Project[]>;
-    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, 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: {
-        uri: string;
-        method: string;
-    };
-    CreateProject: {
-        uri: string;
-        method: string;
-    };
-    FindOne: {
-        uri: string;
-        method: string;
-    };
-    GetGoals: {
-        uri: string;
-        method: string;
-    };
-    Review: {
-        uri: string;
-        method: string;
-    };
-    Cancel: {
-        uri: string;
-        method: string;
-    };
-    StartEdition: {
-        uri: string;
-        method: string;
-    };
-    SendToApproval: {
-        uri: string;
-        method: string;
-    };
-    Approve: {
-        uri: string;
-        method: string;
-    };
-    Unschedule: {
-        uri: string;
-        method: string;
-    };
-    Rollback: {
-        uri: string;
-        method: string;
-    };
-    Deny: {
-        uri: string;
-        method: string;
-    };
-};
-export declare enum Status {
-    SUBMITTED = 0,
-    EDITING = 1,
-    COMPLETED = 2,
-    WAITING_APPROVE = 3,
-    DENIED = 4,
-    REVISIONING = 5,
-    CANCELLED = 6,
-    SCHEDULED = 7
-}
-export declare enum CaptionStyle {
-    ONE_LINE = 1,
-    ONE_LINE_EMOJIS = 2,
-    TWO_LINES = 5,
-    TWO_LINES_EMOJIS = 3,
-    HOME_HIGHLIGHT = 4
-}
-interface Style {
-    value: CaptionStyle;
-    label: string;
-}
-export declare const Styles: Style[];
-type TimelineItem = {
-    status: Status;
-    title: string;
-    description: string;
-    timestamp: number;
-    metadata: Record<string, any>;
-};
-type Project = {
-    id: string;
-    title: string;
-    instructions: string;
-    submitMonth: string;
-    captionStyle: CaptionStyle;
-    finalVideoId?: string;
-    thumbnailUrl?: string;
-    modified: number;
-    captionSuggestion?: string;
-    editorId: string;
-    userId: string;
-    assets?: Asset[];
-    expirationTimestamp: number;
-    timeline: TimelineItem[];
-    submitTimestamp: number;
-    tenantId?: string;
-    status: Status;
-};
-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/Track.schema.d.ts

@@ -1,20 +0,0 @@
-interface TrackAPISchema {
-    send: (t: Track) => Promise<boolean>;
-}
-declare const TrackEndpoints: {
-    Track: {
-        uri: string;
-        method: string;
-    };
-};
-type TrackParam = {
-    name: string;
-    value: string | number;
-};
-type Track = {
-    category: string;
-    label: string;
-    action: string;
-    params?: TrackParam[];
-};
-export { Track, TrackEndpoints, TrackAPISchema };