@hectare/platform.clients.trading 1.1.116 → 1.1.118

package/index.d.ts

@@ -23,6 +23,7 @@ export type { ContractsTradedPeriod } from './models/ContractsTradedPeriod.js';
 export type { CreateBid } from './models/CreateBid.js';
 export type { CreateContractDeliverySchema } from './models/CreateContractDeliverySchema.js';
 export type { CreateContractRequest } from './models/CreateContractRequest.js';
+export type { CreateInventorySchema } from './models/CreateInventorySchema.js';
 export type { CreateListing } from './models/CreateListing.js';
 export type { CreateMarketingPlanSchema } from './models/CreateMarketingPlanSchema.js';
 export type { CreateMarketUpdateRequest } from './models/CreateMarketUpdateRequest.js';
@@ -43,6 +44,10 @@ export type { InsightPriceSpreadMonths } from './models/InsightPriceSpreadMonths
 export type { InsightsDailySpotPricesByDateRangeSchema } from './models/InsightsDailySpotPricesByDateRangeSchema.js';
 export type { InsightsDailySpotPricesSchema } from './models/InsightsDailySpotPricesSchema.js';
 export type { InsightsHistoricalFuturesPricesSchema } from './models/InsightsHistoricalFuturesPricesSchema.js';
+export type { InventoryDetailSchema } from './models/InventoryDetailSchema.js';
+export type { InventorySchema } from './models/InventorySchema.js';
+export type { InventorySearchResultsSchema } from './models/InventorySearchResultsSchema.js';
+export type { InventorySummarySchema } from './models/InventorySummarySchema.js';
 export type { LinkContractSchema } from './models/LinkContractSchema.js';
 export type { ListingBidInfoBid } from './models/ListingBidInfoBid.js';
 export type { ListingDetail } from './models/ListingDetail.js';

package/models/CreateInventorySchema.d.ts

@@ -0,0 +1,35 @@
+export type CreateInventorySchema = {
+    organisationId?: string | null;
+    organisationName?: string;
+    businessUnitId: string | null;
+    businessUnitName: string;
+    weight?: number;
+    inventory?: {
+        type: 'crop' | 'produce';
+        harvestYear: string;
+        commodity: {
+            id: number;
+            type: number;
+            grade: number | null;
+            variety?: string | null;
+            varieties?: Array<string> | null;
+            tags?: Array<number> | null;
+        };
+        measures: Array<{
+            specificationId: number;
+            min: number | null;
+            max: number | null;
+        }> | null;
+        hasSampled: boolean;
+        files?: Array<{
+            name?: string;
+            id: string;
+            url?: string | null;
+            userId?: string | null;
+            userName?: string | null;
+            organisationId?: string | null;
+            createdAtUTC?: string | null;
+        } | null>;
+    };
+    tags?: Array<string> | null;
+};

package/models/CreateInventorySchema.js

@@ -0,0 +1 @@
+export {};

package/models/CreateListing.d.ts

