npm - @hectare/platform.clients.trading - Versions diffs - 1.1.275 → 1.1.277 - Mend

@hectare/platform.clients.trading 1.1.275 → 1.1.277

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

package/index.d.ts +1 -1
package/models/ContractDetail.d.ts +124 -29
package/models/ContractMovementDetail.d.ts +5 -21
package/models/CreateBid.d.ts +1 -2
package/models/CreateBidOfferSchema.d.ts +1 -2
package/models/CreateContractSchema.d.ts +5 -0
package/models/CropContractSearchSchema.d.ts +33 -0
package/models/PatchBid.d.ts +1 -2
package/models/PatchBidOfferSchema.d.ts +1 -2
package/models/PatchContractMovementSchema.d.ts +3 -1
package/models/PatchContractSchema.d.ts +5 -0
package/models/SearchResultsContractSchema.d.ts +124 -29
package/package.json +1 -1
package/models/PatchBidOption.d.ts +0 -33
/package/models/{PatchBidOption.js → CropContractSearchSchema.js} +0 -0

package/index.d.ts CHANGED Viewed

@@ -17,6 +17,7 @@ export type { CreateInventorySchema } from './models/CreateInventorySchema.js';
 export type { CreateListing } from './models/CreateListing.js';
 export type { CreateMarketingPlanSchema } from './models/CreateMarketingPlanSchema.js';
 export type { CreateWantedAd } from './models/CreateWantedAd.js';
+export type { CropContractSearchSchema } from './models/CropContractSearchSchema.js';
 export type { DeleteMarketingPlanSchema } from './models/DeleteMarketingPlanSchema.js';
 export type { ExFarmPriceCommodity } from './models/ExFarmPriceCommodity.js';
 export type { ExFarmPricesRegionSchema } from './models/ExFarmPricesRegionSchema.js';
@@ -46,7 +47,6 @@ export type { MarketingPlanSummarySchema } from './models/MarketingPlanSummarySc
 export type { NewsFeed } from './models/NewsFeed.js';
 export type { PatchBid } from './models/PatchBid.js';
 export type { PatchBidOfferSchema } from './models/PatchBidOfferSchema.js';
-export type { PatchBidOption } from './models/PatchBidOption.js';
 export type { PatchContractMovementSchema } from './models/PatchContractMovementSchema.js';
 export type { PatchContractSchema } from './models/PatchContractSchema.js';
 export type { PatchInventorySchema } from './models/PatchInventorySchema.js';

package/models/ContractDetail.d.ts CHANGED Viewed

