@vulog/aima-business 1.2.39 → 1.2.41

package/src/setInvoiceExternalPayment.ts

@@ -2,13 +2,15 @@ import { Client } from '@vulog/aima-client';
 import { z } from 'zod';
 
 export type SetInvoiceExternalPaymentBody = {
-    paymentReference?: string;
-    paymentDate?: string;
+    requesterId: string;
+    notes?: string;
+    paymentMethod?: string;
 };
 
 const bodySchema = z.object({
-    paymentReference: z.string().trim().min(1).optional(),
-    paymentDate: z.string().trim().min(1).optional(),
+    requesterId: z.string().trim().min(1),
+    notes: z.string().trim().optional(),
+    paymentMethod: z.string().trim().optional(),
 });
 
 export const setInvoiceExternalPayment = async (

package/src/types.ts

@@ -1,51 +1,131 @@
-/** Represents a business entity */
+/** Spring Page response wrapper used by the business API */
+export type SpringPage<T> = {
+    content: T[];
+    totalElements: number;
+    totalPages: number;
+    size: number;
+    number: number;
+    first: boolean;
+    last: boolean;
+    numberOfElements: number;
+    empty: boolean;
+    [key: string]: any;
+};
+
+/** Represents a business entity (BusinessWSDTO) */
 export type Business = {
     /** Unique identifier */
     id: string;
+    /** Fleet identifier */
+    fleetId: string;
     /** Business name */
     name: string;
+    /** Legal name */
+    legalName?: string;
+    /** Phone number */
+    phoneNumber?: string;
+    /** Fax number */
+    faxNumber?: string;
+    /** Email address */
+    email?: string;
+    /** VAT number */
+    vat?: string;
+    /** EIN number */
+    ein?: string;
+    /** Registration URL */
+    registrationUrl?: string;
+    /** Comment */
+    comment?: string;
+    /** Payment type */
+    paymentType?: string;
+    /** Locale */
+    locale?: string;
+    /** Invoice frequency */
+    invoiceFrequency?: string;
     /** Business status */
-    status: string;
+    status?: string;
+    /** Business type */
+    type?: string;
+    /** Entity name */
+    entityName?: string;
+    /** Whether trip notes are mandatory */
+    mandatoryTripNotes?: boolean;
+    /** Whether this is a master entity */
+    masterEntity?: boolean;
+    /** Next iteration date */
+    nextIteration?: string;
+    /** Creation date */
+    creationDate?: string;
+    /** Update date */
+    updateDate?: string;
     [key: string]: any;
 };
 
-/** Represents a contact within a business */
+/** Represents a contact within a business (ContactsDTO) */
 export type BusinessContact = {
     /** Contact identifier */
     id: string;
-    /** Contact name */
-    name: string;
     /** Contact email */
     email: string;
     [key: string]: any;
 };
 
-/** Represents a cost center within a business */
+/** Represents a cost center within a business (CostCenterDTO) */
 export type CostCenter = {
     /** Unique identifier */
     id: string;
     /** Cost center name */
     name: string;
-    /** Parent business identifier */
-    businessId: string;
+    /** Cost center value */
+    value: string;
     [key: string]: any;
 };
 
-/** Represents payment details for a business */
+/** Represents payment details for a business (PaymentBusinessDTO) */
 export type BusinessPaymentDetails = {
+    /** Entity identifier */
+    entityId?: string;
+    /** Fleet identifier */
+    fleetId?: string;
+    /** Holder name */
+    holderName?: string;
+    /** Card type */
+    cardType?: string;
+    /** Card summary (last digits) */
+    cardSummary?: string;
+    /** Expiry date */
+    expiryDate?: string;
     /** Payment method type */
-    paymentMethod: string;
+    paymentMethod?: string;
+    /** Mean of payment status */
+    mopStatus?: string;
+    /** PSP name */
+    pspName?: string;
+    /** IBAN */
+    iban?: string;
     [key: string]: any;
 };
 
-/** Represents a user linked to a business */
+/** Represents a user linked to a business (UserBusinessDTO) */
 export type BusinessUser = {
     /** User identifier */
-    userId: string;
-    /** Business identifier */
-    businessId: string;
-    /** User role within the business */
-    role: string;
+    id: string;
+    /** First name */
+    firstName?: string;
+    /** Last name */
+    lastName?: string;
+    /** Registration date */
+    registrationDate?: string;
+    /** Username */
+    userName?: string;
+    /** Account status */
+    accountStatus?: string;
+    /** Whether user is a delegated admin */
+    delegatedAdmin?: boolean;
+    /** Whether user is a delegated admin (alias) */
+    isDelegatedAdmin?: boolean;
+    /** Full name */
+    fullName?: string;
     [key: string]: any;
 };
 
@@ -95,14 +175,36 @@ export type StripeConfig = {
     [key: string]: any;
 };
 
-/** Represents a business invoice */
+/** Represents a business invoice (InvoiceCumulativeBusinessDTO) */
 export type BusinessInvoice = {
     /** Invoice identifier */
     id: string;
-    /** Invoice amount */
-    amount: number;
+    /** Invoice sequence number */
+    sequence?: number;
+    /** Invoice date */
+    invoiceDate?: string;
+    /** Fleet identifier */
+    fleetId?: string;
+    /** Invoice year */
+    invoiceYear?: number;
     /** Invoice status */
-    status: string;
+    invoicesStatus?: string;
+    /** Invoice amount */
+    amount?: number;
+    /** Currency */
+    currency?: string;
+    /** Entity identifier */
+    entityId?: string;
+    /** Number of payment attempts */
+    attempts?: number;
+    /** PSP name */
+    pspName?: string;
+    /** PSP reference */
+    pspReference?: string;
+    /** Invoice type */
+    type?: string;
+    /** Invoice number */
+    invoiceNumber?: string;
     [key: string]: any;
 };
 
@@ -111,19 +213,39 @@ export type InvoiceRefundNote = {
     [key: string]: any;
 };
 
-/** Represents the refundable amount for an invoice */
+/** Represents the refundable amount for an invoice (InvoiceRefundDTO) */
 export type InvoiceRefundableAmount = {
     /** Invoice identifier */
     invoiceId: string;
+    /** Fleet identifier */
+    fleetId?: string;
     /** Refundable amount */
     refundableAmount: number;
+    /** Currency */
+    currency?: string;
     [key: string]: any;
 };
 
-/** Represents a business trip */
+/** Represents a business trip (OngoingTripDTO) */
 export type BusinessTrip = {
+    /** Identifier */
+    id?: string;
     /** Trip identifier */
-    tripId: string;
+    tripId?: string;
+    /** User identifier */
+    userId?: string;
+    /** Profile identifier */
+    profileId?: string;
+    /** Theoretical start date */
+    theorStartDate?: string;
+    /** Theoretical end date */
+    theorEndDate?: string;
+    /** Name */
+    name?: string;
+    /** Vehicle plate */
+    plate?: string;
+    /** Booking date */
+    booking_date?: string;
     [key: string]: any;
 };
 
@@ -136,12 +258,26 @@ export type TripNote = {
     [key: string]: any;
 };
 
-/** Represents a product in the business context */
+/** Represents a product in the business context (ProductBusinessDTO) */
 export type BusinessProduct = {
     /** Product identifier */
     id: string;
+    /** Fleet identifier */
+    fleetId?: string;
     /** Product name */
     name: string;
+    /** Product type */
+    type?: string;
+    /** Price */
+    price?: number;
+    /** Whether tax is included */
+    taxIncluded?: boolean;
+    /** Expiration date */
+    expirationDate?: string;
+    /** Tax name */
+    taxName?: string;
+    /** Tax rate */
+    taxRate?: number;
     [key: string]: any;
 };
 
@@ -152,8 +288,28 @@ export type InvitationRequest = {
     [key: string]: any;
 };
 
-/** Represents a business wallet */
+/** Represents a business wallet (WalletDTO) */
 export type BusinessWallet = {
+    /** Wallet identifier */
+    id?: string;
+    /** Available amount */
+    availableAmount?: number;
+    /** Initial amount */
+    initialAmount?: number;
+    /** Promo code reference */
+    promoCodeReference?: string;
+    /** Percentage discount */
+    percentage?: number;
+    /** Discount category */
+    discountCategory?: string;
+    /** Wallet type */
+    type?: string;
+    /** Wallet usage */
+    usage?: string;
+    /** Used amount */
+    usedAmount?: number;
+    /** Entity identifier */
+    entityId?: string;
     [key: string]: any;
 };
 

package/src/updateBusiness.ts

@@ -5,11 +5,53 @@ import { Business } from './types';
 
 export type UpdateBusinessBody = {
     name?: string;
+    legalName?: string;
+    phoneNumber?: string;
+    faxNumber?: string;
+    email?: string;
+    vat?: string;
+    ein?: string;
+    registrationUrl?: string;
+    comment?: string;
+    paymentType?: string;
+    locale?: string;
+    invoiceFrequency?: string;
+    status?: string;
+    nationality?: string;
+    pec?: string;
+    legalForm?: string;
+    fiscalCode?: string;
+    taxNumberCountry?: string;
+    communityTaxNumber?: string;
+    sdicemCode?: string;
+    mandatoryTripNotes?: boolean;
+    billingAddress?: {
+        city?: string;
+        country?: string;
+        region?: string;
+        streetName?: string;
+        postalCode?: string;
+    };
+    address?: {
+        city?: string;
+        country?: string;
+        region?: string;
+        streetName?: string;
+        postalCode?: string;
+    };
+    billingGroup?: {
+        id?: string;
+        fleetId?: string;
+        discount?: number;
+        name?: string;
+    };
 };
 
-const updateBusinessBodySchema = z.object({
-    name: z.string().trim().min(1).max(255).optional(),
-});
+const updateBusinessBodySchema = z
+    .object({
+        name: z.string().trim().min(1).max(255).optional(),
+    })
+    .passthrough();
 
 export const updateBusiness = async (
     client: Client,

package/src/updateBusinessCostCenter.ts

@@ -5,12 +5,14 @@ import { CostCenter } from './types';
 
 export type UpdateCostCenterBody = {
     name?: string;
+    value?: string;
 };
 
 const uuidSchema = z.string().trim().min(1).uuid();
 
 const bodySchema = z.object({
     name: z.string().trim().min(1).max(255).optional(),
+    value: z.string().trim().min(1).optional(),
 });
 
 export const updateBusinessCostCenter = async (