@hectare/platform.clients.trading 1.1.240 → 1.1.242

package/index.d.ts

@@ -1,17 +1,14 @@
 export type { AcceptBid } from './models/AcceptBid.js';
 export type { AskAnExpertBuyerRallyReportSchema } from './models/AskAnExpertBuyerRallyReportSchema.js';
-export type { BidAlerts } from './models/BidAlerts.js';
 export type { BidContract } from './models/BidContract.js';
 export type { BidDetail } from './models/BidDetail.js';
 export type { CloseListingReasonSchema } from './models/CloseListingReasonSchema.js';
 export type { CommodityPrices } from './models/CommodityPrices.js';
 export type { CompleteMarketingPlanSchema } from './models/CompleteMarketingPlanSchema.js';
-export type { ContractDeliverySchema } from './models/ContractDeliverySchema.js';
-export type { ContractDeliverySettlementDeductionSchema } from './models/ContractDeliverySettlementDeductionSchema.js';
-export type { ContractDeliverySettlementSchema } from './models/ContractDeliverySettlementSchema.js';
 export type { ContractDetail } from './models/ContractDetail.js';
 export type { CreateBid } from './models/CreateBid.js';
 export type { CreateBidOfferSchema } from './models/CreateBidOfferSchema.js';
+export type { CreateContractSchema } from './models/CreateContractSchema.js';
 export type { CreateInventorySchema } from './models/CreateInventorySchema.js';
 export type { CreateListing } from './models/CreateListing.js';
 export type { CreateMarketingPlanSchema } from './models/CreateMarketingPlanSchema.js';
@@ -50,6 +47,7 @@ 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 { PatchInventorySchema } from './models/PatchInventorySchema.js';
 export type { PatchListingAdjustTradeSchema } from './models/PatchListingAdjustTradeSchema.js';
 export type { PatchListingSchema } from './models/PatchListingSchema.js';
 export type { PatchListingSubstatusSchema } from './models/PatchListingSubstatusSchema.js';

package/models/BidDetail.d.ts

