@hectare/platform.clients.trading 1.1.1

package/models/ListingSummary.d.ts

@@ -0,0 +1,158 @@
+export type ListingSummary = {
+    id: string;
+    public: boolean;
+    status: 'active' | 'closed' | 'traded';
+    substatus: 'unsold' | 'archived' | null;
+    business: {
+        organisationId?: string;
+        organisationCreatedAtUTC?: string;
+        organisationName?: string;
+        organisationLogo?: string;
+        organisationVetted?: boolean;
+        businessUnitId?: string;
+        businessUnitName?: string;
+        id?: string;
+        name: string;
+        email: string;
+        phone: {
+            callingCode: string;
+            number: string;
+        };
+        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;
+        holdingNumber?: string;
+        assuranceScheme?: 'RT' | 'SQC';
+        sqc?: {
+            number: string;
+            isAssured: boolean;
+        } | null;
+    };
+    details: {
+        startDateUTC: string;
+        endDateUTC: string | null;
+        price: {
+            amount: number;
+            currency: string;
+        } | null;
+        movementPeriod: {
+            startDateUTC: string;
+            endDateUTC: string;
+            type: 'date' | 'month';
+        };
+        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>;
+        targetPrice: {
+            amount: number;
+            currency: string;
+        } | null;
+        guidePrice: {
+            amount: number;
+            currency: string;
+        } | null;
+    };
+    inventory: {
+        type: 'crop' | 'produce';
+        harvestYear: string;
+        commodity: {
+            commodity: {
+                id: number;
+                name: string;
+            };
+            type: {
+                id: number;
+                name: string;
+            };
+            grade: {
+                id: number;
+                name: string;
+            };
+            variety: string;
+            tags: Array<number>;
+            weight: {
+                name: string;
+                conversion: number;
+                weight?: number;
+            };
+        };
+        weight: {
+            min: {
+                name: string;
+                conversion: number;
+                weight?: number;
+            };
+            max: {
+                name: string;
+                conversion: number;
+                weight?: number;
+            };
+        };
+        measures: Array<{
+            specification: {
+                id: number;
+                name: string;
+                unit: string;
+            };
+            min: number | null;
+            max: number | null;
+        }> | null;
+    };
+    activeBids: number;
+    bidInfo?: {
+        count: number;
+        acceptedCount: number;
+        activeCount: number;
+        expiredCount: number;
+        nextExpiryUTC: string | null;
+        prevExpiryUTC: string | null;
+        minPrice: {
+            amount: number;
+            currency: string;
+        } | null;
+        maxPrice: {
+            amount: number;
+            currency: string;
+        } | null;
+        soldWeight: number | null;
+        bids: Record<string, {
+            userId: string;
+            status: 'active' | 'accepted' | 'withdrawn' | 'expired' | 'expiredOffered' | 'expiredOfferDeclined';
+            weight: {
+                min: number;
+                max: number;
+            };
+            options: Array<{
+                id: number;
+                soldWeightKG?: number | null;
+                soldWeight: number | null;
+            }>;
+        }>;
+    };
+    tradeRequestId?: string;
+    relistedFromListingId?: string;
+    pending?: boolean;
+};

package/models/ListingSummary.js

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

package/models/MarketBuyers.d.ts

@@ -0,0 +1,10 @@
+export type MarketBuyers = {
+    marketBuyers: Array<{
+        authPlatformId: string;
+        emailAddress: string;
+        fullName: string;
+        mobileNumber: string | null;
+        organisationId?: string | null;
+        userId: string;
+    }> | null;
+};

package/models/MarketBuyers.js

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

package/models/MarketUpdateDetail.d.ts

@@ -0,0 +1,15 @@
+export type MarketUpdateDetail = {
+    id: string;
+    title: string;
+    content: string;
+    visibleUntil: string;
+    publishedAt: string;
+    visibleInProduct: boolean;
+    notification: boolean;
+    url: string;
+    utmCampaignId?: string | null;
+    audienceUserType: string | null;
+    audienceCommodityIds: Array<number> | null;
+    audienceRegionISOs: Array<string> | null;
+    templateId: string;
+};

package/models/MarketUpdateDetail.js

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

package/models/NewsFeed.d.ts

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

package/models/NewsFeed.js

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

package/models/PatchBid.d.ts

@@ -0,0 +1,26 @@
+export type PatchBid = {
+    expiresAtUTC: string;
+    options: Array<{
+        id: number | null;
+        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;
+    };
+};

package/models/PatchBid.js

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

package/models/PatchBidOption.d.ts

@@ -0,0 +1,12 @@
+export type PatchBidOption = {
+    id: number | null;
+    movementPeriod: {
+        startDateUTC: string;
+        endDateUTC: string;
+        type: 'date' | 'month';
+    };
+    pricePerUnit: {
+        amount: number;
+        currency: string;
+    };
+};

package/models/PatchBidOption.js

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

package/models/PatchContractDeliverySchema.d.ts

