@fragus/sam-types 1.0.34 → 1.0.36

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.
Files changed (3) hide show
  1. package/package.json +1 -1
  2. package/types/dashboardBanner.d.ts +12 -2
  3. package/types/dashboardBanner.ts +13 -2
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.0.34",
2
+ "version": "1.0.36",
3
3
  "name": "@fragus/sam-types",
4
4
  "description": "Typescript interfaces for all types used to communicate between SAM client(s) and the SAM API",
5
5
  "author": "Fragus",
package/types/dashboardBanner.d.ts CHANGED
@@ -1,10 +1,17 @@
1
+ import { TIsoCountry } from './country';
1
2
  /**
2
3
  * Request body for creating or updating a dashboard banner (Superadmin)
3
4
  */
4
5
  export interface DashboardBannerRequest {
5
6
  text: string;
6
- countryIso: string;
7
+ countryIso: TIsoCountry;
8
+ /**
9
+ * ISO date string (YYYY-MM-DD) for the start date of the banner
10
+ */
7
11
  startDate: string;
12
+ /**
13
+ * ISO date string (YYYY-MM-DD) for the end date of the banner
14
+ */
8
15
  endDate: string;
9
16
  }
10
17
  /**
@@ -12,7 +19,10 @@ export interface DashboardBannerRequest {
12
19
  */
13
20
  export interface DashboardBannerResponse extends DashboardBannerRequest {
14
21
  id: number;
15
- updatedByUser: string | undefined;
22
+ /**
23
+ * Email of the user who last updated the banner
24
+ */
25
+ updatedByUser: string;
16
26
  }
17
27
  /**
18
28
  * Response body for retrieving dashboard banner text in Admin
package/types/dashboardBanner.ts CHANGED
@@ -1,10 +1,18 @@
1
+ import { TIsoCountry } from './country'
2
+
1
3
  /**
2
4
  * Request body for creating or updating a dashboard banner (Superadmin)
3
5
  */
4
6
  export interface DashboardBannerRequest {
5
7
  text: string
6
- countryIso: string
8
+ countryIso: TIsoCountry
9
+ /**
10
+ * ISO date string (YYYY-MM-DD) for the start date of the banner
11
+ */
7
12
  startDate: string
13
+ /**
14
+ * ISO date string (YYYY-MM-DD) for the end date of the banner
15
+ */
8
16
  endDate: string
9
17
  }
10
18
 
@@ -13,7 +21,10 @@ export interface DashboardBannerRequest {
13
21
  */
14
22
  export interface DashboardBannerResponse extends DashboardBannerRequest {
15
23
  id: number
16
- updatedByUser: string | undefined
24
+ /**
25
+ * Email of the user who last updated the banner
26
+ */
27
+ updatedByUser: string
17
28
  }
18
29
 
19
30
  /**