@placeshakr/config 10.19.15 → 10.19.16-alpha.2

package/src/types.ts

@@ -63,6 +63,46 @@ export interface Resource {
    */
   owner?: string | User;
 
+  /**
+   * owner data
+   */
+  ownerData?: {
+    /**
+     * Owner id
+     */
+    id: string;
+
+    /**
+     * User id
+     */
+    userId: string;
+
+    /**
+     * Owner's display name
+     */
+    displayName: string;
+
+    /**
+     * Owner's email
+     */
+    email: string;
+
+    /**
+     * Owner's phone numbers
+     */
+    phone: Phone[];
+
+    /**
+     * Owner's avatar
+     */
+    photo: File | null;
+
+    /**
+     * Owner's role
+     */
+    role: ROLE | null;
+  };
+
   /**
    * When this resource has been created
    */
@@ -340,6 +380,14 @@ export interface Enterprise extends Resource {
 
   notificationEstimation?: string[];
 
+  devisDocConfig: {
+    color: { label: DevisDocColorEnum; value: string }[];
+    sections: {
+      [key: DevisDocSectionEnum | string]: boolean;
+    };
+    presentation: string;
+  };
+
   /**
    * Computed subscription settings
    */
@@ -378,6 +426,9 @@ export interface Enterprise extends Resource {
 
   certificates: Certificate[];
 
+  /**
+   * Used to enabled or disable pluguins on the system
+   */
   pluginsConfig?: {
     visitReport?: boolean;
   };
@@ -386,9 +437,9 @@ export interface Enterprise extends Resource {
    * Used to save the last reference created for the two types of bills
    */
   billsReferences?: {
-    bill: number,
-    creditNote: number
-  }
+    bill: number;
+    creditNote: number;
+  };
 }
 
 export type Certificate = { name: string; number: number };
@@ -733,15 +784,19 @@ export interface Commissions {
   /**
    * Percentage corresponding to the company
    */
-  "enterprise": number;
+  enterprise: number;
   /**
    * Percentage corresponding to the pro
    */
-  "pro": number;
+  pro: number;
   /**
    * Percentage corresponding to the provider
    */
-  "provider": number;
+  provider: number;
+  /**
+   * Percentage corresponding to the client
+   */
+  client?: number;
 }
 
 /**
@@ -1143,18 +1198,19 @@ export interface VisitReport extends Resource {
   devisTypeDescription?: string;
 
   estimatedResult: {
-    power: number,
-    devis: string,
-    equipment: string,
-    equipmentSize: string,
-    helps: { name: string, value: number }[]
+    power: number;
+    m2Power: number;
+    devis: string;
+    equipment: string;
+    equipmentSize: string;
+    helps: { name: string; value: number }[];
   };
   customResult?: {
-    power: string,
-    devis: string,
-    equipment: string,
-    equipmentSize: string,
-    helps: { name: string, value: number }[]
+    power: string;
+    devis: string;
+    equipment: string;
+    equipmentSize: string;
+    helps: { name: string; value: number }[];
   };
   title: string;
   status: VisitReportStatus;
@@ -1444,7 +1500,7 @@ export interface Material extends Resource {
   /**
    * Define if should be used to calculate devis prix
    */
-  include?: boolean
+  include?: boolean;
 }
 
 export interface DevisMaterial extends Material {
@@ -1515,9 +1571,9 @@ export interface DevisMaterial extends Material {
 
   fixed?: boolean;
 
-  quantityConfig?: number
+  quantityConfig?: number;
 
-  commissions?: Commissions
+  commissions?: Commissions;
 }
 
 export interface Order extends Resource {
@@ -1568,7 +1624,13 @@ export interface DevisPiece extends Resource {
    */
   surfaces?: PieceSurfaces;
 
-  commissions?: Commissions
+  commissions?: Commissions;
+}
+
+export interface DevisOperationPiece {
+  name: string;
+  quantity: number;
+  id: string
 }
 
 /**
@@ -1667,15 +1729,15 @@ export interface DevisOperation extends Resource {
 
   adjustments?: Array<OperationAdjustment>;
 
-  adjustmentComplement?: string
+  adjustmentComplement?: string;
 
-  adjustmentsStatus?: boolean
+  adjustmentsStatus?: boolean;
 
-  commissions?: Commissions
+  commissions?: Commissions;
 
   responsible?: ItemResponsible;
 
-  barcode?: BarCode
+  barcode?: BarCode;
 }
 
 /**
@@ -1804,7 +1866,7 @@ export interface Devis extends Resource {
    * used on accounting to display devis price block and dashboards
    */
   commissions?: {
-    [key: string]: { percent: number; value: number }
+    [key: string]: { percent: number; value: number };
   };
 
   /**
@@ -1820,7 +1882,7 @@ export interface Devis extends Resource {
   /**
    * Payment planning (temporarily saved in the devis collection in Firestore)
    */
-  paymentPlanning?: { description: string; percent: number; }[];
+  paymentPlanning?: { description: string; percent: number }[];
 
   /**
    * Allow user to add some additionals informations into the devis pdf depending on the section choose
@@ -1853,7 +1915,7 @@ export interface DocMetadataItem {
 export enum DevisCommissionsEntity {
   pro = 'pro',
   provider = 'provider',
-  enterprise = 'enterprise'
+  enterprise = 'enterprise',
 }
 
 export enum DevisHistoryType {
@@ -1876,6 +1938,26 @@ export interface DevisHistoryItem {
   data: any;
 }
 
+export enum DevisDocSectionEnum {
+  PRESENTATION = 'PRESENTATION',
+  RESUME = 'RESUME',
+  MATERIAL_IMAGE = 'MATERIAL_IMAGE',
+  MATERIAL_FIXED = 'MATERIAL_FIXED',
+  MATERIAL_VARIABLE = 'MATERIAL_VARIABLE',
+  RENO_HELP = 'RENO_HELP',
+  COMMENTS = 'COMMENTS',
+  PAYMENTS_PLANNING = 'PAYMENTS_PLANNING',
+  BANK_DETAILS = 'BANK_DETAILS',
+  SIGNATURE_AREA = 'SIGNATURE_AREA',
+  CGV = 'CGV',
+  CERFA_CERTIFICATE = 'CERFA_CERTIFICATE',
+}
+
+export enum DevisDocColorEnum {
+  PRIMARY = 'PRIMARY',
+  SECONDARY = 'SECONDARY',
+}
+
 /**
  *
  */
@@ -1885,6 +1967,11 @@ export interface DevisTemplate extends Resource {
    */
   name: string;
 
+  /**
+   * The devis description
+   */
+  description?: string;
+
   /**
    * Devis prices
    */
@@ -1924,6 +2011,8 @@ export interface DevisTemplate extends Resource {
   systemVersion?: number;
 
   format?: DevisFormatEnum;
+
+  category?: string
 }
 
 /**
@@ -2888,6 +2977,13 @@ export enum CategoryEntityEnum {
   OPERATION = 'OPERATION',
   RESOURCE_LIBRARY = 'RESOURCE_LIBRARY',
   IMAGE_LIBRARY = 'IMAGE_LIBRARY',
+  DEVIS_TEMPLATE = 'DEVIS_TEMPLATE',
+}
+
+export enum DevisTemplateCatProvider {
+  BASIC = 'BASIC',
+  ADVANCED_PIECE = 'ADVANCED_PIECE',
+  ADVANCED_LOT = 'ADVANCED_LOT'
 }
 
 export interface OperationCatalog extends Resource {
@@ -3025,13 +3121,13 @@ export interface OperationV2 extends Resource {
 
   reserves?: string;
 
-  barcode?: BarCode
+  barcode?: BarCode;
 }
 
 export type BarCode = {
-  value: string
-  format: BarCodeEnum
-}
+  value: string;
+  format: BarCodeEnum;
+};
 
 export enum BarCodeEnum {
   CODE128 = 'code128',
@@ -3043,7 +3139,7 @@ export enum BarCodeEnum {
   CODE39 = 'code39',
   ITF14 = 'itf14',
   MSI = 'msi',
-  PHARMACODE = 'pharmacode'
+  PHARMACODE = 'pharmacode',
 }
 
 export interface OperationAdjustment {
@@ -3076,7 +3172,7 @@ export interface OperationV2Material extends Material {
   responsible: ItemResponsible;
   fixed: boolean;
   optId: string;
-  complement?: string
+  complement?: string;
 }
 
 export enum ItemResponsible {