@silexpert/core 0.4.176 → 0.4.178

package/ts/types/Interface/api/budgetInsight/Query.ts

@@ -0,0 +1,180 @@
+import { IsEnum, IsString } from 'class-validator';
+import { ApiProperty } from '../../../../utils';
+import { BudgetInsightEvent } from '../../../Enum/BudgetInsight';
+import { ConnectionState } from './Read';
+
+export class QueryHooks {
+  @ApiProperty()
+  @IsString()
+  token: string;
+
+  @ApiProperty()
+  @IsEnum(BudgetInsightEvent)
+  event: BudgetInsightEvent;
+}
+
+type BudgetCurrency = {
+  id: string; // Currency code (ISO 4217).
+  name: string; // Display name of the currency.
+  symbol: string; // Display symbol of the currency.
+  precision: number; // number precision of the currency.
+  prefix: boolean;
+  crypto: boolean;
+};
+
+type BudgetInsightAccountTypeName =
+  'article83' | // Article 83
+  'capitalisation' | // Capitalization contract
+  'card' | // Card
+  'checking' | // Checking account
+  'crowdlending' | // Crowdlending
+  'deposit' | // Deposit account
+  'joint' | // Joint account
+  'lifeinsurance' | // Life insurance account
+  'loan' | // Loan
+  'madelin' | // Madelin retirement contract
+  'market' | // Market account
+  'pea' | // Shared savings plan (Plan d'Epargne en Actions)
+  'pee' | // Company savings plan (Plan d'Epargne Entreprise)
+  'per' | // Retirement savings plan (Plan d'Epargne Retraite)
+  'perco' | // Group retirement savings plan (Plan d'Epargne pour la Retraite Collectif)
+  'perp' | // Popular retirement savings plan (Plan d'Epargne Retraite Populaire)
+  'real_estate' | // Real estate placement
+  'rsp' | // Special profit-sharing reserve (Réserve Spéciale de Participation)
+  'savings' | // Savings account
+  'unknown'; // Unknown account type
+
+type BudgetInsightTransactionType =
+  'transfer' | // Transfer
+  'order' | // Order
+  'check' | // Check
+  'deposit' | // Deposit
+  'payback' | // Payback
+  'withdrawal' | // Withdrawal
+  'loan_payment' | // Loan payment
+  'bank' | // Bank fees
+  'card' | // Card operation
+  'deferred_card' | // Deferred card operation
+  'summary_card' | // Mensual debit of a deferred card
+  'unknown'; // Unknown transaction type
+
+type BudgetInsightBankAccountUsage =
+'PRIV' |// Private account.
+'ORGA' |// Professional account.
+'ASSO'; // Association account.
+
+type BudgetInsightBankAccountOwnerShip =
+  'owner' | // Account holder.
+  'co-owner' | // Holder on a joint account.
+  'attorney'; // Account authorized agent.
+
+type BudgetInsightLoan = {
+  total_amount: number | null; // Total amount of the loan.
+  available_amount: number | null; // Amount of the loan not yet released and still available.
+  used_amount: number | null; // Amount of the load already used.
+  subscription_date: Date | null; // Subscription date of the loan.
+  maturity_date: Date | null; // Estimated end date of the loan.
+  next_payment_amount: number | null; // Amount of the next payment.
+  next_payment_date: Date | null; // Date of the next payment.
+  rate: number | null; // Rate of the loan.
+  nb_payments_left: number | null; // Number of payments still due.
+  nb_payments_done: number | null; // Number of payments done.
+  nb_payments_total: number | null; // Total number of payments.
+  last_payment_amount: Date | null; // Amount of the last payment.
+  last_payment_date: Date | null; // Date of the last payment.
+  account_label: string | null; // Name of the debited account.
+  insurance_label: string | null; // Label of the insurance.
+  duration: number | null; // Duration of the loan, in months.
+  type: string | null; // Type of the loan (mortgage, consumercredit or revolvingcredit).
+};
+
+export type BudgetInsightTransaction = {
+  id: number; // ID of the transaction.
+  id_account: number; // ID of the related account.
+  application_date: Date | null; // Date considered by PFM services. This date can be edited.
+  date: Date; // Date when the transaction is posted to the account.
+  datetime: Date | null; // Date and time when the transaction is posted to the account, if available, in UTC.
+  vdate: Date | null; // Value date of the transaction. In most cases, equivalent to date.
+  vdatetime: Date | null; // Value date and time of the transaction, if available, in UTC. In most cases, equivalent to datetime.
+  rdate: Date; // Date when the transaction order has been given.
+  rdatetime: Date | null; // Date and time when the transaction order has been given, if available, in UTC.
+  bdate: Date | null; // Date displayed by the bank for the transaction.
+  bdatetime: number | null; // Date and time displayed by the bank for the transaction, if available, in UTC.
+  value: number | null; // Value of the transaction.
+  gross_value: number | null; // Gross value of the transaction.
+  type: BudgetInsightTransactionType; // Type of transaction.
+  original_wording: string; // Full label of the transaction, as seen on the bank.
+  simplified_wording: string; // Simplified label of the transaction.
+  wording:string | null; // Label of the transaction, can be edited.
+  id_category: number | null; // ID of the related category.
+  date_scraped: Date; // Date and time when the transaction was seen.
+  coming: boolean; // If true, this transaction has not yet been posted to the account.
+  active: boolean; // If false, PFM services will ignore this transaction.
+  id_cluster: number | null; // If the transaction is part of a cluster.
+  comment:string | null; // User comment.
+  last_update: Date | null; // Last update of the transaction.
+  deleted: number | null; // If set, this transaction has been removed from the bank.
+  original_value: number | null; // Value in the original currency.
+  original_gross_value: number | null; // Gross value in the original currency.
+  original_currency: BudgetCurrency | null; // Original currency.
+  commission: number | null; // Commission taken on the transaction.
+  commission_currency: BudgetCurrency | null; // Commission currency.
+  country:string | null; // Original country.
+  card:string | null; // Card number associated with the transaction.
+};
+
+export type BudgetInsightAccountSyncedQuery = {
+  id: number; // ID of the bank account.
+  id_connection: number | null; // ID of the related connection.
+  id_user: number | null; // ID of the related user.
+  id_source: number | null; // ID of the related connection source.
+  id_parent: number | null; // ID of the parent account.
+  number: string | null; // Account number.
+  original_name: string; // Original name of the account, as seen on the bank.
+  balance: number | null; // Balance of the account.
+  coming: number | null; // Amount of coming operations not yet debited.
+  display: boolean; // Whether the bank account should be presented.
+  last_update: Date | null; // Last successful update of the account.
+  deleted: Date | null; // If set, this account is not found on the website anymore.
+  disabled: Date | null; // If set, this account has been disabled by user and will not be synchronized anymore.
+  iban: string | null; // Account IBAN.
+  currency: BudgetCurrency | null; // Account currency.
+  type: BudgetInsightAccountTypeName; // Technical code of the account type.
+  id_type: number; // ID of the account type.
+  bookmarked: number; // This account has been bookmarked by user.
+  name: string; // The name of the account.
+  error: string | null; // If the last update has failed, the error code.
+  usage: BudgetInsightBankAccountUsage; // Account usage. If not overridden, the value of original_usage is returned.
+  ownership: BudgetInsightBankAccountOwnerShip | null; // Relationship between the credentials owner and the account.
+  company_name: string | null; // Name of the company holding the employee savings of the account.
+  loan: BudgetInsightLoan | null; // For loan accounts, the loan details.
+  transactions: BudgetInsightTransaction[];
+};
+
+type BudgetInsightUser = {
+  id: number;
+  signin: Date;
+  platform: string;
+};
+
+type BudgetInsightConnection = {
+  id: number; // ID of the connection.
+  id_user: number | null; // ID of the related user.
+  id_connector: number; // ID of the related connector.
+  state: ConnectionState | null; // If the last update failed, the state code. The null value indicates a successful sync.
+  error: ConnectionState | null; // (Deprecated) If the last update failed, the state code. The null value indicates a successful sync.
+  error_message: string | null; // If the last update failed, an optional message from the connector to guide the user into recovering from the error.
+  fields: string[]; // of ConnectorField objects For connections in an error state, an optional list of connector fields that must be prompted to the end-user.
+  last_update: Date | null; // Last successful update.
+  created: Date | null; // Creation date of the connection.
+  active: boolean; // Whether this connection is active and will be automatically synced.
+  last_push: Date | null; // Last successful push.
+  expire: Date | null; // Highest value among expiration dates of connection sources.
+  connector_uuid: string; // UUID of the related connector.
+  next_try: Date | null; // Scheduled date of next synchronization.
+};
+
+export type BudgetInsightConnectionSyncedQuery = {
+  user: BudgetInsightUser;
+  connection: BudgetInsightConnection & { connector: any; sources: any; accounts: any; };
+};