@@ -4,10 +4,10 @@ export type ContractDetail = {
     details: {
         bidId: string | null;
         bidOptionId: number | null;
-        userId: string;
         listingId: string | null;
         inventoryId: string;
         reference: string | null;
+        cropHome: string | null;
         totalWeight: {
             name: string;
             conversion: number;
@@ -46,6 +46,7 @@ export type ContractDetail = {
             } | null;
         };
         paymentDays: number;
+        paymentDayType?: 'fixed' | 'dayOfMonth' | null;
         haulageType: 'ex-farm' | 'delivered' | 'both' | null;
         contractDateUTC: string;
         movement: {
@@ -119,47 +120,141 @@ export type ContractDetail = {
     buyer: {
         organisationId: string;
         businessId: string;
-        userId?: string;
+        userId: string | null;
         organisationName: string;
         businessName: string | null;
-        userName?: string | null;
+        userName: string | null;
+        email: string | null;
+        phone: {
+            callingCode: string;
+            number: string;
+        } | null;
+        businessLocation: {
+            what3words: string | null;
+            address: {
+                name?: string | null;
+                line1: string;
+                line2?: string | null;
+                line3?: string | null;
+                city?: string | null;
+                region?: string | null;
+                regionISO?: string | null;
+                postcode: string;
+                countryName?: string | null;
+                countryISO: 'GB' | 'US' | 'ZA' | 'FR';
+            };
+            coordinates: {
+                lat: number;
+                lon: number;
+            } | null;
+        } | null;
+        deliveryLocation: {
+            what3words: string | null;
+            address: {
+                name?: string | null;
+                line1: string;
+                line2?: string | null;
+                line3?: string | null;
+                city?: string | null;
+                region?: string | null;
+                regionISO?: string | null;
+                postcode: string;
+                countryName?: string | null;
+                countryISO: 'GB' | 'US' | 'ZA' | 'FR';
+            };
+            coordinates: {
+                lat: number;
+                lon: number;
+            } | null;
+        } | null;
+        companyNumber: string | null;
+        vatNumber: string | null;
+        bio: string | null;
     };
     seller: {
         organisationId: string;
         businessId: string;
-        userId?: string;
+        userId: string | null;
         organisationName: string;
         businessName: string | null;
-        userName?: string | null;
+        userName: string | null;
+        email: string | null;
+        phone: {
+            callingCode: string;
+            number: string;
+        } | null;
+        businessLocation: {
+            what3words: string | null;
+            address: {
+                name?: string | null;
+                line1: string;
+                line2?: string | null;
+                line3?: string | null;
+                city?: string | null;
+                region?: string | null;
+                regionISO?: string | null;
+                postcode: string;
+                countryName?: string | null;
+                countryISO: 'GB' | 'US' | 'ZA' | 'FR';
+            };
+            coordinates: {
+                lat: number;
+                lon: number;
+            } | null;
+        } | null;
+        collectionLocation: {
+            id: number | null;
+            reference: string | null;
+            location: {
+                what3words: string | null;
+                address: {
+                    name?: string | null;
+                    line1: string;
+                    line2?: string | null;
+                    line3?: string | null;
+                    city?: string | null;
+                    region?: string | null;
+                    regionISO?: string | null;
+                    postcode: string;
+                    countryName?: string | null;
+                    countryISO: 'GB' | 'US' | 'ZA' | 'FR';
+                };
+                coordinates: {
+                    lat: number;
+                    lon: number;
+                } | null;
+            } | null;
+            email?: string | null;
+            givenName: string | null;
+            familyName: string | null;
+            phone: {
+                callingCode: string;
+                number: string;
+            };
+            type: 'collection' | 'business' | 'delivery';
+        };
+        assurance: {
+            id: string | null;
+            key?: string | null;
+            body: 'RT' | 'SQC';
+            name?: string | null;
+            location?: string | null;
+        } | null;
     };
-    buyerNotes?: string;
-    sellerNotes?: string;
-    regionISO: string;
+    notes?: {
+        listingBuyer: string | null;
+        bidSeller: string | null;
+        acceptedBidBuyer: string | null;
+    } | null;
     saleType: 'on-platform' | 'off-platform';
     movements: Array<{
         id: number;
         weight: number;
-        paymentDueDate: string | null;
-        status: 'pending' | 'delivered' | 'cancelled';
-        pod: {
-            deliveredOnUTC: string | null;
-            vehicleRegistration: string | null;
-            ticketNumber: string | null;
-            uploadedBy: {
-                id: string | null;
-                name: string | null;
-            };
-            files: Array<{
-                name?: string;
-                id: string;
-                url?: string | null;
-                userId?: string | null;
-                userName?: string | null;
-                organisationId?: string | null;
-                createdAtUTC?: string | null;
-            } | null>;
-            weightNet: number | null;
-        } | null;
+        weightNet: number | null;
+        status: 'pending' | 'complete' | 'cancelled';
+        paymentDueUTC: string | null;
+        deliveredOnUTC: string | null;
+        paymentReceivedUTC: string | null;
     }>;
     payments: Array<{
         id: number;

package/models/ContractMovementDetail.d.ts CHANGED Viewed

@@ -1,25 +1,9 @@
 export type ContractMovementDetail = {
     id: number;
     weight: number;
-    paymentDueDate: string | null;
-    status: 'pending' | 'delivered' | 'cancelled';
-    pod: {
-        deliveredOnUTC: string | null;
-        vehicleRegistration: string | null;
-        ticketNumber: string | null;
-        uploadedBy: {
-            id: string | null;
-            name: string | null;
-        };
-        files: Array<{
-            name?: string;
-            id: string;
-            url?: string | null;
-            userId?: string | null;
-            userName?: string | null;
-            organisationId?: string | null;
-            createdAtUTC?: string | null;
-        } | null>;
-        weightNet: number | null;
-    } | null;
+    weightNet: number | null;
+    status: 'pending' | 'complete' | 'cancelled';
+    paymentDueUTC: string | null;
+    deliveredOnUTC: string | null;
+    paymentReceivedUTC: string | null;
 };

package/models/CreateBid.d.ts CHANGED Viewed

@@ -29,8 +29,7 @@ export type CreateBid = {
             } | null;
         };
         movement: {
-            month?: string;
-            months?: Array<string>;
+            months: Array<string>;
             asAvailable: boolean | null;
         };
         haulageType: 'ex-farm' | 'delivered' | null;

package/models/CreateBidOfferSchema.d.ts CHANGED Viewed

@@ -26,8 +26,7 @@ export type CreateBidOfferSchema = {
         } | null;
     };
     movement: {
-        month?: string;
-        months?: Array<string>;
+        months: Array<string>;
         asAvailable: boolean | null;
     };
     haulageType: 'ex-farm' | 'delivered' | null;

package/models/CreateContractSchema.d.ts CHANGED Viewed

@@ -6,6 +6,7 @@ export type CreateContractSchema = {
         contractType?: 'base' | 'fixed' | 'premium-only' | 'unpriced' | 'premium' | 'base-plus-oil-bonus' | null;
         compositionType?: 'individual' | 'multiple' | 'other';
         paymentDays?: number;
+        paymentDayType?: 'fixed' | 'dayOfMonth' | null;
         haulageType?: 'ex-farm' | 'delivered' | null;
         contractDateUTC?: string | null;
         movement?: {
@@ -16,6 +17,10 @@ export type CreateContractSchema = {
             month: string;
             weightKG: number;
             asAvailable: boolean;
+            totalPrice?: {
+                amount: number | null;
+                currency: string;
+            } | null;
         }>;
         files?: Array<{
             name?: string;

package/models/CropContractSearchSchema.d.ts ADDED Viewed

@@ -0,0 +1,33 @@
+export type CropContractSearchSchema = {
+    docs?: Array<{
+        id: string;
+        reference?: string | null;
+        contractDateUTC: string;
+        saleType: 'on-platform' | 'off-platform';
+        buyer: {
+            organisationName: string;
+        };
+        variety?: string | null;
+        haulageType?: 'ex-farm' | 'delivered' | 'both' | null;
+        movement?: string | null;
+        collection?: string | null;
+        movements: {
+            paid: number;
+            pending: number;
+            moved: number;
+        };
+        totalPrice?: {
+            amount: number | null;
+            currency: string;
+        } | null;
+        pricePerUnit?: {
+            amount: number | null;
+            currency: string;
+        } | null;
+        soldWeight?: number;
+        paymentDays?: number | null;
+    }>;
+    totalDocs?: number;
+    limit?: number;
+    offset?: number;
+};

package/models/PatchBid.d.ts CHANGED Viewed

@@ -29,8 +29,7 @@ export type PatchBid = {
             } | null;
         };
         movement: {
-            month?: string;
-            months?: Array<string>;
+            months: Array<string>;
             asAvailable: boolean | null;
         };
         haulageType: 'ex-farm' | 'delivered' | null;

package/models/PatchBidOfferSchema.d.ts CHANGED Viewed

@@ -26,8 +26,7 @@ export type PatchBidOfferSchema = {
         } | null;
     };
     movement: {
-        month?: string;
-        months?: Array<string>;
+        months: Array<string>;
         asAvailable: boolean | null;
     };
     haulageType: 'ex-farm' | 'delivered' | null;

package/models/PatchContractMovementSchema.d.ts CHANGED Viewed

@@ -1,4 +1,6 @@
 export type PatchContractMovementSchema = {
-    status?: 'pending' | 'delivered' | 'cancelled';
+    status?: 'pending' | 'complete' | 'cancelled';
     weight?: number;
+    isMoved?: boolean;
+    isPaid?: boolean;
 };

package/models/PatchContractSchema.d.ts CHANGED Viewed

@@ -5,6 +5,7 @@ export type PatchContractSchema = {
         contractType?: 'base' | 'fixed' | 'premium-only' | 'unpriced' | 'premium' | 'base-plus-oil-bonus' | null;
         compositionType?: 'individual' | 'multiple' | 'other';
         paymentDays?: number;
+        paymentDayType?: 'fixed' | 'dayOfMonth' | null;
         haulageType?: 'ex-farm' | 'delivered' | null;
         contractDateUTC?: string | null;
         movement?: {
@@ -15,6 +16,10 @@ export type PatchContractSchema = {
             month: string;
             weightKG: number;
             asAvailable: boolean;
+            totalPrice?: {
+                amount: number | null;
+                currency: string;
+            } | null;
         }>;
         files?: Array<{
             name?: string;

package/models/SearchResultsContractSchema.d.ts CHANGED Viewed

@@ -5,10 +5,10 @@ export type SearchResultsContractSchema = {
         details: {
             bidId: string | null;
             bidOptionId: number | null;
-            userId: string;
             listingId: string | null;
             inventoryId: string;
             reference: string | null;
+            cropHome: string | null;
             totalWeight: {
                 name: string;
                 conversion: number;
@@ -47,6 +47,7 @@ export type SearchResultsContractSchema = {
                 } | null;
             };
             paymentDays: number;
+            paymentDayType?: 'fixed' | 'dayOfMonth' | null;
             haulageType: 'ex-farm' | 'delivered' | 'both' | null;
             contractDateUTC: string;
             movement: {
@@ -120,47 +121,141 @@ export type SearchResultsContractSchema = {
         buyer: {
             organisationId: string;
             businessId: string;
-            userId?: string;
+            userId: string | null;
             organisationName: string;
             businessName: string | null;
-            userName?: string | null;
+            userName: string | null;
+            email: string | null;
+            phone: {
+                callingCode: string;
+                number: string;
+            } | null;
+            businessLocation: {
+                what3words: string | null;
+                address: {
+                    name?: string | null;
+                    line1: string;
+                    line2?: string | null;
+                    line3?: string | null;
+                    city?: string | null;
+                    region?: string | null;
+                    regionISO?: string | null;
+                    postcode: string;
+                    countryName?: string | null;
+                    countryISO: 'GB' | 'US' | 'ZA' | 'FR';
+                };
+                coordinates: {
+                    lat: number;
+                    lon: number;
+                } | null;
+            } | null;
+            deliveryLocation: {
+                what3words: string | null;
+                address: {
+                    name?: string | null;
+                    line1: string;
+                    line2?: string | null;
+                    line3?: string | null;
+                    city?: string | null;
+                    region?: string | null;
+                    regionISO?: string | null;
+                    postcode: string;
+                    countryName?: string | null;
+                    countryISO: 'GB' | 'US' | 'ZA' | 'FR';
+                };
+                coordinates: {
+                    lat: number;
+                    lon: number;
+                } | null;
+            } | null;
+            companyNumber: string | null;
+            vatNumber: string | null;
+            bio: string | null;
         };
         seller: {
             organisationId: string;
             businessId: string;
-            userId?: string;
+            userId: string | null;
             organisationName: string;
             businessName: string | null;
-            userName?: string | null;
+            userName: string | null;
+            email: string | null;
+            phone: {
+                callingCode: string;
+                number: string;
+            } | null;
+            businessLocation: {
+                what3words: string | null;
+                address: {
+                    name?: string | null;
+                    line1: string;
+                    line2?: string | null;
+                    line3?: string | null;
+                    city?: string | null;
+                    region?: string | null;
+                    regionISO?: string | null;
+                    postcode: string;
+                    countryName?: string | null;
+                    countryISO: 'GB' | 'US' | 'ZA' | 'FR';
+                };
+                coordinates: {
+                    lat: number;
+                    lon: number;
+                } | null;
+            } | null;
+            collectionLocation: {
+                id: number | null;
+                reference: string | null;
+                location: {
+                    what3words: string | null;
+                    address: {
+                        name?: string | null;
+                        line1: string;
+                        line2?: string | null;
+                        line3?: string | null;
+                        city?: string | null;
+                        region?: string | null;
+                        regionISO?: string | null;
+                        postcode: string;
+                        countryName?: string | null;
+                        countryISO: 'GB' | 'US' | 'ZA' | 'FR';
+                    };
+                    coordinates: {
+                        lat: number;
+                        lon: number;
+                    } | null;
+                } | null;
+                email?: string | null;
+                givenName: string | null;
+                familyName: string | null;
+                phone: {
+                    callingCode: string;
+                    number: string;
+                };
+                type: 'collection' | 'business' | 'delivery';
+            };
+            assurance: {
+                id: string | null;
+                key?: string | null;
+                body: 'RT' | 'SQC';
+                name?: string | null;
+                location?: string | null;
+            } | null;
         };
-        buyerNotes?: string;
-        sellerNotes?: string;
-        regionISO: string;
+        notes?: {
+            listingBuyer: string | null;
+            bidSeller: string | null;
+            acceptedBidBuyer: string | null;
+        } | null;
         saleType: 'on-platform' | 'off-platform';
         movements: Array<{
             id: number;
             weight: number;
-            paymentDueDate: string | null;
-            status: 'pending' | 'delivered' | 'cancelled';
-            pod: {
-                deliveredOnUTC: string | null;
-                vehicleRegistration: string | null;
-                ticketNumber: string | null;
-                uploadedBy: {
-                    id: string | null;
-                    name: string | null;
-                };
-                files: Array<{
-                    name?: string;
-                    id: string;
-                    url?: string | null;
-                    userId?: string | null;
-                    userName?: string | null;
-                    organisationId?: string | null;
-                    createdAtUTC?: string | null;
-                } | null>;
-                weightNet: number | null;
-            } | null;
+            weightNet: number | null;
+            status: 'pending' | 'complete' | 'cancelled';
+            paymentDueUTC: string | null;
+            deliveredOnUTC: string | null;
+            paymentReceivedUTC: string | null;
         }>;
         payments: Array<{
             id: number;

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@hectare/platform.clients.trading",
-  "version": "1.1.275",
+  "version": "1.1.277",
   "main": "index.js",
   "exported": true,
   "types": "index.d.ts",

package/models/PatchBidOption.d.ts DELETED Viewed

@@ -1,33 +0,0 @@
-export type PatchBidOption = {
-    id: number | null;
-    movement?: {
-        months: Array<string>;
-        asAvailable: boolean | null;
-    };
-    pricePerUnit?: {
-        amount: number | null;
-        currency: string;
-    } | null;
-    pricing?: {
-        exFarm: {
-            amount: number | null;
-            currency: string;
-        } | null;
-        delivered: {
-            amount: number | null;
-            currency: string;
-        } | null;
-        min: {
-            amount: number | null;
-            currency: string;
-        } | null;
-        max: {
-            amount: number | null;
-            currency: string;
-        } | null;
-        fixedPremium: {
-            amount: number | null;
-            currency: string;
-        } | null;
-    };
-};

/package/models/{PatchBidOption.js → CropContractSearchSchema.js} RENAMED Viewed

File without changes