@silexpert/core 2.0.44 → 2.0.45

package/ts/types/Interface/api/kyc/kyc.ts

@@ -0,0 +1,190 @@
+// import { DocumentType } from './Create.js';
+
+// CONTROL SCHEMA
+
+export interface KycFolder {
+  id: string;
+  title: string;
+  status: KycFolderStatus;
+  expiresOn?: string;
+  metadata: object; // <= 5 items to add metadata to folders (idSociety, idUser maybe ??)
+  createdAt: string;
+  updatedAt: string;
+  _links: object; // list of links relation types
+  _embedded: object;
+}
+
+export type KycFolderStatus =
+  | 'DRAFT'
+  | 'IN_PROGESS'
+  | 'COMPLETED'
+  | 'REJECTED'
+  | 'ACTION_NEEDED'
+  | 'CANCELLED'
+  | 'EXPIRED';
+
+export interface KycControl {
+  id: string;
+  spaceId: string;
+  spaceName: string;
+  controleProfileId: string;
+  controleProfileName: string;
+  subscriberId: string;
+  subscriber: Subscriber;
+  createdAt: string;
+  lastModified: string;
+  completeness: CompleteNess;
+  score: number;
+  status: 'CREATED' | 'DONE';
+  result: ControlResult;
+}
+
+interface Subscriber {
+  id: string;
+  spaceId: string;
+  address: {
+    address: string;
+    city: string;
+    province: string;
+    zipCode: string;
+  } | null;
+  complementaryData: ComplementaryData[];
+  additionalData: AdditionalData[]; // need more info for this type
+  contact: string;
+  siren: string;
+  legalName: string | null;
+  legalForm: string | null;
+  registrationDate: string | null;
+}
+
+interface ComplementaryData {
+  id: number;
+  origin: string;
+  type: 'VALUE' | 'JSON';
+  key: string;
+  jsonableType: 'LIST';
+  data: string | ComplementaryDataDataObject;
+}
+
+interface ComplementaryDataDataObject {
+  objectType: 'LIST';
+  items: ComplementaryDataDataObjectItems[];
+}
+
+interface ComplementaryDataDataObjectItems {
+  objectType: string;
+  profession: string;
+  type: 'PP' | 'PM'; // Personne Physique | Personne Morale
+  legalEntityName?: string;
+  legalEntitySiren?: string;
+  lastName?: string;
+  firstName?: string;
+  birthDate?: string;
+}
+
+interface AdditionalData {
+  valueType: string;
+}
+
+interface CompleteNess {
+  type: string;
+  number: number;
+  side: 'FRONT' | 'BACK' | null;
+  available: boolean;
+  status: 'CHECKED' | null;
+}
+
+interface ControlResult {
+  status: 'OK' | null;
+  score: number;
+  checkResults: ControlCheckResult[];
+  nbPerformedChecks: number;
+  nbConfigurationChecks: number;
+  // the keys below are to be perfected after the tests will be done.
+  // each props equals for a different document. could be only 1 document so one prop. i think 3 is max
+  scores: {
+    additionalProp1: number;
+    additionalProp2: number;
+    additionalProp3: number;
+  };
+  scoresPerDocument: {
+    additionalProp1: {
+      additionalProp1: number;
+      additionalProp2: number;
+      additionalProp3: number;
+    };
+    additionalProp2: {
+      additionalProp1: number;
+      additionalProp2: number;
+      additionalProp3: number;
+    };
+    additionalProp3: {
+      additionalProp1: number;
+      additionalProp2: number;
+      additionalProp3: number;
+    };
+  };
+}
+
+export interface ControlCheckResult {
+  id: number;
+  type: string;
+  name: string;
+  value: string;
+  weight: number;
+  critical: boolean;
+  sources: ControlCheckResultSource[];
+  parameters: ControlCheckResultParameter[];
+  public: boolean;
+}
+
+interface ControlCheckResultSource {
+  type: string; // 'DOCUMENT'
+  documentId: number;
+  documentType: string;
+  number: number;
+  value: string;
+  label: string;
+}
+
+interface ControlCheckResultParameter {
+  name: string;
+  value: string;
+}
+
+// DOCUMENT SCHEMA
+
+export interface KycDocumentWithClassification {
+  id: number;
+  type: DocumentType;
+  subType: string;
+  number: number;
+  status: 'QUEUING' | 'CHECKED';
+  sheets: DocumentWithClassificationSheet[];
+  score: number;
+  // documentValues: {};
+  // dataSourceValues: {}[];
+  images: {
+    id: number;
+    name: string; // FRONT;
+    number: number;
+  }[];
+  origin: string; // REQUESTER
+  createdAt: string;
+  language: 'fr';
+}
+
+interface DocumentWithClassificationSheet {
+  id: number;
+  side: string;
+  filename: string;
+  hash: string;
+  mimetype: string;
+  size: number;
+  subTypes: string[];
+  indentifier: string; // https://app.vialink.fr/drive/api/v1/files/ae6c8745-4c38-4035-a44f-88f7ed43d2ad
+}
+
+// export type KycControlSubTypes = {
+//   [key in DocumentType]: string[];
+// };