package/ts/types/Interface/api/budgetInsight/Read.ts

@@ -0,0 +1,51 @@
+export type ReadAuthorizationCode = {
+  code: string;
+  expiresIn: string;
+  idUser: string;
+};
+
+export type ReadTemporaryCode = {
+  code: string;
+  expiresIn: string;
+};
+
+export type ConnectionState = 'SCARequired' | // An SCA process must be performed to resume the synchronization process.
+'webauthRequired' | // A web-based authentication process is required using the /webauth endpoint.
+'additionalInformationNeeded' | // Additional information is needed to resume synchronization, such as an OTP. Connections in this state have a fields property.
+'decoupled' | // User validation is required on a third-party app or device (ex: digital key).
+'validating' | // User validation is being processed on our side. This state is temporary.
+'actionNeeded' | // An action is needed on the website by the user, synchronization is blocked.
+'passwordExpired' | // The password has expired and needs to be changed by the user before the synchronization can be retried.
+'wrongpass' | // The authentication on website has failed and new credentials must be obtained from the user. Connections in this state have a fields property.
+'rateLimiting' | // The target website or API is temporarily blocking synchronizations due to rate limiting.
+'websiteUnavailable' | // The connector website or API is unavailable.
+'bug' | // An internal error has occurred during the synchronization.
+'notSupported'; // The source is not supported on the connector
+
+export type ReadUserConnection = {
+  id: number;
+  idUser: number;
+  idConnector: number;
+  lastUpdate: Date | null;
+  created: Date;
+  active: boolean,
+  state: ConnectionState | null
+};
+
+export type ReadUserConnectionBudget = {
+  id: number;
+  id_user: number;
+  id_connector: number;
+  last_update: Date | null;
+  created: Date;
+  active: boolean,
+  last_push: null,
+  next_try: Date | null,
+  state: ConnectionState | null;
+  error: null; // TODO:
+  error_message: null; // TODO:
+  expire: null; // TODO:
+  id_provider: number;
+  id_bank: number;
+  connector_uuid: string;
+};