@@ -0,0 +1,42 @@
+export type PatchContractDeliverySchema = {
+    reference: string | null;
+    moveAtUTC: string;
+    vehicleRegistration: string | null;
+    weightActual: number;
+    settlement: {
+        reference: string | null;
+        pricePerUnit: {
+            amount: number;
+            currency: string;
+        };
+        priceVAT: {
+            amount: number;
+            currency: string;
+        } | null;
+        invoiceDateUTC: string;
+        invoiceDueDateUTC: string;
+        deductions: Array<{
+            reasonId: number;
+            amount: {
+                amount: number;
+                currency: string;
+            };
+        }> | null;
+        bonuses?: Array<{
+            reasonId: number;
+            amount: {
+                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>;
+    };
+};

package/models/PatchContractDeliverySchema.js

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

package/models/PatchContractPricingSchema.d.ts

@@ -0,0 +1,13 @@
+export type PatchContractPricingSchema = {
+    commodityGrade: number;
+    priceType: 'base' | 'fixed' | 'unpriced' | 'premium';
+    totalWeight: number;
+    pricePerUnit: {
+        amount: number;
+        currency: string;
+    } | null;
+    premiumPrice: {
+        amount: number;
+        currency: string;
+    } | null;
+};

package/models/PatchContractPricingSchema.js

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

package/models/PatchContractRequest.d.ts

@@ -0,0 +1,47 @@
+export type PatchContractRequest = {
+    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;
+    };
+    commodityGrade?: number;
+    measures?: Array<{
+        specificationId: number;
+        min: number | null;
+        max: number | null;
+    }> | null;
+};

package/models/PatchContractRequest.js

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

package/models/PatchMarketUpdateRequest.d.ts

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

package/models/PatchMarketUpdateRequest.js

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

package/models/PublishExFarmPricingSchema.d.ts

@@ -0,0 +1,16 @@
+export type PublishExFarmPricingSchema = {
+    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;
+    }>;
+};

package/models/PublishExFarmPricingSchema.js

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

package/models/PutContractFile.d.ts

@@ -0,0 +1,9 @@
+export type PutContractFile = Array<{
+    name?: string;
+    id: string;
+    url?: string | null;
+    userId?: string | null;
+    userName?: string | null;
+    organisationId?: string | null;
+    createdAtUTC?: string | null;
+} | null>;

package/models/PutContractFile.js

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

package/models/TargetPriceDetailSchema.d.ts

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

package/models/TargetPriceDetailSchema.js

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

package/models/Templates.d.ts

@@ -0,0 +1,9 @@
+export type Templates = {
+    id: string;
+    templates: Array<{
+        templateId?: string;
+        variables?: Array<{
+            name?: string;
+        }>;
+    }>;
+};

package/models/Templates.js

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

package/models/TradeRequestDetail.d.ts

@@ -0,0 +1,64 @@
+export type TradeRequestDetail = {
+    id: string;
+    status: 'active' | 'closed';
+    commodityName?: string;
+    commodity: {
+        commodity: {
+            id: number;
+            name: string;
+        };
+        type: {
+            id: number;
+            name: string;
+        };
+        grade: {
+            id: number;
+            name: string;
+        };
+        variety: string;
+        tags: Array<number>;
+        weight: {
+            name: string;
+            conversion: number;
+            weight?: number;
+        };
+    };
+    harvestYear: string;
+    type: 'crop' | 'produce';
+    farmAssured?: boolean;
+    sellerNotes?: string | null;
+    regions?: Array<string>;
+    listingsReceived?: number;
+    movementPeriod: {
+        startDateUTC: string;
+        endDateUTC: string;
+        type: 'date' | 'month';
+    };
+    haulageTerms: {
+        haulageType?: 'ex-farm' | 'delivered';
+        deliveryPostcode?: string | null;
+    };
+    weight: {
+        name: string;
+        conversion: number;
+        weight?: number;
+    };
+    buyer: {
+        authPlatformId?: string;
+        emailAddress?: string;
+        fullName?: string;
+        mobileNumber?: {
+            callingCode: string;
+            number: string;
+        };
+        organisationId?: string | null;
+        organisationName?: string | null;
+        userId: string;
+    };
+    createdAtUTC?: string;
+    requestType?: 'everyone' | 'farms' | 'merchants';
+    guidePrice: {
+        amount: number;
+        currency: string;
+    } | null;
+};

package/models/TradeRequestDetail.js

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

package/models/TradingConfig.d.ts

@@ -0,0 +1,21 @@
+export type TradingConfig = {
+    settlementDeductionReasons?: Array<{
+        id?: number;
+        description?: string;
+    }>;
+    settlementBonusReasons?: Array<{
+        id?: number;
+        description?: string;
+    }>;
+    exFarmPriceCommodities?: Array<{
+        id?: number;
+        name?: string;
+        commodityId?: number;
+        grades?: Array<number>;
+        default?: boolean;
+    }>;
+    closeListingReasons?: Array<{
+        id?: number;
+        description?: string;
+    }>;
+};

package/models/TradingConfig.js

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

package/models/UnlinkContractSchema.d.ts

@@ -0,0 +1,4 @@
+export type UnlinkContractSchema = {
+    premiumContractId: string;
+    baseContractId: string;
+};

package/models/UnlinkContractSchema.js

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

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@hectare/platform.clients.trading",
+  "version": "1.1.1",
+  "main": "index.js",
+  "exported": true,
+  "types": "index.d.ts",
+  "type": "commonjs",
+  "author": "engineering@wearehectare.com",
+  "source": "index.js",
+  "publishConfig": {
+    "access": "public"
+  }
+}