package/ts/types/Interface/api/user/RegisterProspect.ts

@@ -17,7 +17,7 @@ import { IAnalyticsUtm } from '../../models/IAnalyticsUtm.js';
 import { LegalFormTypeEnum } from '../../../Enum/LegalForm.js';
 import { UpdateOrCreateVisualizedInformation } from '../visualizedInformation/Update.js';
 import { IPermission } from '../../models/IPermission.js';
-import { SubscriptionType } from '../../../../index.js';
+import { CountryId, FiscalRegime, ProfitsType, SubscriptionType, TaxSystem } from '../../../../index.js';
 
 /**
  * Response of the register prospect endpoint
@@ -54,6 +54,10 @@ export interface ProspectSocietyInfo {
   siret?: string;
   dateInscription?: Date;
   idNafCode?: number;
+  idCountry?: CountryId | null;
+  idFiscalRegime?: FiscalRegime | null;
+  idTaxSystem?: TaxSystem | null;
+  idProfitsType?: ProfitsType | null;
 }
 
 export interface ReferalProgram {

package/ts/types/Interface/models/IEInvoicingKycAndMandate.ts

@@ -0,0 +1,25 @@
+import { ISociety } from './ISociety.js';
+import { IFile } from '../../index.js';
+
+export class IEInvoicingKycAndMandate {
+  id?: number;
+  onboardingFolderId: string;
+  publicFolderUrl: string;
+  eInvoiceAddress: string;
+  mandateRef: string;
+  mandateStatus?: string | null; // COMPLETED | REJECTED
+  onboardingStatus?: string | null; // DRAFT | IN_PROGRESS | COMPLETED | REJECTED | ACTION_NEEDED | EXPIRED | CANCELLED
+  sentToDocoon: boolean;
+  idSociety: number;
+  idMandateFile?: number | null;
+  idKycControlReportFile?: number | null;
+  idKycCaptureReportFile?: number | null;
+  idKycSignatureReportFile?: number | null;
+
+  // associations
+  society?: ISociety;
+  mandate?: IFile;
+  kycControlReport?: IFile;
+  kycCaptureReport?: IFile;
+  kycSignatureReport?: IFile;
+}

package/ts/types/index.ts

@@ -286,6 +286,7 @@ export * from './Interface/models/IRevenueMovement.js';
 export * from './Interface/models/IRevenueSnapshot.js';
 export * from './Interface/models/IEInvoicingEligibilityRequest.js';
 export * from './Interface/models/IUsersHistory.js';
+export * from './Interface/models/IEInvoicingKycAndMandate.js';
 
 // Schemas
 export * from './Interface/schemas/IRegistrationDetail.js';
@@ -1174,3 +1175,6 @@ export * from './Interface/api/docoon/Read.js';
 export * from './Interface/api/authentification/FinalizeMobileApprovalDto.js';
 export * from './Interface/api/formalism/Create.js';
 export * from './Interface/api/authentification/ProviderAuthDto.js';
+export * from './Interface/api/kyc/Create.js';
+export * from './Interface/api/kyc/Read.js';
+export * from './Interface/api/kyc/kyc.js';