@placeshakr/config 10.19.0-alpha.5 → 10.19.0

package/src/types.ts

@@ -46,7 +46,7 @@ export type ResourceType =
   | OperationCatalog
   | Nomenclature
   | Operation
-  | OperationV2
+  | OperationV2;
 
 /**
  * Add timestampable behavior to any resource
@@ -176,13 +176,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
@@ -235,6 +235,30 @@ export interface Enterprise extends Resource {
    */
   totalUsers: number;
 
+  /**
+   * Number of admin users contained within the subscription. This number will be used to calculate
+   * the amount to pay for additional admin user
+   */
+  totalAdminUsers: number;
+
+  /**
+   * Number of agent users contained within the subscription. This number will be used to calculate
+   * the amount to pay for additional agent user
+   */
+  totalAgentUsers: number;
+
+  /**
+   * Number of pro users contained within the subscription. This number will be used to calculate
+   * the amount to pay for additional pro user
+   */
+  totalProUsers: number;
+
+  /**
+   * Number of seller users contained within the subscription. This number will be used to calculate
+   * the amount to pay for additional seller user
+   */
+  totalSellerUsers: number;
+
   /**
    * Account mode
    */
@@ -245,6 +269,26 @@ export interface Enterprise extends Resource {
    */
   additionalUserPriceId?: string;
 
+  /**
+   *
+   */
+  additionalAdminPlanId?: string | null;
+
+  /**
+   *
+   */
+  additionalAgentPlanId?: string | null;
+
+  /**
+   *
+   */
+  additionalProPlanId?: string | null;
+
+  /**
+   *
+   */
+  additionalSellerPlanId?: string | null;
+
   /**
    * Subscription on stripe
    */
@@ -268,13 +312,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';
   };
 
   insurance?: string;
