shred-api-client 1.11.5 → 1.11.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -26,17 +26,24 @@ type History = {
26
26
  errorList?: string[];
27
27
  executionTimeDuration?: number;
28
28
  };
29
+ type RecurrenceRule = {
30
+ frequency: Notification.Frequency;
31
+ interval: number;
32
+ weekDays?: Notification.WeekDay[];
33
+ dayOfMonth?: number;
34
+ timeOfDay: string;
35
+ endDate?: number;
36
+ ocurrences?: number;
37
+ };
29
38
  type Trigger = {
30
39
  id: string;
31
40
  title: string;
32
41
  description: string;
33
42
  transportType: Notification.TransportType[];
34
43
  notification: NotificationDetail;
35
- executionTime: string;
36
- repeatDays: Notification.WeekDay[];
37
44
  history?: History[];
38
45
  status: Notification.Status;
39
- isRecurring: boolean;
46
+ recurrence?: RecurrenceRule;
40
47
  executionDate?: number;
41
48
  criteria: Criteria;
42
49
  nextExecution?: number;
@@ -47,6 +54,6 @@ type NotificationDetail = {
47
54
  title: string;
48
55
  body: string;
49
56
  userToken?: string;
50
- metadata?: any;
57
+ metadata?: Record<string, any>;
51
58
  };
52
- export { NotificationSchema, NotificationEndpoints, NotificationDetail, Trigger, Criteria, History, };
59
+ export { NotificationSchema, NotificationEndpoints, NotificationDetail, RecurrenceRule, Trigger, Criteria, History, };
@@ -91,34 +91,41 @@ type DenyFeedback = {
91
91
  resolved: boolean;
92
92
  categories?: string[];
93
93
  };
94
+ type TimelineItem = {
95
+ status: Status;
96
+ title: string;
97
+ description: string;
98
+ timestamp: number;
99
+ metadata: Record<string, any>;
100
+ };
94
101
  type Project = {
95
102
  id: string;
96
103
  title: string;
97
104
  instructions: string;
98
105
  submitMonth: string;
99
- status: Status;
100
106
  captionStyle: CaptionStyle;
101
107
  finalVideoId?: string;
102
- canRevision: boolean;
103
108
  thumbnailUrl?: string;
104
- revision?: string;
105
109
  modified: number;
106
110
  captionSuggestion?: string;
107
111
  editorId: string;
108
112
  userId: string;
109
113
  assets?: Asset[];
110
- denyFeedback?: DenyFeedback[];
111
- approvedBy?: string;
112
- approveTimestamp?: number;
113
114
  expirationTimestamp: number;
115
+ timeline?: TimelineItem[];
116
+ approveTimestamp?: number;
114
117
  sentToApproveTimestamp?: number;
115
118
  submitTimestamp: number;
116
119
  editTimestamp?: number;
117
120
  completeTimestamp?: number;
118
121
  revisedAt?: number;
119
- isFreeProject?: boolean;
120
122
  scheduledAt?: number;
121
123
  scheduledTime?: number;
124
+ revision?: string;
125
+ canRevision: boolean;
126
+ denyFeedback?: DenyFeedback[];
127
+ approvedBy?: string;
128
+ status: Status;
122
129
  tenantId?: string;
123
130
  };
124
- export { Project, ProjectAPISchema, ProjectEndpoints };
131
+ export { Project, ProjectAPISchema, ProjectEndpoints, TimelineItem };
@@ -1,9 +1,9 @@
1
1
  import { Product as TProduct, Subscription as TSubscription, Charge as TCharge } from "./model/Subscription.schema";
2
- import { Trigger as TTrigger, Criteria as TCriteria, NotificationDetail as TNContent, History as THistory } from "./model/Notification.schema";
2
+ import { Trigger as TTrigger, Criteria as TCriteria, NotificationDetail as TNContent, RecurrenceRule as TRRule, History as THistory } from "./model/Notification.schema";
3
3
  import { System as TSystem, User as TUser, Preferences as UserPreferences, Role as TRole } from "./model/User.schema";
4
4
  import { Email as TEmail } from "./model/Email.schema";
5
5
  import { Asset as TAsset } from "./model/Asset.schema";
6
- import { Project as TProject } from "./model/Project.schema";
6
+ import { Project as TProject, TimelineItem as TTimlineItem } from "./model/Project.schema";
7
7
  import { Tenant as TTenant } from "./model/Tenant.schema";
8
8
  import { Track as TTrack } from "./model/Track.schema";
9
9
  import { Prompt as TPrompt, Script as TScript, Category as TCategory } from "./model/Prompt.schema";
@@ -19,6 +19,7 @@ export declare namespace Shred {
19
19
  type Email = TEmail;
20
20
  type System = TSystem;
21
21
  type Project = TProject;
22
+ type TimelineItem = TTimlineItem;
22
23
  type Asset = TAsset;
23
24
  type Track = TTrack;
24
25
  namespace PromptTypes {
@@ -28,14 +29,19 @@ export declare namespace Shred {
28
29
  }
29
30
  }
30
31
  export declare namespace Notification {
32
+ enum Frequency {
33
+ DAILY = "daily",
34
+ WEEKLY = "weekly",
35
+ MONTHLY = "monthly"
36
+ }
31
37
  enum WeekDay {
32
- MONDAY = "monday",
33
- TUESDAY = "tuesday",
34
- WEDNESDAY = "wednesday",
35
- THURSDAY = "thursday",
36
- FRIDAY = "friday",
37
- SATURDAY = "saturday",
38
- SUNDAY = "sunday"
38
+ MONDAY = 1,
39
+ TUESDAY = 2,
40
+ WEDNESDAY = 3,
41
+ THURSDAY = 4,
42
+ FRIDAY = 5,
43
+ SATURDAY = 6,
44
+ SUNDAY = 7
39
45
  }
40
46
  enum CriteriaType {
41
47
  NoLogin = "noLogin",
@@ -58,6 +64,7 @@ export declare namespace Notification {
58
64
  ACTIVE = "active",
59
65
  EXPIRED = "expired"
60
66
  }
67
+ type RecurrenceRule = TRRule;
61
68
  type Trigger = TTrigger;
62
69
  type Criteria = TCriteria;
63
70
  type History = THistory;
package/dist/namespace.js CHANGED
@@ -3,15 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.Notification = void 0;
4
4
  var Notification;
5
5
  (function (Notification) {
6
+ let Frequency;
7
+ (function (Frequency) {
8
+ Frequency["DAILY"] = "daily";
9
+ Frequency["WEEKLY"] = "weekly";
10
+ Frequency["MONTHLY"] = "monthly";
11
+ })(Frequency = Notification.Frequency || (Notification.Frequency = {}));
6
12
  let WeekDay;
7
13
  (function (WeekDay) {
8
- WeekDay["MONDAY"] = "monday";
9
- WeekDay["TUESDAY"] = "tuesday";
10
- WeekDay["WEDNESDAY"] = "wednesday";
11
- WeekDay["THURSDAY"] = "thursday";
12
- WeekDay["FRIDAY"] = "friday";
13
- WeekDay["SATURDAY"] = "saturday";
14
- WeekDay["SUNDAY"] = "sunday";
14
+ WeekDay[WeekDay["MONDAY"] = 1] = "MONDAY";
15
+ WeekDay[WeekDay["TUESDAY"] = 2] = "TUESDAY";
16
+ WeekDay[WeekDay["WEDNESDAY"] = 3] = "WEDNESDAY";
17
+ WeekDay[WeekDay["THURSDAY"] = 4] = "THURSDAY";
18
+ WeekDay[WeekDay["FRIDAY"] = 5] = "FRIDAY";
19
+ WeekDay[WeekDay["SATURDAY"] = 6] = "SATURDAY";
20
+ WeekDay[WeekDay["SUNDAY"] = 7] = "SUNDAY";
15
21
  })(WeekDay = Notification.WeekDay || (Notification.WeekDay = {}));
16
22
  let CriteriaType;
17
23
  (function (CriteriaType) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "shred-api-client",
3
- "version": "1.11.5",
3
+ "version": "1.11.7",
4
4
  "description": "API Client for Shred",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",