@hectare/platform.clients.trading 1.1.1

package/models/ContractsTraded.d.ts

@@ -0,0 +1,76 @@
+export type ContractsTraded = {
+    commodities?: Array<{
+        commodity?: {
+            id?: string | null;
+            name?: string;
+            url?: string;
+            available?: {
+                name: string;
+                conversion: number;
+                weight?: number;
+            };
+            sold?: {
+                name: string;
+                conversion: number;
+                weight?: number;
+            };
+            percentSold?: number;
+            averagePrice?: {
+                amount: number;
+                currency: string;
+            };
+            totalValue?: {
+                amount: number;
+                currency: string;
+            };
+        };
+        types?: Array<{
+            id?: string | null;
+            name?: string;
+            url?: string;
+            available?: {
+                name: string;
+                conversion: number;
+                weight?: number;
+            };
+            sold?: {
+                name: string;
+                conversion: number;
+                weight?: number;
+            };
+            percentSold?: number;
+            averagePrice?: {
+                amount: number;
+                currency: string;
+            };
+            totalValue?: {
+                amount: number;
+                currency: string;
+            };
+            grades?: Array<{
+                id?: string | null;
+                name?: string;
+                url?: string;
+                available?: {
+                    name: string;
+                    conversion: number;
+                    weight?: number;
+                };
+                sold?: {
+                    name: string;
+                    conversion: number;
+                    weight?: number;
+                };
+                percentSold?: number;
+                averagePrice?: {
+                    amount: number;
+                    currency: string;
+                };
+                totalValue?: {
+                    amount: number;
+                    currency: string;
+                };
+            }>;
+        }>;
+    }>;
+};

package/models/ContractsTraded.js

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

package/models/ContractsTradedByMonth.d.ts

@@ -0,0 +1,20 @@
+export type ContractsTradedByMonth = {
+    ranges?: Array<{
+        type?: 'month' | 'quarter' | 'year';
+        name?: string;
+        sold?: {
+            name: string;
+            conversion: number;
+            weight?: number;
+        };
+        percentSold?: number;
+        averagePrice?: {
+            amount: number;
+            currency: string;
+        };
+        totalValue?: {
+            amount: number;
+            currency: string;
+        };
+    }>;
+};

package/models/ContractsTradedByMonth.js

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

package/models/ContractsTradedPeriod.d.ts

@@ -0,0 +1,18 @@
+export type ContractsTradedPeriod = {
+    type?: 'month' | 'quarter' | 'year';
+    name?: string;
+    sold?: {
+        name: string;
+        conversion: number;
+        weight?: number;
+    };
+    percentSold?: number;
+    averagePrice?: {
+        amount: number;
+        currency: string;
+    };
+    totalValue?: {
+        amount: number;
+        currency: string;
+    };
+};

package/models/ContractsTradedPeriod.js

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

package/models/CreateBid.d.ts