@@ -15,8 +15,10 @@ export type BidDetail = {
             organisationName: string;
             organisationLogo: string;
             organisationVetted: boolean;
-            businessUnitId: string;
-            businessUnitName: string;
+            businessId: string;
+            businessName: string;
+            businessUnitId?: string;
+            businessUnitName?: string;
             businessCollectionAddressId: number | null;
             businessCollectionAddress: {
                 id: number | null;
@@ -90,17 +92,6 @@ export type BidDetail = {
             endDateUTC: string | null;
             reviewEndDateUTC: string | null;
             postReviewEndDateUTC: string | null;
-            price: {
-                amount: number;
-                currency: string;
-            } | null;
-            movementPeriod: {
-                startDateUTC: string;
-                endDateUTC: string;
-                type: 'date' | 'month';
-                excludedDatesUTC?: Array<string> | null;
-                asAvailable?: boolean | null;
-            };
             movement: {
                 months: Array<string>;
                 asAvailable: boolean | null;
@@ -119,25 +110,11 @@ export type BidDetail = {
                 amount: number;
                 currency: string;
             } | null;
-            guidePrice: {
-                amount: number;
-                currency: string;
-            } | null;
-            guidePriceMin: {
-                amount: number;
-                currency: string;
-            } | null;
-            guidePriceMax: {
-                amount: number;
-                currency: string;
-            } | null;
-            isBasePremOnly?: boolean;
             contractType: 'base' | 'fixed' | 'unpriced' | 'premium' | 'base-plus-oil-bonus';
             haulageType: 'ex-farm' | 'delivered' | 'both' | null;
             haulageTypeTASCC?: boolean | null;
         };
         inventory: {
-            id?: string;
             type: 'crop' | 'produce';
             harvestYear: string;
             commodity: {
@@ -153,7 +130,6 @@ export type BidDetail = {
                     id: number;
                     name: string;
                 };
-                variety?: string;
                 varieties: Array<string>;
                 attributes: Array<{
                     id: number;
@@ -166,6 +142,27 @@ export type BidDetail = {
                     weight?: number;
                 };
             };
+            measures: Array<{
+                specification: {
+                    id: number;
+                    name: string;
+                    unit: string;
+                };
+                min: number | null;
+                max: number | null;
+            }> | null;
+            hasSampled: boolean;
+            customMeasures: boolean | null;
+            files?: Array<{
+                name?: string;
+                id: string;
+                url?: string | null;
+                userId?: string | null;
+                userName?: string | null;
+                organisationId?: string | null;
+                createdAtUTC?: string | null;
+            } | null>;
+            id?: string;
             weight: {
                 min: {
                     name: string;
@@ -178,17 +175,6 @@ export type BidDetail = {
                     weight?: number;
                 };
             };
-            measures: Array<{
-                specification: {
-                    id: number;
-                    name: string;
-                    unit: string;
-                };
-                min: number | null;
-                max: number | null;
-            }> | null;
-            hasSampled: boolean | null;
-            customMeasures: boolean | null;
         };
         activeBids: number;
         bidInfo: {
@@ -283,23 +269,13 @@ export type BidDetail = {
         vatNumber?: string | null;
     };
     userId: string;
-    userFullName?: string;
     organisationId?: string;
-    organisationCreatedAtUTC?: string;
-    organisationName?: string;
-    organisationLogo?: string;
-    organisationVetted?: boolean;
     createdAtUTC: string;
     status: 'active' | 'accepted' | 'withdrawn' | 'expired' | 'expiredOffered' | 'expiredOfferDeclined' | 'closed';
     expiresAtUTC: string;
     options: Array<{
         id: number;
         status: 'active' | 'accepted' | 'inactive';
-        movementPeriod: {
-            startDateUTC: string;
-            endDateUTC: string;
-            type: 'date' | 'month';
-        };
         movement: {
             months: Array<string>;
             asAvailable: boolean | null;

package/models/ContractDetail.d.ts

@@ -1,13 +1,13 @@
 export type ContractDetail = {
     id: string;
     createdAtUTC: string;
-    status: 'pending' | 'in-progress' | 'complete' | 'awaiting-payment' | 'cancelled';
     details: {
-        bidId: string;
-        bidOptionId: number;
+        bidId: string | null;
+        bidOptionId: number | null;
         userId: string;
         listingId: string | null;
-        reference: string;
+        inventoryId: string;
+        reference: string | null;
         totalWeight: {
             name: string;
             conversion: number;
@@ -40,7 +40,7 @@ export type ContractDetail = {
         } | null>;
         terms: string | null;
     };
-    inventory: {
+    crop: {
         type: 'crop' | 'produce';
         harvestYear: string;
         commodity: {
@@ -56,7 +56,6 @@ export type ContractDetail = {
                 id: number;
                 name: string;
             };
-            variety?: string;
             varieties: Array<string>;
             attributes: Array<{
                 id: number;
@@ -77,27 +76,88 @@ export type ContractDetail = {
             };
             min: number | null;
             max: number | null;
-        }>;
+        }> | null;
+        hasSampled: boolean;
+        customMeasures?: boolean | null;
+        files: Array<{
+            name?: string;
+            id: string;
+            url?: string | null;
+            userId?: string | null;
+            userName?: string | null;
+            organisationId?: string | null;
+            createdAtUTC?: string | null;
+        } | null>;
+    };
+    inventory?: {
+        type: 'crop' | 'produce';
+        harvestYear: string;
+        commodity: {
+            commodity: {
+                id: number;
+                name: string;
+            };
+            type: {
+                id: number;
+                name: string;
+            };
+            grade: {
+                id: number;
+                name: string;
+            };
+            varieties: Array<string>;
+            attributes: Array<{
+                id: number;
+                name: string;
+            }>;
+            tags?: Array<number>;
+            weight: {
+                name: string;
+                conversion: number;
+                weight?: number;
+            };
+        };
+        measures: Array<{
+            specification: {
+                id: number;
+                name: string;
+                unit: string;
+            };
+            min: number | null;
+            max: number | null;
+        }> | null;
+        hasSampled: boolean;
+        customMeasures?: boolean | null;
+        files: Array<{
+            name?: string;
+            id: string;
+            url?: string | null;
+            userId?: string | null;
+            userName?: string | null;
+            organisationId?: string | null;
+            createdAtUTC?: string | null;
+        } | null>;
     };
     buyer: {
         organisationId: string;
         businessId: string;
+        userId?: string;
         organisationName: string;
-        businessName: string;
-        userId: string;
-        userName: string;
+        businessName: string | null;
+        userName?: string | null;
     };
     seller: {
         organisationId: string;
         businessId: string;
+        userId?: string;
         organisationName: string;
-        businessName: string;
-        userId: string;
-        userName: string;
+        businessName: string | null;
+        userName?: string | null;
     };
-    sellerNotes: string;
-    buyerNotes: string;
+    buyerNotes?: string;
+    sellerNotes?: string;
     regionISO: string;
+    saleType: 'on-platform' | 'off-platform';
     bid?: {
         id: string;
         listingId: string;
@@ -115,8 +175,10 @@ export type ContractDetail = {
                 organisationName: string;
                 organisationLogo: string;
                 organisationVetted: boolean;
-                businessUnitId: string;
-                businessUnitName: string;
+                businessId: string;
+                businessName: string;
+                businessUnitId?: string;
+                businessUnitName?: string;
                 businessCollectionAddressId: number | null;
                 businessCollectionAddress: {
                     id: number | null;
@@ -190,17 +252,6 @@ export type ContractDetail = {
                 endDateUTC: string | null;
                 reviewEndDateUTC: string | null;
                 postReviewEndDateUTC: string | null;
-                price: {
-                    amount: number;
-                    currency: string;
-                } | null;
-                movementPeriod: {
-                    startDateUTC: string;
-                    endDateUTC: string;
-                    type: 'date' | 'month';
-                    excludedDatesUTC?: Array<string> | null;
-                    asAvailable?: boolean | null;
-                };
                 movement: {
                     months: Array<string>;
                     asAvailable: boolean | null;
@@ -219,25 +270,11 @@ export type ContractDetail = {
                     amount: number;
                     currency: string;
                 } | null;
-                guidePrice: {
-                    amount: number;
-                    currency: string;
-                } | null;
-                guidePriceMin: {
-                    amount: number;
-                    currency: string;
-                } | null;
-                guidePriceMax: {
-                    amount: number;
-                    currency: string;
-                } | null;
-                isBasePremOnly?: boolean;
                 contractType: 'base' | 'fixed' | 'unpriced' | 'premium' | 'base-plus-oil-bonus';
                 haulageType: 'ex-farm' | 'delivered' | 'both' | null;
                 haulageTypeTASCC?: boolean | null;
             };
             inventory: {
-                id?: string;
                 type: 'crop' | 'produce';
                 harvestYear: string;
                 commodity: {
@@ -253,7 +290,6 @@ export type ContractDetail = {
                         id: number;
                         name: string;
                     };
-                    variety?: string;
                     varieties: Array<string>;
                     attributes: Array<{
                         id: number;
@@ -266,6 +302,27 @@ export type ContractDetail = {
                         weight?: number;
                     };
                 };
+                measures: Array<{
+                    specification: {
+                        id: number;
+                        name: string;
+                        unit: string;
+                    };
+                    min: number | null;
+                    max: number | null;
+                }> | null;
+                hasSampled: boolean;
+                customMeasures: boolean | null;
+                files?: Array<{
+                    name?: string;
+                    id: string;
+                    url?: string | null;
+                    userId?: string | null;
+                    userName?: string | null;
+                    organisationId?: string | null;
+                    createdAtUTC?: string | null;
+                } | null>;
+                id?: string;
                 weight: {
                     min: {
                         name: string;
@@ -278,17 +335,6 @@ export type ContractDetail = {
                         weight?: number;
                     };
                 };
-                measures: Array<{
-                    specification: {
-                        id: number;
-                        name: string;
-                        unit: string;
-                    };
-                    min: number | null;
-                    max: number | null;
-                }> | null;
-                hasSampled: boolean | null;
-                customMeasures: boolean | null;
             };
             activeBids: number;
             bidInfo: {
@@ -383,23 +429,13 @@ export type ContractDetail = {
             vatNumber?: string | null;
         };
         userId: string;
-        userFullName?: string;
         organisationId?: string;
-        organisationCreatedAtUTC?: string;
-        organisationName?: string;
-        organisationLogo?: string;
-        organisationVetted?: boolean;
         createdAtUTC: string;
         status: 'active' | 'accepted' | 'withdrawn' | 'expired' | 'expiredOffered' | 'expiredOfferDeclined' | 'closed';
         expiresAtUTC: string;
         options: Array<{
             id: number;
             status: 'active' | 'accepted' | 'inactive';
-            movementPeriod: {
-                startDateUTC: string;
-                endDateUTC: string;
-                type: 'date' | 'month';
-            };
             movement: {
                 months: Array<string>;
                 asAvailable: boolean | null;

package/models/CreateBid.d.ts

@@ -1,26 +1,7 @@
 export type CreateBid = {
     listingId: string;
-    businessId?: string | null;
-    expiresAtUTC?: string;
-    options?: Array<{
-        movementPeriod?: {
-            startDateUTC: string;
-            endDateUTC: string;
-            type: 'date' | 'month';
-            excludedDatesUTC?: Array<string> | null;
-            asAvailable?: boolean | null;
-        };
-        movement?: {
-            months: Array<string>;
-            asAvailable: boolean | null;
-        };
-        pricePerUnit: {
-            amount: number;
-            currency: string;
-        };
-        haulageType?: 'ex-farm' | 'delivered';
-    }>;
-    offers?: Array<{
+    businessId: string;
+    offers: Array<{
         price: {
             amount: number;
             currency: string;
@@ -39,7 +20,6 @@ export type CreateBid = {
         paymentDays: number;
         paymentDayType?: 'fixed' | 'dayOfMonth' | null;
         paymentType: 'base' | 'fixed' | 'unpriced' | 'premium' | 'base-plus-oil-bonus';
-        haulageType?: 'ex-farm' | 'delivered';
         deliveryPostcode?: string | null;
         cropHome?: string | null;
         sellerNotes?: string | null;

package/models/CreateContractSchema.d.ts

@@ -0,0 +1,32 @@
+export type CreateContractSchema = {
+    buyerBusinessId?: string | null;
+    sellerBusinessId: string;
+    details: {
+        reference: string | null;
+        contractType?: 'base' | 'fixed' | 'unpriced' | 'premium' | 'base-plus-oil-bonus';
+        paymentDays?: number;
+        haulageType?: 'ex-farm' | 'delivered';
+        contractDateUTC: string;
+        movement?: {
+            months: Array<string>;
+            asAvailable: boolean | null;
+        };
+        files?: Array<{
+            name?: string;
+            id: string;
+            url?: string | null;
+            userId?: string | null;
+            userName?: string | null;
+            organisationId?: string | null;
+            createdAtUTC?: string | null;
+        } | null>;
+        terms?: string | null;
+        pricePerUnit: {
+            amount: number;
+            currency: string;
+        };
+        soldWeight: number;
+    };
+    inventoryId: string;
+    sellerNotes?: string;
+};

package/models/CreateInventorySchema.d.ts

@@ -1,15 +1,17 @@
 export type CreateInventorySchema = {
-    organisationId?: string | null;
-    organisationName?: string;
+    organisationId: string | null;
+    organisationName: string;
     businessId: string;
     businessName: string;
-    businessUnitId?: string | null;
-    businessUnitName?: string;
     harvestWeight?: number | null;
     targetPrice?: {
         amount: number;
         currency: string;
     } | null;
+    breakevenPrice?: {
+        amount: number;
+        currency: string;
+    } | null;
     crop: {
         type?: 'crop' | 'produce';
         harvestYear: string;
@@ -17,7 +19,6 @@ export type CreateInventorySchema = {
             id: number;
             type: number;
             grade: number | null;
-            variety?: string | null;
             varieties?: Array<string> | null;
             tags?: Array<number> | null;
         };
@@ -38,11 +39,12 @@ export type CreateInventorySchema = {
         } | null>;
     };
     offPlatformSales?: Array<{
-        tonnage: number;
-        pricePerTonne: number;
+        soldWeight: number;
+        pricePerUnit: number;
         buyerId?: string | null;
         buyerName?: string | null;
         reference?: string | null;
+        tradeDateUTC?: string | null;
     }> | null;
     tags?: Array<string> | null;
 };

package/models/CreateListing.d.ts

@@ -1,14 +1,6 @@
 export type CreateListing = {
-    public?: boolean | null;
-    bidAlerts?: Array<{
-        authPlatformId: string;
-        emailAddress: string;
-        fullName: string;
-        mobileNumber: string | null;
-        organisationId?: string | null;
-        userId: string;
-    }> | null;
-    businessUnitId: string | null;
+    businessUnitId?: string | null;
+    businessId?: string;
     collectionAddressId?: number | null;
     details: {
         buyerNotes?: string | null;
@@ -21,29 +13,12 @@ export type CreateListing = {
             organisationId?: string | null;
             createdAtUTC?: string | null;
         } | null>;
-        movementPeriod?: {
-            startDateUTC: string;
-            endDateUTC: string;
-            type: 'date' | 'month';
-            excludedDatesUTC?: Array<string> | null;
-            asAvailable?: boolean | null;
-        };
         movement?: {
             months: Array<string>;
             asAvailable: boolean | null;
         };
-        price?: {
-            amount: number;
-            currency: string;
-        } | null;
-        targetPrice?: {
-            amount: number;
-            currency: string;
-        } | null;
-        isBasePremOnly?: boolean;
         contractType?: 'base' | 'fixed' | 'unpriced' | 'premium' | 'base-plus-oil-bonus';
         startDateUTC?: string | null;
-        endDateUTC?: string | null;
         haulageType?: 'ex-farm' | 'delivered' | 'both' | null;
         haulageTypeTASCC?: boolean | null;
     };
@@ -54,7 +29,6 @@ export type CreateListing = {
             id: number;
             type: number;
             grade: number | null;
-            variety?: string | null;
             varieties?: Array<string> | null;
             tags?: Array<number> | null;
         };

package/models/CreateMarketingPlanSchema.d.ts

@@ -3,7 +3,6 @@ export type CreateMarketingPlanSchema = {
     userName: string;
     inventoryId: string | null;
     details: {
-        isBasePremOnly?: boolean;
         contractType?: 'base' | 'fixed' | 'unpriced' | 'premium' | 'base-plus-oil-bonus';
         targetPrice?: {
             amount: number;