package/ts/types/Interface/api/mail/QueryMail.ts

@@ -0,0 +1,21 @@
+import {
+  IsIn, IsOptional, IsString,
+} from 'class-validator';
+import { ApiPropertyOptional } from '../../../../utils/decorators';
+
+export class QueryMail {
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString({
+    each: true,
+  })
+  @IsIn(['society', 'mailContent', 'mailAttachment'], { each: true })
+  include?: string[];
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString({
+    each: true,
+  })
+  attributes?: string[];
+}

package/ts/types/Interface/api/mail/QueryPaginatedMail.ts

@@ -0,0 +1,45 @@
+import {
+  IsBoolean, IsIn, IsNumber, IsOptional, IsString, IsArray,
+} from 'class-validator';
+import { ApiPropertyOptional } from '../../../../utils';
+import { ToBoolean } from '../../../../utils/transforms/boolean.transform';
+
+export class QueryPaginatedMail {
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString()
+  search?: string;
+
+  @ApiPropertyOptional({ default: false })
+  @IsOptional()
+  @IsBoolean()
+  @ToBoolean()
+  withDeleted? = false;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsArray()
+  @IsString({
+    each: true,
+  })
+  @IsIn(['society', 'mailContent', 'mailAttachment'], { each: true })
+  include?: string[];
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsArray()
+  @IsString({
+    each: true,
+  })
+  attributes?: string[];
+
+  @ApiPropertyOptional({ default: 25 })
+  @IsOptional()
+  @IsNumber()
+  limit?: number;
+
+  @ApiPropertyOptional({ default: 1 })
+  @IsOptional()
+  @IsNumber()
+  page?: number;
+}

package/ts/types/Interface/api/mail/UpdateMail.ts

@@ -0,0 +1,170 @@
+import {
+  IsBoolean, IsOptional, IsString, IsDate, IsInt, IsEnum,
+} from 'class-validator';
+import { ApiPropertyOptional } from '../../../../utils';
+import { ToBoolean } from '../../../../utils/transforms/boolean.transform';
+import { MailFlag } from '../../../Enum/MailFlag';
+import { IMail } from '../../models/IMail';
+
+export class UpdateMail {
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString()
+  messageId?: string;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsDate()
+  date?: Date;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString()
+  subject?: string;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString()
+  fromName?: string;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString()
+  fromAddress?: string;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString()
+  to?: string;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString()
+  cc?: string;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString()
+  bcc?: string;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString()
+  replyTo?: string;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString()
+  inReplyTo?: string;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString()
+  listReferences?: string;
+
+  @ApiPropertyOptional({ description: 'Début du contenu du mail, sans passer par mailContent' })
+  @IsOptional()
+  @IsString()
+  textMini?: string;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsInt()
+  spamScore?: number;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsBoolean()
+  @ToBoolean()
+  isSent?: boolean;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsBoolean()
+  @ToBoolean()
+  isRead?: boolean;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsBoolean()
+  @ToBoolean()
+  isDraft?: boolean;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsBoolean()
+  @ToBoolean()
+  isImportant?: boolean;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsBoolean()
+  @ToBoolean()
+  isFollowed?: boolean;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsInt()
+  idUser?: number;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsInt()
+  idUserWhoAnswered?: number;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsInt()
+  idUserWhoFlagged?: number;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsInt()
+  idRole?: number;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsInt()
+  idExercice?: number;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsInt()
+  idSociety?: number;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsInt()
+  @IsEnum(MailFlag)
+  idFlag?: number;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsInt()
+  idType?: number;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsInt()
+  idMailAuto?: number;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsDate()
+  receiptAcknowledgementAt?: Date;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsDate()
+  processedAt?: Date;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsDate()
+  responseAutoAt?: Date;
+}
+
+export class UpdateMailPayload {
+  @ApiPropertyOptional()
+  mail: Partial<IMail>;
+}