@@ -0,0 +1,36 @@
+export type CreateBid = {
+    listingId: string;
+    expiresAtUTC: string;
+    options: Array<{
+        movementPeriod: {
+            startDateUTC: string;
+            endDateUTC: string;
+            type: 'date' | 'month';
+        };
+        pricePerUnit: {
+            amount: number;
+            currency: string;
+        };
+    }>;
+    terms: {
+        weight: {
+            min: number;
+            max: number;
+        };
+        paymentDays: number;
+        paymentType: 'base' | 'fixed' | 'unpriced' | 'premium';
+        haulageType: 'ex-farm' | 'delivered';
+        deliveryPostcode?: string | null;
+        sellerNotes?: string | null;
+    };
+    reference?: string | 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/CreateBid.js

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

package/models/CreateContractDeliverySchema.d.ts

@@ -0,0 +1,10 @@
+export type CreateContractDeliverySchema = {
+    recordId?: string | null;
+    movementId?: number | null;
+    reference: string | null;
+    validate?: boolean | null;
+    moveAtUTC: string;
+    weightPlanned: number;
+    weightActual: number | null;
+    vehicleRegistration: string | null;
+};

package/models/CreateContractDeliverySchema.js

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

package/models/CreateContractRequest.d.ts

@@ -0,0 +1,59 @@
+export type CreateContractRequest = {
+    buyerOrganisationId: string;
+    buyerOrganisationName?: string;
+    businessUnitIds?: Array<string>;
+    details: {
+        reference?: string | null;
+        priceType: 'base' | 'fixed' | 'unpriced' | 'premium';
+        paymentDays?: number;
+        haulageType?: 'ex-farm' | 'delivered';
+        contractDateUTC?: string;
+        contractDateISO?: string;
+        movementPeriod: {
+            startDateUTC: string;
+            endDateUTC: string;
+            type: 'date' | 'month';
+            totalWeight?: number;
+            pricePerUnit?: {
+                amount: number;
+                currency: string;
+            } | null;
+            premiumPrice?: {
+                amount: number;
+                currency: string;
+            } | null;
+            notes?: string | null;
+            premiumPriceMax?: {
+                amount: number;
+                currency: string;
+            } | 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;
+        premiumContractId?: string | null;
+    };
+    inventory: {
+        type: 'crop' | 'produce';
+        harvestYear: string;
+        commodity: {
+            id: number;
+            type: number;
+            grade: number | null;
+            variety?: string | null;
+            tags?: Array<number> | null;
+        };
+        measures?: Array<{
+            specificationId: number;
+            min: number | null;
+            max: number | null;
+        }> | null;
+    };
+};

package/models/CreateContractRequest.js

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

package/models/CreateListing.d.ts

@@ -0,0 +1,68 @@
+export type CreateListing = {
+    public?: boolean;
+    bidAlerts?: Array<{
+        authPlatformId: string;
+        emailAddress: string;
+        fullName: string;
+        mobileNumber: string | null;
+        organisationId?: string | null;
+        userId: string;
+    }> | null;
+    businessUnitId: string | null;
+    details: {
+        buyerNotes?: string | null;
+        files?: Array<{
+            name?: string;
+            id: string;
+            url?: string | null;
+            userId?: string | null;
+            userName?: string | null;
+            organisationId?: string | null;
+            createdAtUTC?: string | null;
+        } | null>;
+        movementPeriod?: {
+            startDateUTC: string;
+            endDateUTC: string;
+            type: 'date' | 'month';
+        };
+        price?: {
+            amount: number;
+            currency: string;
+        } | null;
+        targetPrice?: {
+            amount: number;
+            currency: string;
+        } | null;
+    };
+    inventory: {
+        commodity: {
+            id: number;
+            type: number;
+            grade: number | null;
+            variety?: string | null;
+            tags?: Array<number> | null;
+        };
+        harvestYear: string;
+        measures: Array<{
+            specificationId: number;
+            min: number | null;
+            max: number | null;
+        }> | null;
+        type: 'crop' | 'produce';
+        weight: {
+            min: number;
+            max: number;
+        };
+    };
+    marketBuyers?: Array<{
+        authPlatformId: string;
+        emailAddress: string;
+        fullName: string;
+        mobileNumber: string | null;
+        organisationId?: string | null;
+        userId: string;
+    }> | null;
+    tags?: Array<string> | null;
+    tradeRequestId?: string;
+    relistedFromListingId?: string;
+};

package/models/CreateListing.js

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

package/models/CreateMarketUpdateRequest.d.ts

@@ -0,0 +1,21 @@
+export type CreateMarketUpdateRequest = {
+    title: string | null;
+    content: string;
+    audience: {
+        userType: 'buyer' | 'seller' | 'all';
+        commodities: Array<number>;
+        regionISOs: Array<string>;
+    } | null;
+    notification: boolean;
+    visibleInProduct: boolean;
+    visibleUntil: string;
+    utmCampaignId?: string;
+    url: string | null;
+    template: {
+        id: string;
+        variables: Array<{
+            name: string;
+            value: string;
+        }>;
+    } | null;
+};

package/models/CreateMarketUpdateRequest.js

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

package/models/CreateOrUpdateTargetPriceSchema.d.ts

@@ -0,0 +1,12 @@
+export type CreateOrUpdateTargetPriceSchema = {
+    exFarmCommodityId: number;
+    minPrice: {
+        amount: number;
+        currency: string;
+    } | null;
+    maxPrice: {
+        amount: number;
+        currency: string;
+    } | null;
+    receiveAlerts: boolean;
+};

package/models/CreateOrUpdateTargetPriceSchema.js

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

package/models/CreateOrUpdateTargetPricesSchema.d.ts

@@ -0,0 +1,12 @@
+export type CreateOrUpdateTargetPricesSchema = Record<string, Array<{
+    exFarmCommodityId: number;
+    minPrice: {
+        amount: number;
+        currency: string;
+    } | null;
+    maxPrice: {
+        amount: number;
+        currency: string;
+    } | null;
+    receiveAlerts: boolean;
+}>>;

package/models/CreateOrUpdateTargetPricesSchema.js

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

package/models/CreateTradeRequest.d.ts

@@ -0,0 +1,31 @@
+export type CreateTradeRequest = {
+    businessUnitId?: string | null;
+    requestType?: 'everyone' | 'farms' | 'merchants';
+    commodity: {
+        id: number;
+        type: number;
+        grade: number | null;
+        variety?: string | null;
+        tags?: Array<number> | null;
+    };
+    regionISOs?: Array<string>;
+    harvestYear: string;
+    type?: 'crop' | 'produce';
+    farmAssured?: boolean;
+    sellerNotes?: string | null;
+    movementPeriod: {
+        startDateUTC: string;
+        endDateUTC: string;
+        type: 'date' | 'month';
+    };
+    haulageTerms: {
+        haulageType: 'ex-farm' | 'delivered';
+        deliveryPostcode?: string | null;
+    };
+    weight: number;
+    guidePrice?: {
+        amount: number;
+        currency: string;
+    } | null;
+    tags?: Array<string> | null;
+};

package/models/CreateTradeRequest.js

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

package/models/ExFarmPriceCommodity.d.ts

@@ -0,0 +1,7 @@
+export type ExFarmPriceCommodity = {
+    id?: number;
+    name?: string;
+    commodityId?: number;
+    grades?: Array<number>;
+    default?: boolean;
+};

package/models/ExFarmPriceCommodity.js

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

package/models/ExFarmPricesRegionSchema.d.ts

@@ -0,0 +1,13 @@
+export type ExFarmPricesRegionSchema = {
+    region: string;
+    prices: Array<{
+        id?: number;
+        commodity?: 'Milling Wheat' | 'Feed Wheat' | 'Feed Barley' | 'Oilseed Rape';
+        date?: string | null;
+        price?: number;
+        delta?: number;
+        commodityId?: number | null;
+        commodityGrades?: Array<number> | null;
+        default?: boolean | null;
+    }>;
+};

package/models/ExFarmPricesRegionSchema.js

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

package/models/ExFarmPricesSchema.d.ts

@@ -0,0 +1,45 @@
+export type ExFarmPricesSchema = {
+    updatedAtUTC: string;
+    configuration: {
+        commodities: Array<{
+            commodity: 'Milling Wheat' | 'Feed Wheat' | 'Feed Barley' | 'Oilseed Rape';
+            price: number;
+        }>;
+        dates: Array<{
+            commodity: 'Milling Wheat' | 'Feed Wheat' | 'Feed Barley' | 'Oilseed Rape';
+            date: string;
+            carryPrice: number;
+        }>;
+        regionGroups: Array<{
+            commodity: 'Milling Wheat' | 'Feed Wheat' | 'Feed Barley' | 'Oilseed Rape';
+            groups: Array<string>;
+            differentialPrice: number;
+        }>;
+    };
+    groups: Array<{
+        group: string;
+        prices: Array<{
+            id?: number;
+            commodity?: 'Milling Wheat' | 'Feed Wheat' | 'Feed Barley' | 'Oilseed Rape';
+            date?: string | null;
+            price?: number;
+            delta?: number;
+            commodityId?: number | null;
+            commodityGrades?: Array<number> | null;
+            default?: boolean | null;
+        }>;
+    }>;
+    regions: Array<{
+        region: string;
+        prices: Array<{
+            id?: number;
+            commodity?: 'Milling Wheat' | 'Feed Wheat' | 'Feed Barley' | 'Oilseed Rape';
+            date?: string | null;
+            price?: number;
+            delta?: number;
+            commodityId?: number | null;
+            commodityGrades?: Array<number> | null;
+            default?: boolean | null;
+        }>;
+    }>;
+};

package/models/ExFarmPricesSchema.js

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

package/models/ExpiredBidOffer.d.ts

@@ -0,0 +1,4 @@
+export type ExpiredBidOffer = {
+    optionId: number;
+    weight: number;
+};

package/models/ExpiredBidOffer.js

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

package/models/FeedItem.d.ts

@@ -0,0 +1,8 @@
+export type FeedItem = {
+    title: string;
+    summary?: string;
+    imageUrl?: string;
+    articleUrl: string;
+    source: 'AHDB' | 'FW' | 'HCTR';
+    publishDate?: string;
+};

package/models/FeedItem.js

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

package/models/FinMidWebhook.d.ts

@@ -0,0 +1,10 @@
+export type FinMidWebhook = {
+    webhook_id: string;
+    timestamp: string;
+    events: Array<{
+        event_id?: string;
+        timestamp?: string;
+        type?: string;
+        data?: any;
+    }> | null;
+};

package/models/FinMidWebhook.js

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

package/models/FinMidWebhookEvent.d.ts

@@ -0,0 +1,6 @@
+export type FinMidWebhookEvent = {
+    event_id?: string;
+    timestamp?: string;
+    type?: string;
+    data?: any;
+};

package/models/FinMidWebhookEvent.js

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

package/models/InsightPrices.d.ts

@@ -0,0 +1,17 @@
+export type InsightPrices = {
+    contractTerm: string;
+    created: string;
+    pricePerUnit: number;
+    currency: string;
+    movementMonth: number;
+    movementYear: number;
+    category: string;
+    group: string;
+    targetPrice: number;
+    priceCurrency: string;
+    bidsMinAmount: number;
+    bidsMaxAmount: number;
+    spread: number;
+    region?: string;
+    countryIso?: string;
+};

package/models/InsightPrices.js

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

package/models/InsightsLivestockTaxonomySchema.d.ts

@@ -0,0 +1,18 @@
+export type InsightsLivestockTaxonomySchema = {
+    species: Array<{
+        id: string;
+        name: string;
+        breeds: Array<{
+            id: number;
+            name: string;
+        }>;
+        types?: Array<{
+            id: number;
+            name: string;
+        }>;
+        genders?: Array<{
+            id: number;
+            name: string;
+        }>;
+    }>;
+};

package/models/InsightsLivestockTaxonomySchema.js

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

package/models/LinkContractSchema.d.ts

@@ -0,0 +1,7 @@
+export type LinkContractSchema = {
+    premiumContractId: string;
+    baseContractIds: Array<{
+        baseContractId: string;
+        fixedPrice: number;
+    }>;
+};

package/models/LinkContractSchema.js

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

package/models/ListingBidInfoBid.d.ts

@@ -0,0 +1,13 @@
+export type ListingBidInfoBid = {
+    userId: string;
+    status: 'active' | 'accepted' | 'withdrawn' | 'expired' | 'expiredOffered' | 'expiredOfferDeclined';
+    weight: {
+        min: number;
+        max: number;
+    };
+    options: Array<{
+        id: number;
+        soldWeightKG?: number | null;
+        soldWeight: number | null;
+    }>;
+};

package/models/ListingBidInfoBid.js

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