@equipmyschool/emsweb3-models 1.0.49 → 1.0.52

package/index.d.ts

@@ -66,8 +66,8 @@ export interface Campaign {
   Title: string;
   Introduction: string;
   TermsAndConditions: string;
-  StartDate?: Date;
-  EndDate?: Date;
+  StartDate: Date;
+  EndDate: Date;
   Status: CampaignStatus;
   Supplier: Supplier;
 }
@@ -93,8 +93,18 @@ export interface Company {
   Name: string;
   Type: CompanyType;
 }
+export interface EMSProductImageSearchRequest {
+  Product: number;
+  Supplier: number;
+  Code: string;
+}
+export interface EMSProductImageSearchResponse {
+  ProductID: number;
+  CommonDetailID: number;
+  ImageUrl: string;
+}
 export interface FolderInfoBase extends IActionable, FolderBase {
-  ProjectID?: number;
+  ProjectID: number;
   FolderID: number;
   CurrencySymbol: string;
   TotalLines: number;
@@ -141,7 +151,7 @@ export interface Credential {
   RememberMe: boolean;
 }
 export interface Department {
-  DepartmentID?: number;
+  DepartmentID: number;
   Name: string;
 }
 export interface EditPriorityRequest {
@@ -158,7 +168,7 @@ export interface EmailActionResponse {
   Message: string;
 }
 export interface ExtendedDepartment extends Department {
-  ProductCount?: number;
+  ProductCount: number;
   Children: ExtendedDepartment[];
 }
 export interface FacetResponse {
@@ -193,9 +203,9 @@ export interface FacetsStringResponse extends FacetBase {
   Values: ValueCount[];
 }
 export interface Folder extends FolderBase {
-  FolderID?: number;
+  FolderID: number;
   ParentFolderID: number;
-  OwnerID?: number;
+  OwnerID: number;
 }
 export interface FolderBase {
   Name: string;
@@ -203,7 +213,7 @@ export interface FolderBase {
 }
 export interface FolderInfo extends IActionable, FolderInfoBase {
   /** The id of the parent folder. If the folder is actually a project, or if it is a root folder of a project, this field is null. */
-  ParentFolderID?: number;
+  ParentFolderID: number;
   Owner: User;
   Unallocated: number;
   FolderCount: number;
@@ -251,8 +261,8 @@ export interface IProject {
   ProjectID: number;
   Name: string;
   Status: ProjectStatus;
-  RequiredArrivalDate?: Date;
-  RequiredClosureDate?: Date;
+  RequiredArrivalDate: Date;
+  RequiredClosureDate: Date;
 }
 export interface Item {
   ItemID: number;
@@ -265,6 +275,9 @@ export interface ItemActivity extends Activity {
   Quantity: number;
   Price: number;
   Currency: string;
+  Supplier: string;
+  ProductCode: string;
+  Url: string;
 }
 export interface ItemCopyRequest {
   SourceOrderID: number;
@@ -284,14 +297,14 @@ export interface ItemInfo {
   Title: string;
   Description: string;
   Status: string;
-  ETA?: Date;
+  ETA: Date;
   Quantity: number;
   Unit: string;
   HasMessages: boolean;
   Priority: ItemPriority;
-  UnitPrice?: number;
-  Value?: number;
-  Discount?: number;
+  UnitPrice: number;
+  Value: number;
+  Discount: number;
   CurrencySymbol: string;
   /** The ID of the group of variants. */
   CommonDetailID: number;
@@ -313,12 +326,17 @@ export interface JWTPayload {
   /** Discount structure */
   D: JWTDiscount[];
   /** School Group ID */
-  G?: number;
+  G: number;
   /**
   * List of preferred vendor IDs
-  *  Empty List == no preferences
+  *  Empty List == all suppliers shown
   */
   V: number[];
+  /**
+  * List of blacklisted vendor IDs
+  *  Empty List == all suppliers allowed
+  */
+  B: number[];
   /** List of allowed supplier countries */
   C: number[];
 }
@@ -329,9 +347,9 @@ export interface Location {
   Country: string;
 }
 export interface NavDepartmentRequest {
-  DepartmentID?: number;
-  SearchID?: number;
-  SimilarTo?: number;
+  DepartmentID: number;
+  SearchID: number;
+  SimilarTo: number;
 }
 export interface NotificationAction {
   ProjectID: number;
@@ -390,7 +408,7 @@ export interface OrderInfo extends IActionable, IApprovable, FolderInfoBase {
   CanApprove: boolean;
 }
 export interface OrderInfoCollection extends IProject, IActionable {
-  FolderID?: number;
+  FolderID: number;
   FolderName: string;
   FolderBudget: number;
   Owner: User;
@@ -403,8 +421,8 @@ export interface OrderInfoCollection extends IProject, IActionable {
   ProjectID: number;
   ProjectName: string;
   Status: ProjectStatus;
-  RequiredArrivalDate?: Date;
-  RequiredClosureDate?: Date;
+  RequiredArrivalDate: Date;
+  RequiredClosureDate: Date;
 }
 export interface OrderRejectRequest {
   OrderID: number;
@@ -423,12 +441,12 @@ export interface ProblemType {
   ProblemType: string;
 }
 export interface ProductDetailRequest {
-  CommonDetailID?: number;
-  SearchID?: number;
-  Position?: number;
+  CommonDetailID: number;
+  SearchID: number;
+  Position: number;
 }
 export interface ProductDetails extends ProductDetailsBase {
-  CampaignID?: number;
+  CampaignID: number;
   Description: string;
   Products: ProductVariation[];
   Specifications: FacetBase[];
@@ -460,8 +478,8 @@ export interface ProductPageDetails {
   ProductPageID: number;
   Url: string;
   ErrorCount: number;
-  LastChecked?: Date;
-  NextCheck?: Date;
+  LastChecked: Date;
+  NextCheck: Date;
 }
 export interface ProductSearchDepartment {
   DepartmentID: number;
@@ -470,9 +488,9 @@ export interface ProductSearchDepartment {
 }
 export interface ProductSearchResult extends ProductDetailsBase {
   ImageUrl: string;
-  OverlayID?: number;
+  OverlayID: number;
   /** The ID of one specific variant product. */
-  ProductID?: number;
+  ProductID: number;
   Variations: number;
 }
 export interface ProductToOrder {
@@ -497,21 +515,21 @@ export interface ProductVariation {
 export interface ProductVariationEMS extends ProductVariation {
   EMSDiscount: number;
   EMSProductStatus: string;
-  LastImported?: Date;
-  LastUpdated?: Date;
-  PricingExpiry?: Date;
+  LastImported: Date;
+  LastUpdated: Date;
+  PricingExpiry: Date;
   RRP: number;
 }
 export interface Project {
   /** The Id of the project. If 0, the project is a wishlist. */
   ProjectID: number;
   Name: string;
-  Budget?: number;
+  Budget: number;
   DeliveryAddressID: number;
   InvoiceAddressID: number;
   CurrencyID: number;
   FreightContactID: number;
-  RequiredArrivalDate?: Date;
+  RequiredArrivalDate: Date;
   SourceProjectID: number;
   RetainDepartments: boolean;
   RetainBudgets: boolean;
@@ -525,9 +543,9 @@ export interface ProjectClosureResponse {
 export interface ProjectInfo extends IActionable, IProject, FolderInfo {
   DeliveryAddressID: number;
   InvoiceAddressID: number;
-  FreightContactID?: number;
+  FreightContactID: number;
   CurrencyID: number;
-  ClosureYear?: number;
+  ClosureYear: number;
   TotalOrders: number;
   CompleteOrders: number;
   PartialOrders: number;
@@ -535,8 +553,20 @@ export interface ProjectInfo extends IActionable, IProject, FolderInfo {
   ProjectID: number;
   Name: string;
   Status: ProjectStatus;
-  RequiredArrivalDate?: Date;
-  RequiredClosureDate?: Date;
+  RequiredArrivalDate: Date;
+  RequiredClosureDate: Date;
+}
+export interface ProjectSummary {
+  ProjectID: number;
+  FolderID: number;
+  OrderID: number;
+  OrderReference: string;
+  LineCount: number;
+  BudgetAllocation: number;
+  Spent: number;
+  Submitted: boolean;
+  Reviewer: string;
+  OrderManager: User;
 }
 export interface ProjectTreeNode extends IActionable {
   ID: number;
@@ -568,11 +598,11 @@ export interface RequestForFunds {
   Reason: string;
 }
 export interface SearchRequest {
-  Page?: number;
-  Size?: number;
+  Page: number;
+  Size: number;
   Keywords: string;
-  DepartmentID?: number;
-  CampaignID?: number;
+  DepartmentID: number;
+  CampaignID: number;
   SupplierIDs: number[];
   StringFacets: FacetsStringRequest[];
   NumberFacets: FacetsNumberRequest[];
@@ -592,7 +622,7 @@ export interface ShopCampaign extends Campaign {
   CustomerDiscount: number;
   LargeBannerImageUrl: string;
   SmallBannerImageUrl: string;
-  OverlayID?: number;
+  OverlayID: number;
 }
 export interface Summary {
   YearsExperience: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equipmyschool/emsweb3-models",
-  "version": "1.0.49",
+  "version": "1.0.52",
   "description": "Shared Models for EMS Web Projects",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"