@compassdigital/sdk.typescript 4.92.0 → 4.93.0

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.
@@ -7,16 +7,31 @@ export interface Error {
7
7
  export interface Success {
8
8
  success?: boolean;
9
9
  }
10
- export interface AnnouncementRequest {
10
+ export interface AnnouncementPostRequestBody {
11
11
  name: string;
12
12
  type: string;
13
- key: string;
14
- app: string;
13
+ app: 'Boost' | 'Thrive' | 'Nourish' | 'JJKitchen' | 'Rogers';
15
14
  is_global?: boolean;
16
15
  allowed_resources?: string[];
17
16
  position: number;
18
- active: boolean;
19
- info: {
17
+ active?: boolean;
18
+ status?: 'draft' | 'active' | 'disabled';
19
+ info?: {
20
+ en?: AnnouncementInfo;
21
+ fr?: AnnouncementInfo;
22
+ };
23
+ schedule?: Schedule;
24
+ [index: string]: any;
25
+ }
26
+ export interface AnnouncementPutRequestBody {
27
+ name: string;
28
+ type: string;
29
+ is_global?: boolean;
30
+ allowed_resources?: string[];
31
+ position: number;
32
+ active?: boolean;
33
+ status?: 'draft' | 'active' | 'disabled';
34
+ info?: {
20
35
  en?: AnnouncementInfo;
21
36
  fr?: AnnouncementInfo;
22
37
  };
@@ -26,12 +41,11 @@ export interface AnnouncementRequest {
26
41
  export interface AnnouncementPatchRequestBody {
27
42
  name?: string;
28
43
  type?: string;
29
- key?: string;
30
- app?: string;
31
44
  is_global?: boolean;
32
45
  allowed_resources?: string[];
33
46
  position?: number;
34
47
  active?: boolean;
48
+ status?: 'draft' | 'active' | 'disabled';
35
49
  info?: {
36
50
  en?: AnnouncementInfo;
37
51
  fr?: AnnouncementInfo;
@@ -43,10 +57,11 @@ export interface Announcement {
43
57
  name: string;
44
58
  type: string;
45
59
  key: string;
46
- app: string;
60
+ app: 'Boost' | 'Thrive' | 'Nourish' | 'JJKitchen' | 'Rogers';
47
61
  is_global: boolean;
48
62
  allowed_resources: string[];
49
63
  active: boolean;
64
+ status?: 'draft' | 'active' | 'disabled';
50
65
  schedule: Schedule;
51
66
  created_at: string;
52
67
  last_modified: string;
@@ -91,7 +106,7 @@ export interface Schedule {
91
106
  end_datetime: string;
92
107
  }[];
93
108
  }
94
- export type PostAnnouncementBody = AnnouncementRequest;
109
+ export type PostAnnouncementBody = AnnouncementPostRequestBody;
95
110
  export type PostAnnouncementResponse = Announcement;
96
111
  export interface PostAnnouncementRequest extends BaseRequest {
97
112
  body: PostAnnouncementBody;
@@ -130,7 +145,7 @@ export interface GetAnnouncementRequest extends BaseRequest, RequestQuery<GetAnn
130
145
  export interface PutAnnouncementPath {
131
146
  id: string;
132
147
  }
133
- export type PutAnnouncementBody = AnnouncementRequest;
148
+ export type PutAnnouncementBody = AnnouncementPutRequestBody;
134
149
  export type PutAnnouncementResponse = Announcement;
135
150
  export interface PutAnnouncementRequest extends BaseRequest, PutAnnouncementPath {
136
151
  body: PutAnnouncementBody;
@@ -1 +1 @@
1
- {"version":3,"file":"announcement.d.ts","sourceRoot":"","sources":["../../src/interface/announcement.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAEnD,MAAM,WAAW,KAAK;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,OAAO;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAEnC,IAAI,EAAE,MAAM,CAAC;IAEb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IAEZ,GAAG,EAAE,MAAM,CAAC;IAEZ,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAEhB,IAAI,EAAE;QACL,EAAE,CAAC,EAAE,gBAAgB,CAAC;QACtB,EAAE,CAAC,EAAE,gBAAgB,CAAC;KACtB,CAAC;IACF,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CACrB;AAED,MAAM,WAAW,4BAA4B;IAE5C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,IAAI,CAAC,EAAE;QACN,EAAE,CAAC,EAAE,gBAAgB,CAAC;QACtB,EAAE,CAAC,EAAE,gBAAgB,CAAC;KACtB,CAAC;IACF,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IAE5B,EAAE,EAAE,MAAM,CAAC;IAEX,IAAI,EAAE,MAAM,CAAC;IAEb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IAEZ,GAAG,EAAE,MAAM,CAAC;IAEZ,SAAS,EAAE,OAAO,CAAC;IACnB,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,QAAQ,CAAC;IAEnB,UAAU,EAAE,MAAM,CAAC;IAEnB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,IAAI,CAAC,EAAE;QACN,EAAE,CAAC,EAAE,gBAAgB,CAAC;QACtB,EAAE,CAAC,EAAE,gBAAgB,CAAC;KACtB,CAAC;IAEF,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC7B,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,gBAAgB;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,IAAI;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE;QACL,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;KACd,CAAC;CACF;AAED,MAAM,WAAW,WAAW;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,WAAW,QAAQ;IAExB,QAAQ,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE;QAEP,EAAE,EAAE,MAAM,CAAC;QACX,cAAc,EAAE,MAAM,CAAC;QACvB,YAAY,EAAE,MAAM,CAAC;KACrB,EAAE,CAAC;CACJ;AAID,MAAM,MAAM,oBAAoB,GAAG,mBAAmB,CAAC;AAEvD,MAAM,MAAM,wBAAwB,GAAG,YAAY,CAAC;AAEpD,MAAM,WAAW,uBAAwB,SAAQ,WAAW;IAC3D,IAAI,EAAE,oBAAoB,CAAC;CAC3B;AAID,MAAM,WAAW,qBAAqB;IAErC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,wBAAwB,GAAG,aAAa,CAAC;AAErD,MAAM,WAAW,uBAAwB,SAAQ,WAAW,EAAE,YAAY,CAAC,qBAAqB,CAAC;CAAG;AAIpG,MAAM,WAAW,mBAAmB;IAEnC,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,oBAAoB;IAEpC,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,uBAAuB,GAAG,YAAY,CAAC;AAEnD,MAAM,WAAW,sBAChB,SAAQ,WAAW,EAClB,YAAY,CAAC,oBAAoB,CAAC,EAClC,mBAAmB;CAAG;AAIxB,MAAM,WAAW,mBAAmB;IAEnC,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,CAAC;AAEtD,MAAM,MAAM,uBAAuB,GAAG,YAAY,CAAC;AAEnD,MAAM,WAAW,sBAAuB,SAAQ,WAAW,EAAE,mBAAmB;IAC/E,IAAI,EAAE,mBAAmB,CAAC;CAC1B;AAID,MAAM,WAAW,qBAAqB;IAErC,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,qBAAqB,GAAG,4BAA4B,CAAC;AAEjE,MAAM,MAAM,yBAAyB,GAAG,YAAY,CAAC;AAErD,MAAM,WAAW,wBAAyB,SAAQ,WAAW,EAAE,qBAAqB;IACnF,IAAI,EAAE,qBAAqB,CAAC;CAC5B;AAID,MAAM,WAAW,sBAAsB;IAEtC,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAAC;AAEjD,MAAM,WAAW,yBAA0B,SAAQ,WAAW,EAAE,sBAAsB;CAAG"}
1
+ {"version":3,"file":"announcement.d.ts","sourceRoot":"","sources":["../../src/interface/announcement.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAEnD,MAAM,WAAW,KAAK;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,OAAO;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,2BAA2B;IAE3C,IAAI,EAAE,MAAM,CAAC;IAEb,IAAI,EAAE,MAAM,CAAC;IAEb,GAAG,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAE7D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;IAEjB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEzC,IAAI,CAAC,EAAE;QACN,EAAE,CAAC,EAAE,gBAAgB,CAAC;QACtB,EAAE,CAAC,EAAE,gBAAgB,CAAC;KACtB,CAAC;IACF,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CACrB;AAED,MAAM,WAAW,0BAA0B;IAE1C,IAAI,EAAE,MAAM,CAAC;IAEb,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;IAEjB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEzC,IAAI,CAAC,EAAE;QACN,EAAE,CAAC,EAAE,gBAAgB,CAAC;QACtB,EAAE,CAAC,EAAE,gBAAgB,CAAC;KACtB,CAAC;IACF,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CACrB;AAED,MAAM,WAAW,4BAA4B;IAE5C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;IAEzC,IAAI,CAAC,EAAE;QACN,EAAE,CAAC,EAAE,gBAAgB,CAAC;QACtB,EAAE,CAAC,EAAE,gBAAgB,CAAC;KACtB,CAAC;IACF,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IAE5B,EAAE,EAAE,MAAM,CAAC;IAEX,IAAI,EAAE,MAAM,CAAC;IAEb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IAEZ,GAAG,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAE7D,SAAS,EAAE,OAAO,CAAC;IACnB,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAE5B,MAAM,EAAE,OAAO,CAAC;IAEhB,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;IACzC,QAAQ,EAAE,QAAQ,CAAC;IAEnB,UAAU,EAAE,MAAM,CAAC;IAEnB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,IAAI,CAAC,EAAE;QACN,EAAE,CAAC,EAAE,gBAAgB,CAAC;QACtB,EAAE,CAAC,EAAE,gBAAgB,CAAC;KACtB,CAAC;IAEF,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC7B,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,gBAAgB;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,IAAI;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE;QACL,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;KACd,CAAC;CACF;AAED,MAAM,WAAW,WAAW;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,WAAW,QAAQ;IAExB,QAAQ,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE;QAEP,EAAE,EAAE,MAAM,CAAC;QACX,cAAc,EAAE,MAAM,CAAC;QAEvB,YAAY,EAAE,MAAM,CAAC;KACrB,EAAE,CAAC;CACJ;AAID,MAAM,MAAM,oBAAoB,GAAG,2BAA2B,CAAC;AAE/D,MAAM,MAAM,wBAAwB,GAAG,YAAY,CAAC;AAEpD,MAAM,WAAW,uBAAwB,SAAQ,WAAW;IAC3D,IAAI,EAAE,oBAAoB,CAAC;CAC3B;AAID,MAAM,WAAW,qBAAqB;IAErC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,wBAAwB,GAAG,aAAa,CAAC;AAErD,MAAM,WAAW,uBAAwB,SAAQ,WAAW,EAAE,YAAY,CAAC,qBAAqB,CAAC;CAAG;AAIpG,MAAM,WAAW,mBAAmB;IAEnC,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,oBAAoB;IAEpC,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,uBAAuB,GAAG,YAAY,CAAC;AAEnD,MAAM,WAAW,sBAChB,SAAQ,WAAW,EAClB,YAAY,CAAC,oBAAoB,CAAC,EAClC,mBAAmB;CAAG;AAIxB,MAAM,WAAW,mBAAmB;IAEnC,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,mBAAmB,GAAG,0BAA0B,CAAC;AAE7D,MAAM,MAAM,uBAAuB,GAAG,YAAY,CAAC;AAEnD,MAAM,WAAW,sBAAuB,SAAQ,WAAW,EAAE,mBAAmB;IAC/E,IAAI,EAAE,mBAAmB,CAAC;CAC1B;AAID,MAAM,WAAW,qBAAqB;IAErC,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,qBAAqB,GAAG,4BAA4B,CAAC;AAEjE,MAAM,MAAM,yBAAyB,GAAG,YAAY,CAAC;AAErD,MAAM,WAAW,wBAAyB,SAAQ,WAAW,EAAE,qBAAqB;IACnF,IAAI,EAAE,qBAAqB,CAAC;CAC5B;AAID,MAAM,WAAW,sBAAsB;IAEtC,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAAC;AAEjD,MAAM,WAAW,yBAA0B,SAAQ,WAAW,EAAE,sBAAsB;CAAG"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compassdigital/sdk.typescript",
3
- "version": "4.92.0",
3
+ "version": "4.93.0",
4
4
  "description": "Compass Digital Labs TypeScript SDK",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/index.js",
@@ -13,21 +13,45 @@ export interface Success {
13
13
  success?: boolean;
14
14
  }
15
15
 
16
- export interface AnnouncementRequest {
16
+ export interface AnnouncementPostRequestBody {
17
17
  // Name of Announcement
18
18
  name: string;
19
19
  // Announcement Type
20
20
  type: string;
21
- key: string;
22
21
  // App name
23
- app: string;
22
+ app: 'Boost' | 'Thrive' | 'Nourish' | 'JJKitchen' | 'Rogers';
24
23
  // True if all the sites are linked
25
24
  is_global?: boolean;
26
25
  allowed_resources?: string[];
27
26
  position: number;
28
- active: boolean;
27
+ //@deprecated
28
+ active?: boolean;
29
+ // Status of the announcement
30
+ status?: 'draft' | 'active' | 'disabled';
29
31
  // Announcement Properties
30
- info: {
32
+ info?: {
33
+ en?: AnnouncementInfo;
34
+ fr?: AnnouncementInfo;
35
+ };
36
+ schedule?: Schedule;
37
+ [index: string]: any;
38
+ }
39
+
40
+ export interface AnnouncementPutRequestBody {
41
+ // Name of Announcement
42
+ name: string;
43
+ // Announcement Type
44
+ type: string;
45
+ // True if all the sites are linked
46
+ is_global?: boolean;
47
+ allowed_resources?: string[];
48
+ position: number;
49
+ //@deprecated
50
+ active?: boolean;
51
+ // Status of the announcement
52
+ status?: 'draft' | 'active' | 'disabled';
53
+ // Announcement Properties
54
+ info?: {
31
55
  en?: AnnouncementInfo;
32
56
  fr?: AnnouncementInfo;
33
57
  };
@@ -40,14 +64,14 @@ export interface AnnouncementPatchRequestBody {
40
64
  name?: string;
41
65
  // Announcement Type
42
66
  type?: string;
43
- key?: string;
44
- // App name
45
- app?: string;
46
67
  // True if all the sites are linked
47
68
  is_global?: boolean;
48
69
  allowed_resources?: string[];
49
70
  position?: number;
71
+ //@deprecated
50
72
  active?: boolean;
73
+ // Status of the announcement
74
+ status?: 'draft' | 'active' | 'disabled';
51
75
  // Announcement Properties
52
76
  info?: {
53
77
  en?: AnnouncementInfo;
@@ -65,11 +89,14 @@ export interface Announcement {
65
89
  type: string;
66
90
  key: string;
67
91
  // App name
68
- app: string;
92
+ app: 'Boost' | 'Thrive' | 'Nourish' | 'JJKitchen' | 'Rogers';
69
93
  // True if all the sites are linked
70
94
  is_global: boolean;
71
95
  allowed_resources: string[];
96
+ //@deprecated
72
97
  active: boolean;
98
+ // Status of the announcement
99
+ status?: 'draft' | 'active' | 'disabled';
73
100
  schedule: Schedule;
74
101
  // Date created
75
102
  created_at: string;
@@ -117,18 +144,20 @@ export interface Schedule {
117
144
  // If true, refer to `sites`, if false, refer to start/end times below
118
145
  variable: boolean;
119
146
  start_datetime?: string;
147
+ // Maximum 1 year from today
120
148
  end_datetime?: string;
121
149
  sites?: {
122
150
  // group
123
151
  id: string;
124
152
  start_datetime: string;
153
+ // Maximum 1 year from today
125
154
  end_datetime: string;
126
155
  }[];
127
156
  }
128
157
 
129
158
  // POST /announcement - Create Announcement
130
159
 
131
- export type PostAnnouncementBody = AnnouncementRequest;
160
+ export type PostAnnouncementBody = AnnouncementPostRequestBody;
132
161
 
133
162
  export type PostAnnouncementResponse = Announcement;
134
163
 
@@ -204,7 +233,7 @@ export interface PutAnnouncementPath {
204
233
  id: string;
205
234
  }
206
235
 
207
- export type PutAnnouncementBody = AnnouncementRequest;
236
+ export type PutAnnouncementBody = AnnouncementPutRequestBody;
208
237
 
209
238
  export type PutAnnouncementResponse = Announcement;
210
239