@compassdigital/sdk.typescript 4.91.0 → 4.93.0

package/src/interface/announcement.ts

@@ -13,45 +13,105 @@ export interface Success {
 	success?: boolean;
 }
 
-export interface Announcement {
-	// announcement
-	id?: string;
+export interface AnnouncementPostRequestBody {
+	// Name of Announcement
+	name: string;
+	// Announcement Type
+	type: string;
+	// App name
+	app: 'Boost' | 'Thrive' | 'Nourish' | 'JJKitchen' | 'Rogers';
+	// True if all the sites are linked
+	is_global?: boolean;
+	allowed_resources?: string[];
+	position: number;
+	//@deprecated
+	active?: boolean;
+	// Status of the announcement
+	status?: 'draft' | 'active' | 'disabled';
+	// Announcement Properties
+	info?: {
+		en?: AnnouncementInfo;
+		fr?: AnnouncementInfo;
+	};
+	schedule?: Schedule;
+	[index: string]: any;
+}
+
+export interface AnnouncementPutRequestBody {
+	// Name of Announcement
+	name: string;
+	// Announcement Type
+	type: string;
+	// True if all the sites are linked
+	is_global?: boolean;
+	allowed_resources?: string[];
+	position: number;
+	//@deprecated
+	active?: boolean;
+	// Status of the announcement
+	status?: 'draft' | 'active' | 'disabled';
+	// Announcement Properties
+	info?: {
+		en?: AnnouncementInfo;
+		fr?: AnnouncementInfo;
+	};
+	schedule?: Schedule;
+	[index: string]: any;
+}
+
+export interface AnnouncementPatchRequestBody {
 	// Name of Announcement
 	name?: string;
-	// Date created
-	created_at?: string;
-	// Date modified
-	last_modified?: string;
 	// Announcement Type
 	type?: string;
-	key?: string;
-	// App name
-	app?: string;
 	// True if all the sites are linked
 	is_global?: boolean;
 	allowed_resources?: string[];
 	position?: number;
+	//@deprecated
 	active?: boolean;
+	// Status of the announcement
+	status?: 'draft' | 'active' | 'disabled';
 	// Announcement Properties
 	info?: {
-		en?: Announcement_info;
-		fr?: Announcement_info;
+		en?: AnnouncementInfo;
+		fr?: AnnouncementInfo;
 	};
-	// Schedule details
-	schedule?: {
-		// If true, refer to `sites`, if false, refer to start/end times below
-		variable?: boolean;
-		start_datetime?: string;
-		end_datetime?: string;
-		sites?: {
-			// group
-			id: string;
-			start_datetime: string;
-			end_datetime: string;
-		}[];
+	schedule?: Schedule;
+}
+
+export interface Announcement {
+	// announcement
+	id: string;
+	// Name of Announcement
+	name: string;
+	// Announcement Type
+	type: string;
+	key: string;
+	// App name
+	app: 'Boost' | 'Thrive' | 'Nourish' | 'JJKitchen' | 'Rogers';
+	// True if all the sites are linked
+	is_global: boolean;
+	allowed_resources: string[];
+	//@deprecated
+	active: boolean;
+	// Status of the announcement
+	status?: 'draft' | 'active' | 'disabled';
+	schedule: Schedule;
+	// Date created
+	created_at: string;
+	// Date modified
+	last_modified: string;
+	position?: number;
+	// Announcement Properties
+	info?: {
+		en?: AnnouncementInfo;
+		fr?: AnnouncementInfo;
 	};
+	//@deprecated
 	date?: Record<string, any>;
-	author?: Author;
+	author?: User;
+	edit_history?: EditHistory[];
 	[index: string]: any;
 }
 
@@ -59,15 +119,15 @@ export interface Announcements {
 	announcements?: Announcement[];
 }
 
-export interface Announcement_info {
+export interface AnnouncementInfo {
 	image_url?: string;
-	title?: string;
-	description?: string;
-	sub_text?: string;
+	title: string;
+	description: string;
+	sub_text: string;
 	button_text?: string;
 }
 
-export interface Author {
+export interface User {
 	id: string;
 	name: {
 		first?: string;
@@ -75,9 +135,29 @@ export interface Author {
 	};
 }
 
+export interface EditHistory {
+	date?: string;
+	user?: User;
+}
+
+export interface Schedule {
+	// If true, refer to `sites`, if false, refer to start/end times below
+	variable: boolean;
+	start_datetime?: string;
+	// Maximum 1 year from today
+	end_datetime?: string;
+	sites?: {
+		// group
+		id: string;
+		start_datetime: string;
+		// Maximum 1 year from today
+		end_datetime: string;
+	}[];
+}
+
 // POST /announcement - Create Announcement
 
-export type PostAnnouncementBody = Announcement;
+export type PostAnnouncementBody = AnnouncementPostRequestBody;
 
 export type PostAnnouncementResponse = Announcement;
 
@@ -93,7 +173,7 @@ export interface GetAnnouncementsQuery {
 	// Filter by latest creation date
 	created_at_end?: string;
 	// Filter by earliest modified date
-	last_modified_start: string;
+	last_modified_start?: string;
 	// Filter by latest modified date
 	last_modified_end?: string;
 	// Filter by earliest start date
@@ -113,6 +193,12 @@ export interface GetAnnouncementsQuery {
 	enabled?: boolean;
 	// Filter by announcement purpose
 	purpose?: string;
+	// Filter by author name
+	author?: string;
+	// Field to sort by
+	sort_by?: string;
+	// Sort order (ASC or DESC)
+	sort_order?: string;
 	// Graphql query string
 	_query?: string;
 }
@@ -147,7 +233,7 @@ export interface PutAnnouncementPath {
 	id: string;
 }
 
-export type PutAnnouncementBody = Announcement;
+export type PutAnnouncementBody = AnnouncementPutRequestBody;
 
 export type PutAnnouncementResponse = Announcement;
 
@@ -155,6 +241,21 @@ export interface PutAnnouncementRequest extends BaseRequest, PutAnnouncementPath
 	body: PutAnnouncementBody;
 }
 
+// PATCH /announcement/{id} - Update Announcement
+
+export interface PatchAnnouncementPath {
+	// ID of the announcement to update
+	id: string;
+}
+
+export type PatchAnnouncementBody = AnnouncementPatchRequestBody;
+
+export type PatchAnnouncementResponse = Announcement;
+
+export interface PatchAnnouncementRequest extends BaseRequest, PatchAnnouncementPath {
+	body: PatchAnnouncementBody;
+}
+
 // DELETE /announcement/{id} - Delete announcement item
 
 export interface DeleteAnnouncementPath {