@equipmyschool/emsweb3-models 1.0.43 → 1.0.44

package/enums.ts

@@ -1,9 +1,9 @@
-export const enum CampaignBannerSize {
+export enum CampaignBannerSize {
   Small = 0,
   Large = 1
 }
 
-export const enum CampaignStatus {
+export enum CampaignStatus {
   Draft = 0,
   Pending = 1,
   Published = 2,
@@ -11,44 +11,49 @@ export const enum CampaignStatus {
   Archived = 4
 }
 
-export const enum OriginType {
+export enum CopyType {
+  Copy = 0,
+  Move = 1
+}
+
+export enum OriginType {
   NoPreference = 0,
   UK = 1,
   USA = 2,
   Australia = 3
 }
 
-export const enum CurrencyType {
+export enum CurrencyType {
   Native = 0,
   GBP = 1,
   USD = 2
 }
 
-export const enum CompanyType {
+export enum CompanyType {
   Customer = 1,
   Supplier = 2,
   FreightAgent = 3,
   None = -1
 }
 
-export const enum Gender {
+export enum Gender {
   Female = 0,
   Male = 1
 }
 
-export const enum ItemPriority {
+export enum ItemPriority {
   Need = 0,
   Wish = -1
 }
 
-export const enum ObjectType {
+export enum ObjectType {
   Project = 0,
   Folder = 1,
   Order = 2,
   Item = 3
 }
 
-export const enum OrderStatus {
+export enum OrderStatus {
   Open = 0,
   Review = 1,
   Confirmed = 2,
@@ -56,14 +61,14 @@ export const enum OrderStatus {
   Rejected = -1
 }
 
-export const enum ProjectStatus {
+export enum ProjectStatus {
   Open = 0,
   Live = 1,
   Complete = 2,
   Unknown = -1
 }
 
-export const enum SearchSort {
+export enum SearchSort {
   Relevant = 0,
   Popular = 1,
   PriceAsc = 2,
@@ -72,7 +77,7 @@ export const enum SearchSort {
   TitleDesc = 5
 }
 
-export const enum UserType {
+export enum UserType {
   User = 0,
   Admin = 1,
   Staff = 2,

package/index.d.ts

@@ -1,4 +1,4 @@
-import { CampaignBannerSize, CampaignStatus, OriginType, CurrencyType, CompanyType, Gender, ItemPriority, ObjectType, OrderStatus, ProjectStatus, SearchSort, UserType } from './enums';
+import { CampaignBannerSize, CampaignStatus, CopyType, OriginType, CurrencyType, CompanyType, Gender, ItemPriority, ObjectType, OrderStatus, ProjectStatus, SearchSort, UserType } from './enums';
 
 export interface Activity {
   ID: number;
@@ -89,14 +89,44 @@ export interface Company {
   Name: string;
   Type: CompanyType;
 }
+export interface FolderInfoBase extends IActionable, FolderBase {
+  ProjectID?: number;
+  FolderID: number;
+  CurrencySymbol: string;
+  TotalLines: number;
+  TotalValue: number;
+  OrderedLines: number;
+  OrderedValue: number;
+  InStockLines: number;
+  InStockValue: number;
+  DispatchedLines: number;
+  DispatchedValue: number;
+  NotAvailableLines: number;
+  NotAvailableValue: number;
+  /** Indicates whether the user can edit this item. */
+  CanEdit: boolean;
+  /** Indicates whether the user can add to this item. */
+  CanAddTo: boolean;
+}
 export interface ImportUserResponse extends ImportUserDetail {
   UserID: number;
   ErrorMessage: string;
 }
+export interface ItemCopyToNewOrderRequest {
+  SourceOrderID: number;
+  DestinationOrder: Order;
+  ItemIDs: number[];
+}
 export interface NewRegistration {
   Guid: string;
   ConfirmCode: string;
 }
+export interface OrderProblem {
+  ID: number;
+  Reference: string;
+  WaitingOn: User;
+  Reason: string;
+}
 export interface Country {
   CountryID: number;
   Name: string;
@@ -158,52 +188,24 @@ export interface FacetString extends FacetBase {
 export interface FacetsStringResponse extends FacetBase {
   Values: ValueCount[];
 }
-export interface Folder {
-  FolderID: number;
-  ParentFolderID?: number;
-  ProjectID: number;
-  Name: string;
+export interface Folder extends FolderBase {
+  FolderID?: number;
+  ParentFolderID: number;
   OwnerID?: number;
-  Budget: number;
 }
 export interface FolderBase {
-  FolderID: number;
   Name: string;
+  Budget: number;
 }
-export interface FolderInfo extends IActionable {
-  /**
-  * If the folder is actually a folder, this is the id of the containing project.
-  *  If the folder is actually a project, this is the id of the project.
-  *  If the folder is actually a Wishlist project, this value is 0.
-  */
-  ProjectID: number;
-  /** The Id of the folder. If the folder is actually a project, this field is null. */
-  FolderID?: number;
+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;
-  Name: string;
-  Budget: number;
   Owner: User;
   Unallocated: number;
-  CurrencySymbol: string;
   FolderCount: number;
   OrderCount: number;
   OrderBudget: number;
   OrderAmount: number;
-  TotalLines: number;
-  TotalValue: number;
-  OrderedLines: number;
-  OrderedValue: number;
-  InStockLines: number;
-  InStockValue: number;
-  DispatchedLines: number;
-  DispatchedValue: number;
-  NotAvailableLines: number;
-  NotAvailableValue: number;
-  /** Indicates whether the user can edit this folder. */
-  CanEdit: boolean;
-  /** Indicates whether the user can create child folders or orders in this folder. */
-  CanAddTo: boolean;
 }
 export interface ForgotPassRequest {
   Email: string;
@@ -301,19 +303,10 @@ export interface JWTDiscount {
   O: number;
 }
 export interface JWTPayload {
-  /** Token expiry time */
   exp: number;
-  /** IsStaff? */
   S: number;
-  /** Discount structure */
   D: JWTDiscount[];
-  /** School Group ID */
   G?: number;
-  /**
-  * List of preferred vendor IDs
-  *  Empty List == no preferences
-  */
-  V: number[];
 }
 export interface Location {
   LocationID: number;
@@ -351,12 +344,9 @@ export interface NotificationProject {
   OrderNotificationCount: number;
   Folders: NotificationFolder[];
 }
-export interface Order {
+export interface Order extends FolderBase {
   OrderID: number;
-  FolderID?: number;
-  ProjectID: number;
-  Reference: string;
-  Budget: number;
+  FolderID: number;
   ManagedByID: number;
   Contributors: number[];
 }
@@ -370,34 +360,16 @@ export interface OrderConfirmRequest {
   OrderID: number;
   Comment: string;
 }
-export interface OrderInfo extends IActionable, IApprovable {
+export interface OrderInfo extends IActionable, IApprovable, FolderInfoBase {
   OrderID: number;
-  Reference: string;
-  Budget: number;
   ManagedBy: User;
   Reviewer: User;
   Status: OrderStatus;
   IsWebOrder: boolean;
-  ItemCount: number;
   AvailableSpend: number;
   Wishes: number;
-  TotalValue: number;
-  OrderedLines: number;
-  OrderedValue: number;
-  InStockLines: number;
-  InStockValue: number;
-  DispatchedLines: number;
-  DispatchedValue: number;
-  NotAvailableLines: number;
-  NotAvailableValue: number;
-  FolderID?: number;
-  ProjectID?: number;
   ProjectName: string;
-  CurrencySymbol: string;
   Contributors: number[];
-  /** Indicates whether the user can edit this order. */
-  CanEdit: boolean;
-  CanAddTo: boolean;
   CanSubmit: boolean;
   CanCancel: boolean;
   CanApprove: boolean;
@@ -531,6 +503,10 @@ export interface Project {
   RetainOrders: boolean;
   RetainProducts: boolean;
 }
+export interface ProjectClosureResponse {
+  Successful: boolean;
+  IncompleteOrders: OrderProblem[];
+}
 export interface ProjectInfo extends IActionable, IProject, FolderInfo {
   DeliveryAddressID: number;
   InvoiceAddressID: number;
@@ -568,9 +544,14 @@ export interface RegistrationRequest extends UserDetail {
   CompanyType: CompanyType;
 }
 export interface ReportProblemRequest {
+  ProblemUrl: string;
   ProblemType: number;
   Comment: string;
 }
+export interface RequestForFunds {
+  Amount: number;
+  Reason: string;
+}
 export interface SearchRequest {
   Page?: number;
   Size?: number;

package/package.json

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