shred-api-client 1.11.6 → 1.11.8

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.
package/dist/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { ShredAPI } from "./model/Api";
2
2
  import { Role, System } from "./model/User.schema";
3
- import { Status as ProjectStatus } from "./model/Project.schema";
3
+ import { Status as ProjectStatus, Styles, CaptionStyle } from "./model/Project.schema";
4
4
  import Exceptions from "./model/exceptions/";
5
- export { Role, System, Exceptions, ProjectStatus };
5
+ export { Role, System, Exceptions, ProjectStatus, Styles, CaptionStyle };
6
6
  export default ShredAPI;
7
7
  export * from "./namespace";
package/dist/index.js CHANGED
@@ -17,13 +17,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
17
17
  return (mod && mod.__esModule) ? mod : { "default": mod };
18
18
  };
19
19
  Object.defineProperty(exports, "__esModule", { value: true });
20
- exports.ProjectStatus = exports.Exceptions = exports.System = exports.Role = void 0;
20
+ exports.CaptionStyle = exports.Styles = exports.ProjectStatus = exports.Exceptions = exports.System = exports.Role = void 0;
21
21
  const Api_1 = require("./model/Api");
22
22
  const User_schema_1 = require("./model/User.schema");
23
23
  Object.defineProperty(exports, "Role", { enumerable: true, get: function () { return User_schema_1.Role; } });
24
24
  Object.defineProperty(exports, "System", { enumerable: true, get: function () { return User_schema_1.System; } });
25
25
  const Project_schema_1 = require("./model/Project.schema");
26
26
  Object.defineProperty(exports, "ProjectStatus", { enumerable: true, get: function () { return Project_schema_1.Status; } });
27
+ Object.defineProperty(exports, "Styles", { enumerable: true, get: function () { return Project_schema_1.Styles; } });
28
+ Object.defineProperty(exports, "CaptionStyle", { enumerable: true, get: function () { return Project_schema_1.CaptionStyle; } });
27
29
  const exceptions_1 = __importDefault(require("./model/exceptions/"));
28
30
  exports.Exceptions = exceptions_1.default;
29
31
  exports.default = Api_1.ShredAPI;
@@ -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, };
@@ -79,12 +79,14 @@ export declare enum Status {
79
79
  CANCELLED = 6,
80
80
  SCHEDULED = 7
81
81
  }
82
- declare enum CaptionStyle {
82
+ export declare enum CaptionStyle {
83
83
  ONE_LINE = 1,
84
84
  ONE_LINE_EMOJIS = 2,
85
+ TWO_LINES = 5,
85
86
  TWO_LINES_EMOJIS = 3,
86
87
  HOME_HIGHLIGHT = 4
87
88
  }
89
+ export declare const Styles: Record<CaptionStyle, string>;
88
90
  type DenyFeedback = {
89
91
  timestamp: number;
90
92
  feedback: string;
@@ -105,19 +107,14 @@ type Project = {
105
107
  submitMonth: string;
106
108
  captionStyle: CaptionStyle;
107
109
  finalVideoId?: string;
108
- canRevision: boolean;
109
110
  thumbnailUrl?: string;
110
- revision?: string;
111
111
  modified: number;
112
112
  captionSuggestion?: string;
113
113
  editorId: string;
114
114
  userId: string;
115
115
  assets?: Asset[];
116
- denyFeedback?: DenyFeedback[];
117
- approvedBy?: string;
118
116
  expirationTimestamp: number;
119
117
  timeline?: TimelineItem[];
120
- status: Status;
121
118
  approveTimestamp?: number;
122
119
  sentToApproveTimestamp?: number;
123
120
  submitTimestamp: number;
@@ -126,6 +123,11 @@ type Project = {
126
123
  revisedAt?: number;
127
124
  scheduledAt?: number;
128
125
  scheduledTime?: number;
126
+ revision?: string;
127
+ canRevision: boolean;
128
+ denyFeedback?: DenyFeedback[];
129
+ approvedBy?: string;
130
+ status: Status;
129
131
  tenantId?: string;
130
132
  };
131
133
  export { Project, ProjectAPISchema, ProjectEndpoints, TimelineItem };
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ProjectEndpoints = exports.Status = void 0;
3
+ exports.ProjectEndpoints = exports.Styles = exports.CaptionStyle = exports.Status = void 0;
4
4
  const ProjectEndpoints = {
5
5
  List: {
6
6
  uri: "/projects/list",
@@ -59,6 +59,14 @@ var CaptionStyle;
59
59
  (function (CaptionStyle) {
60
60
  CaptionStyle[CaptionStyle["ONE_LINE"] = 1] = "ONE_LINE";
61
61
  CaptionStyle[CaptionStyle["ONE_LINE_EMOJIS"] = 2] = "ONE_LINE_EMOJIS";
62
+ CaptionStyle[CaptionStyle["TWO_LINES"] = 5] = "TWO_LINES";
62
63
  CaptionStyle[CaptionStyle["TWO_LINES_EMOJIS"] = 3] = "TWO_LINES_EMOJIS";
63
64
  CaptionStyle[CaptionStyle["HOME_HIGHLIGHT"] = 4] = "HOME_HIGHLIGHT";
64
- })(CaptionStyle || (CaptionStyle = {}));
65
+ })(CaptionStyle || (exports.CaptionStyle = CaptionStyle = {}));
66
+ exports.Styles = {
67
+ [CaptionStyle.ONE_LINE]: "One Line",
68
+ [CaptionStyle.ONE_LINE_EMOJIS]: "One Line + Emojis",
69
+ [CaptionStyle.TWO_LINES]: "Two Lines",
70
+ [CaptionStyle.TWO_LINES_EMOJIS]: "Two Lines + Emojis",
71
+ [CaptionStyle.HOME_HIGHLIGHT]: "Home Highlight",
72
+ };
@@ -1,5 +1,5 @@
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";
@@ -29,14 +29,19 @@ export declare namespace Shred {
29
29
  }
30
30
  }
31
31
  export declare namespace Notification {
32
+ enum Frequency {
33
+ DAILY = "daily",
34
+ WEEKLY = "weekly",
35
+ MONTHLY = "monthly"
36
+ }
32
37
  enum WeekDay {
33
- MONDAY = "monday",
34
- TUESDAY = "tuesday",
35
- WEDNESDAY = "wednesday",
36
- THURSDAY = "thursday",
37
- FRIDAY = "friday",
38
- SATURDAY = "saturday",
39
- SUNDAY = "sunday"
38
+ MONDAY = 1,
39
+ TUESDAY = 2,
40
+ WEDNESDAY = 3,
41
+ THURSDAY = 4,
42
+ FRIDAY = 5,
43
+ SATURDAY = 6,
44
+ SUNDAY = 7
40
45
  }
41
46
  enum CriteriaType {
42
47
  NoLogin = "noLogin",
@@ -59,6 +64,7 @@ export declare namespace Notification {
59
64
  ACTIVE = "active",
60
65
  EXPIRED = "expired"
61
66
  }
67
+ type RecurrenceRule = TRRule;
62
68
  type Trigger = TTrigger;
63
69
  type Criteria = TCriteria;
64
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.6",
3
+ "version": "1.11.8",
4
4
  "description": "API Client for Shred",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",