@@ -41,6 +41,8 @@ export type CreateListing = {
         haulageType?: 'ex-farm' | 'delivered' | null;
     };
     inventory: {
+        type: 'crop' | 'produce';
+        harvestYear: string;
         commodity: {
             id: number;
             type: number;
@@ -49,18 +51,16 @@ export type CreateListing = {
             varieties?: Array<string> | null;
             tags?: Array<number> | null;
         };
-        harvestYear: string;
         measures: Array<{
             specificationId: number;
             min: number | null;
             max: number | null;
         }> | null;
-        type: 'crop' | 'produce';
+        hasSampled?: boolean;
         weight: {
             min: number;
             max: number;
         };
-        hasSampled?: boolean;
     };
     tags?: Array<string> | null;
     tradeRequestId?: string;

package/models/CreateMarketingPlanSchema.d.ts

@@ -1,9 +1,10 @@
 export type CreateMarketingPlanSchema = {
+    inventoryId?: string | null;
     organisationId?: string | null;
     organisationName?: string;
     businessUnitId: string | null;
     businessUnitName: string;
-    inventory: {
+    inventory?: {
         type: 'crop' | 'produce';
         harvestYear: string;
         commodity: {
@@ -20,6 +21,15 @@ export type CreateMarketingPlanSchema = {
             max: number | null;
         }> | null;
         hasSampled: boolean;
+        files?: Array<{
+            name?: string;
+            id: string;
+            url?: string | null;
+            userId?: string | null;
+            userName?: string | null;
+            organisationId?: string | null;
+            createdAtUTC?: string | null;
+        } | null>;
     };
     details: {
         files: Array<{

package/models/InventoryDetailSchema.d.ts

@@ -0,0 +1,62 @@
+export type InventoryDetailSchema = {
+    id: string;
+    createdAtUTC?: string;
+    updatedAtUTC?: string;
+    businessUnitId: string;
+    businessUnitName: string;
+    organisationId: string;
+    organisationName: string;
+    status: 'active' | 'deleted';
+    weight: {
+        name: string;
+        conversion: number;
+        weight?: number;
+    };
+    details: {
+        type: 'crop' | 'produce';
+        harvestYear: string;
+        commodity: {
+            commodity: {
+                id: number;
+                name: string;
+            };
+            type: {
+                id: number;
+                name: string;
+            };
+            grade: {
+                id: number;
+                name: string;
+            };
+            variety?: string;
+            varieties: Array<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>;
+    };
+    tags: Array<string>;
+};

package/models/InventoryDetailSchema.js

@@ -0,0 +1 @@
+export {};

package/models/InventorySchema.d.ts

@@ -0,0 +1,46 @@
+export type InventorySchema = {
+    type: 'crop' | 'produce';
+    harvestYear: string;
+    commodity: {
+        commodity: {
+            id: number;
+            name: string;
+        };
+        type: {
+            id: number;
+            name: string;
+        };
+        grade: {
+            id: number;
+            name: string;
+        };
+        variety?: string;
+        varieties: Array<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>;
+};

package/models/InventorySchema.js

@@ -0,0 +1 @@
+export {};

package/models/InventorySearchResultsSchema.d.ts

@@ -0,0 +1,196 @@
+export type InventorySearchResultsSchema = {
+    docs?: Array<{
+        id: string;
+        createdAtUTC?: string;
+        businessUnitId: string;
+        businessUnitName: string;
+        organisationId: string;
+        organisationName: string;
+        status: 'pending' | 'active' | 'completed' | 'inactive';
+        inventory: {
+            type: 'crop' | 'produce';
+            harvestYear: string;
+            commodity: {
+                commodity: {
+                    id: number;
+                    name: string;
+                };
+                type: {
+                    id: number;
+                    name: string;
+                };
+                grade: {
+                    id: number;
+                    name: string;
+                };
+                variety?: string;
+                varieties: Array<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>;
+        };
+        weight?: {
+            name: string;
+            conversion: number;
+            weight?: number;
+        };
+        details: {
+            isBasePremOnly: boolean;
+            targetPrice: {
+                amount: number;
+                currency: string;
+            } | null;
+            movementPeriod: {
+                startDateUTC: string;
+                endDateUTC: string;
+                type: 'date' | 'month';
+                excludedDatesUTC?: Array<string> | null;
+                asAvailable?: boolean | null;
+            };
+            haulageType: 'ex-farm' | 'delivered' | null;
+            buyerNotes: string | null;
+        };
+        strategy: {
+            type: 'steady';
+            startDateUTC: string;
+            endDateUTC: string;
+            deadlines: Array<{
+                id: number;
+                endDateUTC: string;
+                weight: {
+                    name: string;
+                    conversion: number;
+                    weight?: number;
+                };
+                weightPerListingAvg: {
+                    name: string;
+                    conversion: number;
+                    weight?: number;
+                };
+                weightPerListingMin: {
+                    name: string;
+                    conversion: number;
+                    weight?: number;
+                };
+                weightPerListingMax: {
+                    name: string;
+                    conversion: number;
+                    weight?: number;
+                };
+                canListLowerWeight: boolean;
+            }>;
+            priceOfferReview: {
+                type: 'first' | 'second' | 'third' | 'fourth' | 'last' | 'every';
+                dayOfWeek: 1 | 2 | 3 | 4 | 5 | 6 | 7;
+                hourOfDay: number;
+            };
+        };
+        summary: {
+            totalListingCount: number;
+            soldWeight: {
+                name: string;
+                conversion: number;
+                weight?: number;
+            };
+            unsoldWeight: {
+                name: string;
+                conversion: number;
+                weight?: number;
+            };
+            averageSoldPrice: {
+                amount: number;
+                currency: string;
+            } | null;
+        };
+        schedule?: Array<{
+            id?: number;
+            deadlineId?: number;
+            minTonnes?: number;
+            maxTonnes?: number;
+            reviewDateUTC?: string;
+            listingId?: string;
+            weight?: {
+                name: string;
+                conversion: number;
+                weight?: number;
+            };
+            movementPeriod?: {
+                startDateUTC: string;
+                endDateUTC: string;
+                type: 'date' | 'month';
+            };
+            skipped?: boolean;
+        }>;
+        tags?: Array<string>;
+    }>;
+    custom?: any;
+    totalDocs?: number;
+    limit?: number;
+    offset?: number;
+    clearUrl?: string;
+    activeFilters?: Array<{
+        name?: string;
+        clearUrl?: string;
+        terms?: Array<{
+            name?: string;
+            clearUrl?: string;
+        }>;
+    }>;
+    facets?: Array<{
+        displayName?: string;
+        clearUrl?: string;
+        disabled?: boolean;
+        name?: string;
+        selected?: boolean;
+        active?: boolean;
+        terms?: Array<{
+            name?: string;
+            url?: string;
+            hits?: string;
+            selected?: string;
+            id?: string;
+            state?: 'checked disabled' | 'checked' | 'disabled' | '';
+            aggregations?: Record<string, {
+                sum?: number;
+                min?: number;
+                max?: number;
+                average?: number;
+            }>;
+        }>;
+    }>;
+    aggregations?: Array<{
+        name?: string;
+        sum?: number;
+        min?: number;
+        max?: number;
+        average?: number;
+        count?: number;
+        range?: string;
+        hits?: number;
+        unit?: string;
+    }>;
+};

package/models/InventorySearchResultsSchema.js

@@ -0,0 +1 @@
+export {};

package/models/InventorySummarySchema.d.ts

@@ -0,0 +1,62 @@
+export type InventorySummarySchema = {
+    id: string;
+    createdAtUTC?: string;
+    updatedAtUTC?: string;
+    businessUnitId: string;
+    businessUnitName: string;
+    organisationId: string;
+    organisationName: string;
+    status: 'active' | 'deleted';
+    weight: {
+        name: string;
+        conversion: number;
+        weight?: number;
+    };
+    details: {
+        type: 'crop' | 'produce';
+        harvestYear: string;
+        commodity: {
+            commodity: {
+                id: number;
+                name: string;
+            };
+            type: {
+                id: number;
+                name: string;
+            };
+            grade: {
+                id: number;
+                name: string;
+            };
+            variety?: string;
+            varieties: Array<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>;
+    };
+    tags: Array<string>;
+};

package/models/InventorySummarySchema.js

@@ -0,0 +1 @@
+export {};

package/models/MarketingPlanDetailSchema.d.ts

@@ -31,11 +31,6 @@ export type MarketingPlanDetailSchema = {
                 weight?: number;
             };
         };
-        weight: {
-            name: string;
-            conversion: number;
-            weight?: number;
-        };
         measures: Array<{
             specification: {
                 id: number;
@@ -47,8 +42,6 @@ export type MarketingPlanDetailSchema = {
         }> | null;
         hasSampled: boolean;
         customMeasures?: boolean | null;
-    };
-    details: {
         files: Array<{
             name?: string;
             id: string;
@@ -58,6 +51,13 @@ export type MarketingPlanDetailSchema = {
             organisationId?: string | null;
             createdAtUTC?: string | null;
         } | null>;
+    };
+    weight?: {
+        name: string;
+        conversion: number;
+        weight?: number;
+    };
+    details: {
         isBasePremOnly: boolean;
         targetPrice: {
             amount: number;
@@ -128,6 +128,8 @@ export type MarketingPlanDetailSchema = {
     schedule?: Array<{
         id?: number;
         deadlineId?: number;
+        minTonnes?: number;
+        maxTonnes?: number;
         reviewDateUTC?: string;
         listingId?: string;
         weight?: {

package/models/MarketingPlanSearchResultsSchema.d.ts

@@ -32,11 +32,6 @@ export type MarketingPlanSearchResultsSchema = {
                     weight?: number;
                 };
             };
-            weight: {
-                name: string;
-                conversion: number;
-                weight?: number;
-            };
             measures: Array<{
                 specification: {
                     id: number;
@@ -48,8 +43,6 @@ export type MarketingPlanSearchResultsSchema = {
             }> | null;
             hasSampled: boolean;
             customMeasures?: boolean | null;
-        };
-        details: {
             files: Array<{
                 name?: string;
                 id: string;
@@ -59,6 +52,13 @@ export type MarketingPlanSearchResultsSchema = {
                 organisationId?: string | null;
                 createdAtUTC?: string | null;
             } | null>;
+        };
+        weight?: {
+            name: string;
+            conversion: number;
+            weight?: number;
+        };
+        details: {
             isBasePremOnly: boolean;
             targetPrice: {
                 amount: number;
@@ -129,6 +129,8 @@ export type MarketingPlanSearchResultsSchema = {
         schedule?: Array<{
             id?: number;
             deadlineId?: number;
+            minTonnes?: number;
+            maxTonnes?: number;
             reviewDateUTC?: string;
             listingId?: string;
             weight?: {

package/models/MarketingPlanSummarySchema.d.ts

@@ -31,11 +31,6 @@ export type MarketingPlanSummarySchema = {
                 weight?: number;
             };
         };
-        weight: {
-            name: string;
-            conversion: number;
-            weight?: number;
-        };
         measures: Array<{
             specification: {
                 id: number;
@@ -47,8 +42,6 @@ export type MarketingPlanSummarySchema = {
         }> | null;
         hasSampled: boolean;
         customMeasures?: boolean | null;
-    };
-    details: {
         files: Array<{
             name?: string;
             id: string;
@@ -58,6 +51,13 @@ export type MarketingPlanSummarySchema = {
             organisationId?: string | null;
             createdAtUTC?: string | null;
         } | null>;
+    };
+    weight?: {
+        name: string;
+        conversion: number;
+        weight?: number;
+    };
+    details: {
         isBasePremOnly: boolean;
         targetPrice: {
             amount: number;
@@ -128,6 +128,8 @@ export type MarketingPlanSummarySchema = {
     schedule?: Array<{
         id?: number;
         deadlineId?: number;
+        minTonnes?: number;
+        maxTonnes?: number;
         reviewDateUTC?: string;
         listingId?: string;
         weight?: {

package/models/PatchListingSchema.d.ts

@@ -32,6 +32,8 @@ export type PatchListingSchema = {
         haulageType?: 'ex-farm' | 'delivered' | null;
     };
     inventory?: {
+        type?: 'crop' | 'produce';
+        harvestYear?: string;
         commodity?: {
             id: number;
             type: number;
@@ -40,18 +42,16 @@ export type PatchListingSchema = {
             varieties?: Array<string> | null;
             tags?: Array<number> | null;
         };
-        harvestYear?: string;
         measures?: Array<{
             specificationId: number;
             min: number | null;
             max: number | null;
         }> | null;
-        type?: 'crop' | 'produce';
+        hasSampled?: boolean;
         weight?: {
             min: number;
             max: number;
         };
-        hasSampled?: boolean;
     };
     feedback?: {
         sellerTargetPrice?: {

package/models/PatchMarketingPlanScheduleSchema.d.ts

@@ -4,6 +4,8 @@ export type PatchMarketingPlanScheduleSchema = {
         deadlineId?: number;
         reviewDateUTC: string;
         weight: number;
+        minWeight: number;
+        maxWeight: number;
         movementPeriod: {
             startDateUTC: string;
             endDateUTC: string;

package/models/PatchMarketingPlanSchema.d.ts

@@ -1,4 +1,5 @@
 export type PatchMarketingPlanSchema = {
+    inventoryId?: string | null;
     organisationId?: string | null;
     organisationName?: string;
     businessUnitId: string | null;
@@ -20,6 +21,15 @@ export type PatchMarketingPlanSchema = {
             max: number | null;
         }> | null;
         hasSampled: boolean;
+        files?: Array<{
+            name?: string;
+            id: string;
+            url?: string | null;
+            userId?: string | null;
+            userName?: string | null;
+            organisationId?: string | null;
+            createdAtUTC?: string | null;
+        } | null>;
     };
     details: {
         files: Array<{

package/package.json

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