@placeshakr/config 10.19.8 → 10.19.9-alpha.4

package/src/types.ts

@@ -175,13 +175,13 @@ export interface Enterprise extends Resource {
    * Current subscription status
    */
   status:
-  | 'incomplete'
-  | 'incomplete_expired'
-  | 'trialing'
-  | 'active'
-  | 'past_due'
-  | 'canceled'
-  | 'unpaid';
+    | 'incomplete'
+    | 'incomplete_expired'
+    | 'trialing'
+    | 'active'
+    | 'past_due'
+    | 'canceled'
+    | 'unpaid';
 
   /**
    * Kind of forfait
@@ -305,13 +305,13 @@ export interface Enterprise extends Resource {
      * state of subscription
      */
     status:
-    | 'incomplete'
-    | 'incomplete_expired'
-    | 'trialing'
-    | 'active'
-    | 'past_due'
-    | 'canceled'
-    | 'unpaid';
+      | 'incomplete'
+      | 'incomplete_expired'
+      | 'trialing'
+      | 'active'
+      | 'past_due'
+      | 'canceled'
+      | 'unpaid';
 
     /**
      * Coupon id applied to subscription
@@ -361,17 +361,33 @@ export interface Enterprise extends Resource {
   /**
    * Statuses workflow between devis status and project status
    */
-  statusesWorkflow: { devis: DevisStatusEnum; project: string }[];
+  statusesWorkflow: StatusWorkflow[];
 
-  contactEmails: Array<{/**
-    * The contact mail
-    */
+  contactEmails: Array<{
+    /**
+     * The contact mail
+     */
     role: string;
     /**
      * The contact name
      */
     email: string;
   }>;
+
+  certificates: Certificate[];
+}
+
+export type Certificate = { name: string; number: number };
+
+export interface StatusWorkflow {
+  /**
+   * The devis status
+   */
+  devis: DevisStatusEnum;
+  /**
+   * The project id
+   */
+  project: string;
 }
 
 export interface BankDetails {
@@ -831,6 +847,11 @@ export interface Status extends Resource {
    * Identifier to relate the status to its correspondent in system status algolia index
    */
   idReference?: string;
+
+  /**
+   * To set the visibility for the agent
+   */
+  visibleBy?: ROLE[];
 }
 
 /**
@@ -898,6 +919,11 @@ export interface Operation extends Resource {
    * in devis will get tva from provider assigned to the project
    */
   tva?: number | null;
+
+  /**
+   * Lot selected in the operation custom
+   */
+  lot?: string;
 }
 
 /**
@@ -1117,6 +1143,11 @@ export interface Event extends Resource {
    * The event color
    */
   color?: string;
+
+  /**
+   * The users responsible for the event
+   */
+  responsibles?: string[];
 }
 
 export interface PlanPage {
@@ -1287,6 +1318,8 @@ export interface Material extends Resource {
     id: string;
     label: string;
   };
+
+  complement?: string;
 }
 
 export interface DevisMaterial extends Material {
@@ -1343,6 +1376,19 @@ export interface DevisMaterial extends Material {
   devisId?: string;
 
   tva?: number;
+
+  /**
+   * Check if this material is included in devis to use his price and display in pdf
+   */
+  include?: boolean;
+  /**
+   * Use to calculate the quantity
+   */
+  loss?: number;
+
+  rounded?: boolean;
+
+  fixed?: boolean;
 }
 
 export interface Order extends Resource {
@@ -1361,19 +1407,34 @@ export interface Order extends Resource {
   pdf?: File;
 }
 
+export interface PieceSurfaces {
+  floorOrCeiling?: number;
+  linearWall?: number;
+  openingArea?: number;
+  ceilingHeight?: number;
+}
+
 export interface DevisPiece extends Resource {
+  // use only in devis complex
+  id?: string;
+
   /** Piece, example: bathroom, kitchen */
   name: string;
 
   /**
    * Display operations open or compresed
    */
-  optsShow: boolean;
+  optsShow?: boolean;
 
   /**
    * Prices, used to save all prices of operations and materials inside it
    */
   prices?: Price;
+
+  /**
+   * Only used when devis format is PIECE
+   */
+  surfaces?: PieceSurfaces;
 }
 
 /**
@@ -1457,6 +1518,16 @@ export interface DevisOperation extends Resource {
    * Prices, used to save all prices related with the operation
    */
   prices?: Price;
+
+  pieces?: { name: string; quantity: number; id: string }[];
+
+  reserves?: string;
+
+  localization?: string;
+
+  adjustments?: Array<OperationAdjustment>;
+
+  quantityConfig?: OperationQuantityEnum;
 }
 
 /**
@@ -1511,7 +1582,13 @@ export interface Devis extends Resource {
   /**
    * Email status from Sengrid
    */
-  emailStatus?: 'processed' | 'dropped' | 'deferred' | 'delivered' | 'open' | 'spamreport'
+  emailStatus?:
+    | 'processed'
+    | 'dropped'
+    | 'deferred'
+    | 'delivered'
+    | 'open'
+    | 'spamreport';
 
   /**
    * Parent, devis base used to create this one
@@ -1581,36 +1658,61 @@ export interface Devis extends Resource {
     enterprise: { percent: number; value: number };
   };
 
-  /************************************ V2 ************************************/
-  materialsCatalogs?: Array<string>;
+  /**
+   * BankDetails chosen by default in the enterprise settings
+   */
+  bankInfo?: BankDetails;
+
+  /**
+   * Currency chosen by default in the enterprise settings
+   */
+  currency?: string;
+
+  /**
+   * Payment planning (temporarily saved in the devis collection in Firestore)
+   */
+  paymentPlanning?: [
+    {
+      description: string;
+      percent: number;
+    }
+  ];
 
+  /************************************ V2 ************************************/
   operationsCatalog?: string;
 
+  sector?: {
+    label: string;
+    value: number;
+  };
+
   history?: DevisHistoryItem[];
 
-  systemVersion?: number
+  systemVersion?: number;
 
   format?: DevisFormatEnum;
+
+  bankDetails?: BankDetails;
 }
 
 export enum DevisHistoryType {
   CHANGE_STATUS = 'CHANGE_STATUS',
   SENT_TO_CLIENT = 'SENT_TO_CLIENT',
   EMAIL_EVENT = 'EMAIL_EVENT',
-  NEW_VERSION = 'NEW_VERSION'
+  NEW_VERSION = 'NEW_VERSION',
 }
 
 export interface DevisHistoryItem {
-  date: number
+  date: number;
   user?: {
-    id: string,
-    name: string,
-    email: string,
-    role: ROLE
-    photoUrl: string,
-  }
-  type: DevisHistoryType
-  data: any
+    id: string;
+    name: string;
+    email: string;
+    role: ROLE;
+    photoUrl: string;
+  };
+  type: DevisHistoryType;
+  data: any;
 }
 
 /**
@@ -1740,6 +1842,10 @@ export type Bill = Resource & {
   statusComment?: string;
   statusHistory?: any;
   files?: File[];
+  // used to save information related with any possible external system
+  metadata?: {
+    sentToIpaidthat?: boolean;
+  };
 };
 
 export type BillReceived = Bill & {
@@ -2528,6 +2634,12 @@ export enum HistoryActionEnum {
   DEVIS_APPROVED = 'DEVIS_APPROVED',
   DEVIS_SENT = 'DEVIS_SENT',
   DEVIS_SIGNED = 'DEVIS_SIGNED',
+  CREATE_DOCUMENT = 'CREATE_DOCUMENT',
+  CREATE_MEDIA = 'CREATE_MEDIA',
+  CREATE_EVENT = 'CREATE_EVENT',
+  CREATE_PLAN = 'CREATE_PLAN',
+  VALIDATE_PLAN = 'VALIDATE_PLAN',
+  INVALIDATE_PLAN = 'INVALIDATE_PLAN',
 }
 
 export interface History {
@@ -2553,6 +2665,11 @@ export enum HistoryEntityType {
   PROJECT = 'PROJECT',
   NOTE = 'NOTE',
   RECEPTION_VOUCHER = 'RECEPTION_VOUCHER',
+  DOCUMENT = 'DOCUMENT',
+  PLAN = 'PLAN',
+  EVENT = 'EVENT',
+  MEDIA = 'MEDIA',
+  DEVIS = 'DEVIS',
 }
 
 export interface HistoryAction {
@@ -2790,5 +2907,4 @@ export interface OperationsGroup extends Resource {
   operations: string[];
 }
 
-export interface DevisVersion extends Devis {
-}
+export interface DevisVersion extends Devis {}