package/ts/types/Interface/api/society/QueryPaginatedSociety.ts

@@ -0,0 +1,28 @@
+import {
+  IsBoolean, IsNumber, IsOptional, IsString,
+} from 'class-validator';
+import { ApiPropertyOptional } from '../../../../utils';
+import { ToBoolean } from '../../../../utils/transforms/boolean.transform';
+
+export class QueryPaginatedSociety {
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString()
+  search?: string;
+
+  @ApiPropertyOptional({ default: false })
+  @IsOptional()
+  @IsBoolean()
+  @ToBoolean()
+  withArchived? = false;
+
+  @ApiPropertyOptional({ default: 25 })
+  @IsOptional()
+  @IsNumber()
+  limit?: number;
+
+  @ApiPropertyOptional({ default: 1 })
+  @IsOptional()
+  @IsNumber()
+  page?: number;
+}

package/ts/types/Interface/models/IBankAccount.ts

@@ -27,6 +27,7 @@ export interface IBankAccount {
   amountStart: number | null;
   isGlobalFetched: boolean;
   dateStart: Date | null;
+  errorCode: string | null;
   idPartnerType: number | null;
   idAccount: number | null;
   idBankList: number | null;

package/ts/types/Interface/models/IBankConnection.ts

@@ -8,9 +8,10 @@ export interface IBankConnection {
   token: string | null;
   refreshToken: string | null;
   expireAt: Date | null;
+  errorCode: string | null;
   idBankList: number | null;
   idSociety: number;
-  idTypeConnection: string | null
+  idTypeConnection: string | null;
   idConnectionExtern: number;
   createdAt?: Date | null;
   updatedAt?: Date | null;

package/ts/types/Interface/models/IMail.ts

@@ -3,6 +3,7 @@ import { IUser } from './IUser';
 import { IExercice } from './IExercice';
 import { IRole } from './IRole';
 import { IMailContent } from './IMailContent';
+import { IMailAttachment } from './IMailAttachment';
 
 // mail
 export interface IMail {
@@ -47,6 +48,7 @@ export interface IMail {
   webmailSender?: IUser;
   role?: IRole;
   exercice?: IExercice;
-  webmailSocieties?: ISociety;
-  mailContent?: IMailContent;
+  society?: ISociety;
+  content?: IMailContent;
+  attachments?: IMailAttachment[];
 }

package/ts/types/index.ts

@@ -398,6 +398,7 @@ export * from './Enum/BalanceSheetStatus';
 export * from './Enum/FuelType';
 export * from './Enum/KilometricAllowanceScale';
 export * from './Enum/VatDeclarationType';
+export * from './Enum/BudgetInsight';
 export * from './Enum/WebmailType';
 export * from './Enum/WebmailFlag';
 export * from './Enum/MailFlag';
@@ -444,8 +445,12 @@ export * from './Interface/api/file/TFile';
 export * from './Interface/api/cerfa/CreateCerfa';
 export * from './Interface/api/cerfa/ReadCerfa';
 export * from './Interface/api/customerProviderOperation/CreateCustomerProviderOperation';
+export * from './Interface/api/mail/QueryMail';
+export * from './Interface/api/mail/QueryPaginatedMail';
+export * from './Interface/api/mail/UpdateMail';
 export * from './Interface/api/society/LegalFormSiren';
 export * from './Interface/api/society/QuerySociety';
+export * from './Interface/api/society/QueryPaginatedSociety';
 export * from './Interface/api/society/GetDataSociety';
 export * from './Interface/api/society/CreateSociety';
 export * from './Interface/api/society/UpdateSociety';
@@ -601,6 +606,9 @@ export * from './Interface/api/exerciceNote/QueryExerciceNote';
 export * from './Interface/api/exerciceNote/CreateExerciceNote';
 export * from './Interface/api/sponsorship/ReadSponsorship';
 export * from './Interface/api/budgetInsight/UpdateBudgetPermanentToken';
+export * from './Interface/api/budgetInsight/Read';
+export * from './Interface/api/budgetInsight/Create';
+export * from './Interface/api/budgetInsight/Query';
 export * from './Interface/api/partneredAccountant/ReadPartneredAccountant';
 export * from './Interface/api/partneredAccountant/QueryPartneredAccountantSocieties';
 export * from './Interface/api/partneredAccountant/ReadPartneredAccountantService';