@@ -1431,9 +1475,9 @@ export interface Devis extends Resource {
    * Information to save devis PDF
    */
   pdf?: {
-    [DevisPdfType.ENTERPRISE]?: File,
-    [DevisPdfType.PROFESSIONAL]?: File,
-    [DevisPdfType.PROVIDER]?: File,
+    [DevisPdfType.ENTERPRISE]?: File;
+    [DevisPdfType.PROFESSIONAL]?: File;
+    [DevisPdfType.PROVIDER]?: File;
   };
 
   /**
@@ -1670,6 +1714,8 @@ export type BillIssued = Bill & {
     // this value is calculated using adjustments in each element
     adjustments?: number;
   };
+  // used in balance bills to display elements grouped by tva and types (materials, operations)
+  isGrouped?: boolean;
 };
 
 export type Price = {
@@ -1914,7 +1960,7 @@ export enum DocumentsTypeEnum {
 }
 
 export enum EventsTypeEnum {
-  OTHER = 'OTHER',
+  OTHER = 'AUTRE',
   VISIT = 'VISIT',
   DELIVERY = 'DELIVERY',
   CONSTRUCTION = 'CONSTRUCTION',
@@ -2343,6 +2389,7 @@ export enum EmailTemplate {
   NEW_ENTERPRISE = 'new-enterprise',
   USER_CONTACT = 'user-contact',
   PLAN = 'plan',
+  BILL = 'bill',
 }
 
 export enum DevisPdfType {
@@ -2457,36 +2504,43 @@ export interface Category extends Resource {
 
 export enum CategoryEntityEnum {
   MATERIAL = 'MATERIAL',
-  OPERATION = 'OPERATION'
+  OPERATION = 'OPERATION',
 }
 
 export interface OperationCatalog extends Resource {
-  name: string,
-  status: boolean,
+  name: string;
+  status: boolean;
   sectors?: Array<{
-    objectID: string,
-    name: string,
-    value: number
+    objectID: string;
+    name: string;
+    value: number;
   }>;
   description?: string;
-  materialsProvider?: Array<string>,
-  image?: File | null
+  materialsProvider?: Array<string>;
+  image?: File | null;
 }
 
 export interface Nomenclature extends Resource {
-  name: string,
-  status: boolean,
-  identifier: NomenclaturesIdentifier,
-  color?: string
+  value: any;
+  status: boolean;
+  identifier: NomenclaturesIdentifier;
+  color?: string;
+  file?: File;
+  order?: number;
+  activeForPro?: boolean;
+  setProjectDate?: boolean;
 }
 
 export enum NomenclaturesIdentifier {
-  OPERATIONS_SECTOR = "OPERATIONS_SECTOR",
-  OPERATIONS_PIECE = "OPERATIONS_PIECE",
-  OPERATIONS_LOT = "OPERATIONS_LOT",
+  OPERATIONS_SECTOR = 'OPERATIONS_SECTOR',
+  OPERATIONS_PIECE = 'OPERATIONS_PIECE',
+  OPERATIONS_LOT = 'OPERATIONS_LOT',
+  EVENTS_TYPES = 'EVENTS_TYPES',
+  PROJECTS_CATEGORY = 'PROJECTS_CATEGORY',
+  TVA = 'TVA',
+  SUPPLIERS = 'SUPPLIERS',
 }
 
-
 /**
  * New version of operations with more advanced config
  */
@@ -2535,17 +2589,17 @@ export interface OperationV2 extends Resource {
    * Used at the moment of copy catalogs from system-operations to the enterprise
    * to create the relation between operations and system-operations-materials
    */
-  systemId?: string
+  systemId?: string;
 
   /**
-    *
-    */
-  tva?: number | null
+   *
+   */
+  tva?: number | null;
 
   /**
    * Used to create relation between operations and his catalog
    */
-  catalogId: string
+  catalogId: string;
 
   /**
    * Used in operations page to assign categories
@@ -2570,47 +2624,53 @@ export interface OperationV2 extends Resource {
   /**
    * List of rules used to re-calculate the price
    */
-  adjustments?: Array<OperationAdjustment>
+  adjustments?: Array<OperationAdjustment>;
 
-  reserves?: string
+  reserves?: string;
 }
 
 export interface OperationAdjustment {
-  rule: OperationRulesEnum
-  bigger?: number
-  lower?: number
-  equal?: number
-  complement?: string
-  percent: number
+  rule: OperationRulesEnum;
+  bigger?: number;
+  lower?: number;
+  equal?: number;
+  complement?: string;
+  percent: number;
 }
 
 export enum OperationQuantityEnum {
-  NOT_DEFINED = "NOT_DEFINED",
-  PERIMETER = "PERIMETER",
-  GROUND_CEILING_SURFACE = "GROUND_CEILING_SURFACE",
-  WALL_SURFACE = "WALL_SURFACE",
+  NOT_DEFINED = 'NOT_DEFINED',
+  PERIMETER = 'PERIMETER',
+  GROUND_CEILING_SURFACE = 'GROUND_CEILING_SURFACE',
+  WALL_SURFACE = 'WALL_SURFACE',
 }
 
 export enum OperationRulesEnum {
-  BIGGER_THAN = "BIGGER_THAN",
-  LOWER_THAN = "LOWER_THAN",
-  EQUAL_TO = "EQUAL_TO",
-  BETWEEN = "BETWEEN"
+  BIGGER_THAN = 'BIGGER_THAN',
+  LOWER_THAN = 'LOWER_THAN',
+  EQUAL_TO = 'EQUAL_TO',
+  BETWEEN = 'BETWEEN',
 }
 
 export interface OperationV2Material extends Material {
-  quantity: number
-  loss: number
-  rounded: boolean
-  responsible: string
-  fixed: boolean
-  optId: string
+  quantity: number;
+  loss: number;
+  rounded: boolean;
+  responsible: string;
+  fixed: boolean;
+  optId: string;
 }
 
 export enum MaterialResponsible {
-  CLIENT = "CLIENT",
-  PRO = "PRO",
-  AGENT = "AGENT",
-  SELLER = "SELLER",
-  ENTERPRISE = "ENTERPRISE",
+  CLIENT = 'CLIENT',
+  PRO = 'PRO',
+  AGENT = 'AGENT',
+  SELLER = 'SELLER',
+  ENTERPRISE = 'ENTERPRISE',
+}
+
+export enum ProjectPriceTypeEnum {
+  accepted = 'accepted',
+  prospected = 'prospected',
+  rejected = 'rejected',
 }