@placeshakr/config 10.19.0 → 10.19.6-alpha.2

package/src/types.ts

@@ -1,5 +1,3 @@
-// @eslint-ignore
-
 import { SubscriptionSettings } from './plans';
 
 export enum ROLE {
@@ -46,7 +44,8 @@ export type ResourceType =
   | OperationCatalog
   | Nomenclature
   | Operation
-  | OperationV2;
+  | OperationV2
+  | OperationsGroup;
 
 /**
  * Add timestampable behavior to any resource
@@ -176,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
@@ -229,12 +228,6 @@ export interface Enterprise extends Resource {
    */
   default_payment_method?: string;
 
-  /**
-   * Number of users contained within the subscription. This number will be used to calculate
-   * the amount to pay for additional user
-   */
-  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
@@ -312,13 +305,23 @@ 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
+     */
+    coupon?: string;
+
+    /**
+     * Last invoice id on stripe
+     */
+    latestInvoice?: string;
   };
 
   insurance?: string;
@@ -331,22 +334,7 @@ export interface Enterprise extends Resource {
   /**
    *
    */
-  bankInfo?: {
-    /**
-     * IBAN identifier
-     */
-    iban: string;
-
-    /**
-     * BIC identifier
-     */
-    bic: string;
-
-    /**
-     * Account owner name
-     */
-    holder: string;
-  };
+  bankInfo?: BankDetails[];
 
   notificationEstimation?: string[];
 
@@ -364,6 +352,53 @@ export interface Enterprise extends Resource {
    * Geographical area covered, used in bills PDF data
    */
   areaCovered?: string;
+
+  /**
+   * Enterprise currency
+   */
+  currency?: string;
+
+  /**
+   * Statuses workflow between devis status and project status
+   */
+  statusesWorkflow: { devis: DevisStatusEnum; project: string }[];
+
+  contactEmails: Array<{/**
+    * The contact mail
+    */
+    role: string;
+    /**
+     * The contact name
+     */
+    email: string;
+  }>;
+}
+
+export interface BankDetails {
+  /**
+   * bank details selected by default
+   */
+  default: boolean;
+
+  /**
+   * Title identifier
+   */
+  title: string;
+
+  /**
+   * IBAN identifier
+   */
+  iban: string;
+
+  /**
+   * BIC identifier
+   */
+  bic: string;
+
+  /**
+   * Account owner name
+   */
+  holder: string;
 }
 
 /**
@@ -871,7 +906,6 @@ export interface Operation extends Resource {
 export interface Project extends Resource {
   name: string;
   image?: File;
-  type: ProjectTypeEnum;
   category: ProjectCategoriesEnum;
   surface: number;
   address: string;
@@ -893,16 +927,6 @@ export interface Project extends Resource {
    */
   progress?: number;
 
-  /**
-   * Project parent (only for child projects)
-   */
-  parent?: string | Project;
-
-  /**
-   * Children projects (only for compound projects)
-   */
-  children?: (string | Project)[];
-
   /**
    * For whom this project is?
    */
@@ -1193,7 +1217,12 @@ export interface Material extends Resource {
   name: string;
 
   /**
-   * The material unit price
+   * Price without discount
+   */
+  basePrice: number;
+
+  /**
+   * The material unit price with discount
    */
   unitPrice: number;
 
@@ -1247,6 +1276,14 @@ export interface Material extends Resource {
    * Custom reference defined by user
    */
   reference?: string;
+
+  margin?: {
+    id: string;
+    value: number;
+    label: string;
+  };
+
+  supplier?: string;
 }
 
 export interface DevisMaterial extends Material {
@@ -1361,14 +1398,22 @@ export interface DevisOperation extends Resource {
   price: number;
 
   /**
-   * Surface, example: wall, floor
+   * Piece, example: bathroom, kitchen
    */
-  surface: string;
+  piece: string;
 
   /**
-   * Piece, example: bathroom, kitchen
+   * Lot from nomenclature
    */
-  piece: string;
+  lot?: {
+    label: string;
+    color: string;
+  };
+
+  /**
+   * Surface old devis and operations
+   */
+  surface?: string;
 
   /**
    * Unit, example: m2, cm3
@@ -1456,10 +1501,15 @@ export interface Devis extends Resource {
   dateApproved?: number;
 
   /**
-   * Send by email date
+   * Date when email was sent to the project client
    */
   dateSent?: number;
 
+  /**
+   * Email status from Sengrid
+   */
+  emailStatus?: 'processed' | 'dropped' | 'deferred' | 'delivered' | 'open' | 'spamreport'
+
   /**
    * Parent, devis base used to create this one
    */
@@ -1527,6 +1577,37 @@ export interface Devis extends Resource {
     provider: { percent: number; value: number };
     enterprise: { percent: number; value: number };
   };
+
+  /************************************ V2 ************************************/
+  materialsCatalogs?: Array<string>;
+
+  operationsCatalog?: string;
+
+  history?: DevisHistoryItem[];
+
+  systemVersion?: number
+
+  format?: DevisFormatEnum;
+}
+
+export enum DevisHistoryType {
+  CHANGE_STATUS = 'CHANGE_STATUS',
+  SENT_TO_CLIENT = 'SENT_TO_CLIENT',
+  EMAIL_EVENT = 'EMAIL_EVENT',
+  NEW_VERSION = 'NEW_VERSION'
+}
+
+export interface DevisHistoryItem {
+  date: number
+  user?: {
+    id: string,
+    name: string,
+    email: string,
+    role: ROLE
+    photoUrl: string,
+  }
+  type: DevisHistoryType
+  data: any
 }
 
 /**
@@ -1570,9 +1651,13 @@ export interface DevisTemplate extends Resource {
   materialsProvider?: Array<string>;
 
   /**
-   * Used to filter operations
+   * Operations catalog assigned to devis
    */
-  projectType: ProjectTypeEnum;
+  operationsCatalog: string;
+
+  systemVersion?: number;
+
+  format?: DevisFormatEnum;
 }
 
 /**
@@ -2390,6 +2475,7 @@ export enum EmailTemplate {
   USER_CONTACT = 'user-contact',
   PLAN = 'plan',
   BILL = 'bill',
+  MEDIAS = 'medias',
 }
 
 export enum DevisPdfType {
@@ -2436,6 +2522,9 @@ export enum HistoryActionEnum {
   ASSIGN_SELLER = 'ASSIGN_SELLER',
   UNASSIGN_SELLER = 'UNASSIGN_SELLER',
   APPROVED_R_V = 'APPROVED_R_V',
+  DEVIS_APPROVED = 'DEVIS_APPROVED',
+  DEVIS_SENT = 'DEVIS_SENT',
+  DEVIS_SIGNED = 'DEVIS_SIGNED',
 }
 
 export interface History {
@@ -2516,7 +2605,6 @@ export interface OperationCatalog extends Resource {
     value: number;
   }>;
   description?: string;
-  materialsProvider?: Array<string>;
   image?: File | null;
 }
 
@@ -2529,6 +2617,9 @@ export interface Nomenclature extends Resource {
   order?: number;
   activeForPro?: boolean;
   setProjectDate?: boolean;
+  label?: string;
+  text?: string;
+  visibleBy?: ROLE[];
 }
 
 export enum NomenclaturesIdentifier {
@@ -2539,6 +2630,13 @@ export enum NomenclaturesIdentifier {
   PROJECTS_CATEGORY = 'PROJECTS_CATEGORY',
   TVA = 'TVA',
   SUPPLIERS = 'SUPPLIERS',
+  MARGINS = 'MARGINS',
+  TERMS_OF_SALE = 'TERMS_OF_SALE',
+  NOTES_MODELS = 'NOTES_MODELS',
+  DEVIS_TYPES = 'DEVIS_TYPES',
+  COMMENTS_MODELS = 'COMMENTS_MODELS',
+  EMAILS_COMMENTS_MODELS = 'EMAILS_COMMENTS_MODELS',
+  PAYMENT_PLANNING = 'PAYMENT_PLANNING',
 }
 
 /**
@@ -2563,7 +2661,7 @@ export interface OperationV2 extends Resource {
   /**
    * The operation unit price
    */
-  price: number;
+  unitPrice: number;
 
   /**
    * The operation unit
@@ -2659,6 +2757,7 @@ export interface OperationV2Material extends Material {
   responsible: string;
   fixed: boolean;
   optId: string;
+  complement?: string;
 }
 
 export enum MaterialResponsible {
@@ -2667,6 +2766,7 @@ export enum MaterialResponsible {
   AGENT = 'AGENT',
   SELLER = 'SELLER',
   ENTERPRISE = 'ENTERPRISE',
+  PROVIDER = 'PROVIDER',
 }
 
 export enum ProjectPriceTypeEnum {
@@ -2674,3 +2774,18 @@ export enum ProjectPriceTypeEnum {
   prospected = 'prospected',
   rejected = 'rejected',
 }
+
+export enum DevisFormatEnum {
+  PIECE = 'PIECE',
+  LOT = 'LOT',
+}
+
+export interface OperationsGroup extends Resource {
+  name: string;
+  status: boolean;
+  operationsCatalog: string;
+  operations: string[];
+}
+
+export interface DevisVersion extends Devis {
+}