@hectare/platform.clients.trading 1.1.241 → 1.1.242

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 (22) hide show
  1. package/index.d.ts +1 -0
  2. package/models/BidDetail.d.ts +25 -20
  3. package/models/ContractDetail.d.ts +91 -25
  4. package/models/CreateContractSchema.d.ts +3 -3
  5. package/models/CreateInventorySchema.d.ts +9 -7
  6. package/models/CreateListing.d.ts +2 -2
  7. package/models/HarvestSummarySchema.d.ts +50 -18
  8. package/models/InventoryDetailSchema.d.ts +39 -25
  9. package/models/InventorySchema.d.ts +0 -1
  10. package/models/InventorySearchResultsSchema.d.ts +39 -25
  11. package/models/InventorySummarySchema.d.ts +41 -19
  12. package/models/ListingDetail.d.ts +50 -35
  13. package/models/ListingSummary.d.ts +25 -15
  14. package/models/MarketingPlanDetailSchema.d.ts +4 -3
  15. package/models/MarketingPlanSearchResultsSchema.d.ts +4 -3
  16. package/models/MarketingPlanSummarySchema.d.ts +4 -3
  17. package/models/PatchInventorySchema.d.ts +11 -0
  18. package/models/PatchInventorySchema.js +1 -0
  19. package/models/PatchListingSchema.d.ts +1 -1
  20. package/models/SearchResultsBidSchema.d.ts +25 -20
  21. package/models/SearchResultsListingSchema.d.ts +25 -15
  22. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -47,6 +47,7 @@ export type { NewsFeed } from './models/NewsFeed.js';
47
47
  export type { PatchBid } from './models/PatchBid.js';
48
48
  export type { PatchBidOfferSchema } from './models/PatchBidOfferSchema.js';
49
49
  export type { PatchBidOption } from './models/PatchBidOption.js';
50
+ export type { PatchInventorySchema } from './models/PatchInventorySchema.js';
50
51
  export type { PatchListingAdjustTradeSchema } from './models/PatchListingAdjustTradeSchema.js';
51
52
  export type { PatchListingSchema } from './models/PatchListingSchema.js';
52
53
  export type { PatchListingSubstatusSchema } from './models/PatchListingSubstatusSchema.js';
package/models/BidDetail.d.ts CHANGED
@@ -15,8 +15,10 @@ export type BidDetail = {
15
15
  organisationName: string;
16
16
  organisationLogo: string;
17
17
  organisationVetted: boolean;
18
- businessUnitId: string;
19
- businessUnitName: string;
18
+ businessId: string;
19
+ businessName: string;
20
+ businessUnitId?: string;
21
+ businessUnitName?: string;
20
22
  businessCollectionAddressId: number | null;
21
23
  businessCollectionAddress: {
22
24
  id: number | null;
@@ -113,7 +115,6 @@ export type BidDetail = {
113
115
  haulageTypeTASCC?: boolean | null;
114
116
  };
115
117
  inventory: {
116
- id?: string;
117
118
  type: 'crop' | 'produce';
118
119
  harvestYear: string;
119
120
  commodity: {
@@ -129,7 +130,6 @@ export type BidDetail = {
129
130
  id: number;
130
131
  name: string;
131
132
  };
132
- variety?: string;
133
133
  varieties: Array<string>;
134
134
  attributes: Array<{
135
135
  id: number;
@@ -142,6 +142,27 @@ export type BidDetail = {
142
142
  weight?: number;
143
143
  };
144
144
  };
145
+ measures: Array<{
146
+ specification: {
147
+ id: number;
148
+ name: string;
149
+ unit: string;
150
+ };
151
+ min: number | null;
152
+ max: number | null;
153
+ }> | null;
154
+ hasSampled: boolean;
155
+ customMeasures: boolean | null;
156
+ files?: Array<{
157
+ name?: string;
158
+ id: string;
159
+ url?: string | null;
160
+ userId?: string | null;
161
+ userName?: string | null;
162
+ organisationId?: string | null;
163
+ createdAtUTC?: string | null;
164
+ } | null>;
165
+ id?: string;
145
166
  weight: {
146
167
  min: {
147
168
  name: string;
@@ -154,17 +175,6 @@ export type BidDetail = {
154
175
  weight?: number;
155
176
  };
156
177
  };
157
- measures: Array<{
158
- specification: {
159
- id: number;
160
- name: string;
161
- unit: string;
162
- };
163
- min: number | null;
164
- max: number | null;
165
- }> | null;
166
- hasSampled: boolean | null;
167
- customMeasures: boolean | null;
168
178
  };
169
179
  activeBids: number;
170
180
  bidInfo: {
@@ -259,12 +269,7 @@ export type BidDetail = {
259
269
  vatNumber?: string | null;
260
270
  };
261
271
  userId: string;
262
- userFullName?: string;
263
272
  organisationId?: string;
264
- organisationCreatedAtUTC?: string;
265
- organisationName?: string;
266
- organisationLogo?: string;
267
- organisationVetted?: boolean;
268
273
  createdAtUTC: string;
269
274
  status: 'active' | 'accepted' | 'withdrawn' | 'expired' | 'expiredOffered' | 'expiredOfferDeclined' | 'closed';
270
275
  expiresAtUTC: string;
package/models/ContractDetail.d.ts CHANGED
@@ -2,11 +2,12 @@ export type ContractDetail = {
2
2
  id: string;
3
3
  createdAtUTC: string;
4
4
  details: {
5
- bidId: string;
6
- bidOptionId: number;
5
+ bidId: string | null;
6
+ bidOptionId: number | null;
7
7
  userId: string;
8
8
  listingId: string | null;
9
- reference: string;
9
+ inventoryId: string;
10
+ reference: string | null;
10
11
  totalWeight: {
11
12
  name: string;
12
13
  conversion: number;
@@ -39,6 +40,55 @@ export type ContractDetail = {
39
40
  } | null>;
40
41
  terms: string | null;
41
42
  };
43
+ crop: {
44
+ type: 'crop' | 'produce';
45
+ harvestYear: string;
46
+ commodity: {
47
+ commodity: {
48
+ id: number;
49
+ name: string;
50
+ };
51
+ type: {
52
+ id: number;
53
+ name: string;
54
+ };
55
+ grade: {
56
+ id: number;
57
+ name: string;
58
+ };
59
+ varieties: Array<string>;
60
+ attributes: Array<{
61
+ id: number;
62
+ name: string;
63
+ }>;
64
+ tags?: Array<number>;
65
+ weight: {
66
+ name: string;
67
+ conversion: number;
68
+ weight?: number;
69
+ };
70
+ };
71
+ measures: Array<{
72
+ specification: {
73
+ id: number;
74
+ name: string;
75
+ unit: string;
76
+ };
77
+ min: number | null;
78
+ max: number | null;
79
+ }> | null;
80
+ hasSampled: boolean;
81
+ customMeasures?: boolean | null;
82
+ files: Array<{
83
+ name?: string;
84
+ id: string;
85
+ url?: string | null;
86
+ userId?: string | null;
87
+ userName?: string | null;
88
+ organisationId?: string | null;
89
+ createdAtUTC?: string | null;
90
+ } | null>;
91
+ };
42
92
  inventory?: {
43
93
  type: 'crop' | 'produce';
44
94
  harvestYear: string;
@@ -55,7 +105,6 @@ export type ContractDetail = {
55
105
  id: number;
56
106
  name: string;
57
107
  };
58
- variety?: string;
59
108
  varieties: Array<string>;
60
109
  attributes: Array<{
61
110
  id: number;
@@ -76,7 +125,18 @@ export type ContractDetail = {
76
125
  };
77
126
  min: number | null;
78
127
  max: number | null;
79
- }>;
128
+ }> | null;
129
+ hasSampled: boolean;
130
+ customMeasures?: boolean | null;
131
+ files: Array<{
132
+ name?: string;
133
+ id: string;
134
+ url?: string | null;
135
+ userId?: string | null;
136
+ userName?: string | null;
137
+ organisationId?: string | null;
138
+ createdAtUTC?: string | null;
139
+ } | null>;
80
140
  };
81
141
  buyer: {
82
142
  organisationId: string;
@@ -97,6 +157,7 @@ export type ContractDetail = {
97
157
  buyerNotes?: string;
98
158
  sellerNotes?: string;
99
159
  regionISO: string;
160
+ saleType: 'on-platform' | 'off-platform';
100
161
  bid?: {
101
162
  id: string;
102
163
  listingId: string;
@@ -114,8 +175,10 @@ export type ContractDetail = {
114
175
  organisationName: string;
115
176
  organisationLogo: string;
116
177
  organisationVetted: boolean;
117
- businessUnitId: string;
118
- businessUnitName: string;
178
+ businessId: string;
179
+ businessName: string;
180
+ businessUnitId?: string;
181
+ businessUnitName?: string;
119
182
  businessCollectionAddressId: number | null;
120
183
  businessCollectionAddress: {
121
184
  id: number | null;
@@ -212,7 +275,6 @@ export type ContractDetail = {
212
275
  haulageTypeTASCC?: boolean | null;
213
276
  };
214
277
  inventory: {
215
- id?: string;
216
278
  type: 'crop' | 'produce';
217
279
  harvestYear: string;
218
280
  commodity: {
@@ -228,7 +290,6 @@ export type ContractDetail = {
228
290
  id: number;
229
291
  name: string;
230
292
  };
231
- variety?: string;
232
293
  varieties: Array<string>;
233
294
  attributes: Array<{
234
295
  id: number;
@@ -241,6 +302,27 @@ export type ContractDetail = {
241
302
  weight?: number;
242
303
  };
243
304
  };
305
+ measures: Array<{
306
+ specification: {
307
+ id: number;
308
+ name: string;
309
+ unit: string;
310
+ };
311
+ min: number | null;
312
+ max: number | null;
313
+ }> | null;
314
+ hasSampled: boolean;
315
+ customMeasures: boolean | null;
316
+ files?: Array<{
317
+ name?: string;
318
+ id: string;
319
+ url?: string | null;
320
+ userId?: string | null;
321
+ userName?: string | null;
322
+ organisationId?: string | null;
323
+ createdAtUTC?: string | null;
324
+ } | null>;
325
+ id?: string;
244
326
  weight: {
245
327
  min: {
246
328
  name: string;
@@ -253,17 +335,6 @@ export type ContractDetail = {
253
335
  weight?: number;
254
336
  };
255
337
  };
256
- measures: Array<{
257
- specification: {
258
- id: number;
259
- name: string;
260
- unit: string;
261
- };
262
- min: number | null;
263
- max: number | null;
264
- }> | null;
265
- hasSampled: boolean | null;
266
- customMeasures: boolean | null;
267
338
  };
268
339
  activeBids: number;
269
340
  bidInfo: {
@@ -358,12 +429,7 @@ export type ContractDetail = {
358
429
  vatNumber?: string | null;
359
430
  };
360
431
  userId: string;
361
- userFullName?: string;
362
432
  organisationId?: string;
363
- organisationCreatedAtUTC?: string;
364
- organisationName?: string;
365
- organisationLogo?: string;
366
- organisationVetted?: boolean;
367
433
  createdAtUTC: string;
368
434
  status: 'active' | 'accepted' | 'withdrawn' | 'expired' | 'expiredOffered' | 'expiredOfferDeclined' | 'closed';
369
435
  expiresAtUTC: string;
package/models/CreateContractSchema.d.ts CHANGED
@@ -3,11 +3,11 @@ export type CreateContractSchema = {
3
3
  sellerBusinessId: string;
4
4
  details: {
5
5
  reference: string | null;
6
- contractType: 'base' | 'fixed' | 'unpriced' | 'premium' | 'base-plus-oil-bonus';
6
+ contractType?: 'base' | 'fixed' | 'unpriced' | 'premium' | 'base-plus-oil-bonus';
7
7
  paymentDays?: number;
8
- haulageType: 'ex-farm' | 'delivered';
8
+ haulageType?: 'ex-farm' | 'delivered';
9
9
  contractDateUTC: string;
10
- movement: {
10
+ movement?: {
11
11
  months: Array<string>;
12
12
  asAvailable: boolean | null;
13
13
  };
package/models/CreateInventorySchema.d.ts CHANGED
@@ -1,15 +1,17 @@
1
1
  export type CreateInventorySchema = {
2
- organisationId?: string | null;
3
- organisationName?: string;
2
+ organisationId: string | null;
3
+ organisationName: string;
4
4
  businessId: string;
5
5
  businessName: string;
6
- businessUnitId?: string | null;
7
- businessUnitName?: string;
8
6
  harvestWeight?: number | null;
9
7
  targetPrice?: {
10
8
  amount: number;
11
9
  currency: string;
12
10
  } | null;
11
+ breakevenPrice?: {
12
+ amount: number;
13
+ currency: string;
14
+ } | null;
13
15
  crop: {
14
16
  type?: 'crop' | 'produce';
15
17
  harvestYear: string;
@@ -17,7 +19,6 @@ export type CreateInventorySchema = {
17
19
  id: number;
18
20
  type: number;
19
21
  grade: number | null;
20
- variety?: string | null;
21
22
  varieties?: Array<string> | null;
22
23
  tags?: Array<number> | null;
23
24
  };
@@ -38,11 +39,12 @@ export type CreateInventorySchema = {
38
39
  } | null>;
39
40
  };
40
41
  offPlatformSales?: Array<{
41
- tonnage: number;
42
- pricePerTonne: number;
42
+ soldWeight: number;
43
+ pricePerUnit: number;
43
44
  buyerId?: string | null;
44
45
  buyerName?: string | null;
45
46
  reference?: string | null;
47
+ tradeDateUTC?: string | null;
46
48
  }> | null;
47
49
  tags?: Array<string> | null;
48
50
  };
package/models/CreateListing.d.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  export type CreateListing = {
2
- businessUnitId: string | null;
2
+ businessUnitId?: string | null;
3
+ businessId?: string;
3
4
  collectionAddressId?: number | null;
4
5
  details: {
5
6
  buyerNotes?: string | null;
@@ -28,7 +29,6 @@ export type CreateListing = {
28
29
  id: number;
29
30
  type: number;
30
31
  grade: number | null;
31
- variety?: string | null;
32
32
  varieties?: Array<string> | null;
33
33
  tags?: Array<number> | null;
34
34
  };
package/models/HarvestSummarySchema.d.ts CHANGED
@@ -2,63 +2,95 @@ export type HarvestSummarySchema = {
2
2
  harvestYear: string;
3
3
  harvestYears: Array<string>;
4
4
  status: 'pending' | 'in-progress' | 'completed';
5
- harvestWeight?: {
5
+ totalHarvestWeight: {
6
6
  name: string;
7
7
  conversion: number;
8
8
  weight?: number;
9
9
  };
10
- tradedWeight: {
10
+ totalTradedWeight: {
11
11
  name: string;
12
12
  conversion: number;
13
13
  weight?: number;
14
14
  };
15
- revenueTraded: {
15
+ totalRemainingWeight: {
16
+ name: string;
17
+ conversion: number;
18
+ weight?: number;
19
+ };
20
+ totalRevenueTraded: {
16
21
  amount: number;
17
22
  currency: string;
18
23
  };
19
- revenueAvailable: {
24
+ totalRevenueUnrealised: {
20
25
  amount: number;
21
26
  currency: string;
22
27
  };
28
+ totalRemainingPercentage: number;
29
+ totalTradedPercentage: number;
23
30
  crops: Array<{
24
- inventoryId: string;
25
- title: string;
26
- harvestYear?: string;
31
+ hexCode: string;
32
+ harvestWeight: {
33
+ name: string;
34
+ conversion: number;
35
+ weight?: number;
36
+ };
27
37
  targetPrice: {
28
38
  amount: number;
29
39
  currency: string;
30
- };
31
- hitTargetPrice: {
40
+ } | null;
41
+ breakevenPrice: {
32
42
  amount: number;
33
43
  currency: string;
34
- };
44
+ } | null;
35
45
  averagePrice: {
36
46
  amount: number;
37
47
  currency: string;
38
- };
39
- spotPrice: {
48
+ } | null;
49
+ hitTargetPrice: {
40
50
  amount: number;
41
51
  currency: string;
42
- };
43
- harvestWeight: {
52
+ } | null;
53
+ offPlatformRevenue: {
54
+ amount: number;
55
+ currency: string;
56
+ } | null;
57
+ offPlatformTradedWeight?: {
44
58
  name: string;
45
59
  conversion: number;
46
60
  weight?: number;
47
61
  };
48
- tradedWeight: {
62
+ offPlatformTradedCount: number;
63
+ onPlatformRevenue: {
64
+ amount: number;
65
+ currency: string;
66
+ } | null;
67
+ onPlatformTradedWeight?: {
49
68
  name: string;
50
69
  conversion: number;
51
70
  weight?: number;
52
71
  };
53
- revenueTraded: {
72
+ onPlatformTradedCount: number;
73
+ totalRevenue: {
54
74
  amount: number;
55
75
  currency: string;
76
+ } | null;
77
+ totalTradedWeight: {
78
+ name: string;
79
+ conversion: number;
80
+ weight?: number;
56
81
  };
57
- revenueAvailable: {
82
+ totalTradedCount?: number;
83
+ totalUnrealisedRevenue: {
84
+ amount: number;
85
+ currency: string;
86
+ } | null;
87
+ inventoryId: string;
88
+ title: string;
89
+ harvestYear: string;
90
+ spotPrice?: {
58
91
  amount: number;
59
92
  currency: string;
60
93
  };
61
- hexCode: string | null;
62
94
  updatedAtUTC: string;
63
95
  }>;
64
96
  };
package/models/InventoryDetailSchema.d.ts CHANGED
@@ -4,8 +4,6 @@ export type InventoryDetailSchema = {
4
4
  updatedAtUTC: string;
5
5
  businessId: string;
6
6
  businessName: string;
7
- businessUnitId: string;
8
- businessUnitName: string;
9
7
  organisationId: string;
10
8
  organisationName: string;
11
9
  status: 'active' | 'deleted';
@@ -25,7 +23,6 @@ export type InventoryDetailSchema = {
25
23
  id: number;
26
24
  name: string;
27
25
  };
28
- variety?: string;
29
26
  varieties: Array<string>;
30
27
  attributes: Array<{
31
28
  id: number;
@@ -59,47 +56,60 @@ export type InventoryDetailSchema = {
59
56
  createdAtUTC?: string | null;
60
57
  } | null>;
61
58
  };
62
- offPlatformSales: Array<{
63
- tonnage: {
59
+ summary: {
60
+ hexCode: string;
61
+ harvestWeight: {
64
62
  name: string;
65
63
  conversion: number;
66
64
  weight?: number;
67
65
  };
68
- pricePerTonne: {
66
+ targetPrice: {
69
67
  amount: number;
70
68
  currency: string;
71
69
  } | null;
72
- reference?: string | null;
73
- buyerId?: string | null;
74
- buyerName?: string | null;
75
- }>;
76
- summary: {
77
- harvestWeight: {
78
- name: string;
79
- conversion: number;
80
- weight?: number;
70
+ breakevenPrice: {
71
+ amount: number;
72
+ currency: string;
73
+ } | null;
74
+ averagePrice: {
75
+ amount: number;
76
+ currency: string;
77
+ } | null;
78
+ hitTargetPrice: {
79
+ amount: number;
80
+ currency: string;
81
81
  } | null;
82
- tradedWeight: {
82
+ offPlatformRevenue: {
83
+ amount: number;
84
+ currency: string;
85
+ } | null;
86
+ offPlatformTradedWeight?: {
83
87
  name: string;
84
88
  conversion: number;
85
89
  weight?: number;
86
90
  };
87
- listedWeight: {
91
+ offPlatformTradedCount: number;
92
+ onPlatformRevenue: {
93
+ amount: number;
94
+ currency: string;
95
+ } | null;
96
+ onPlatformTradedWeight?: {
88
97
  name: string;
89
98
  conversion: number;
90
99
  weight?: number;
91
100
  };
92
- listingCount: number;
93
- tradedCount: number;
94
- targetPrice: {
95
- amount: number;
96
- currency: string;
97
- } | null;
98
- averagePrice: {
101
+ onPlatformTradedCount: number;
102
+ totalRevenue: {
99
103
  amount: number;
100
104
  currency: string;
101
105
  } | null;
102
- revenue: {
106
+ totalTradedWeight: {
107
+ name: string;
108
+ conversion: number;
109
+ weight?: number;
110
+ };
111
+ totalTradedCount?: number;
112
+ totalUnrealisedRevenue: {
103
113
  amount: number;
104
114
  currency: string;
105
115
  } | null;
@@ -109,4 +119,8 @@ export type InventoryDetailSchema = {
109
119
  id: string;
110
120
  name: string;
111
121
  }>;
122
+ trades: Array<{
123
+ id: string;
124
+ name: string;
125
+ }>;
112
126
  };
package/models/InventorySchema.d.ts CHANGED
@@ -14,7 +14,6 @@ export type InventorySchema = {
14
14
  id: number;
15
15
  name: string;
16
16
  };
17
- variety?: string;
18
17
  varieties: Array<string>;
19
18
  attributes: Array<{
20
19
  id: number;
package/models/InventorySearchResultsSchema.d.ts CHANGED
@@ -5,8 +5,6 @@ export type InventorySearchResultsSchema = {
5
5
  updatedAtUTC: string;
6
6
  businessId: string;
7
7
  businessName: string;
8
- businessUnitId: string;
9
- businessUnitName: string;
10
8
  organisationId: string;
11
9
  organisationName: string;
12
10
  status: 'active' | 'deleted';
@@ -26,7 +24,6 @@ export type InventorySearchResultsSchema = {
26
24
  id: number;
27
25
  name: string;
28
26
  };
29
- variety?: string;
30
27
  varieties: Array<string>;
31
28
  attributes: Array<{
32
29
  id: number;
@@ -60,47 +57,60 @@ export type InventorySearchResultsSchema = {
60
57
  createdAtUTC?: string | null;
61
58
  } | null>;
62
59
  };
63
- offPlatformSales: Array<{
64
- tonnage: {
60
+ summary: {
61
+ hexCode: string;
62
+ harvestWeight: {
65
63
  name: string;
66
64
  conversion: number;
67
65
  weight?: number;
68
66
  };
69
- pricePerTonne: {
67
+ targetPrice: {
70
68
  amount: number;
71
69
  currency: string;
72
70
  } | null;
73
- reference?: string | null;
74
- buyerId?: string | null;
75
- buyerName?: string | null;
76
- }>;
77
- summary: {
78
- harvestWeight: {
79
- name: string;
80
- conversion: number;
81
- weight?: number;
71
+ breakevenPrice: {
72
+ amount: number;
73
+ currency: string;
74
+ } | null;
75
+ averagePrice: {
76
+ amount: number;
77
+ currency: string;
78
+ } | null;
79
+ hitTargetPrice: {
80
+ amount: number;
81
+ currency: string;
82
82
  } | null;
83
- tradedWeight: {
83
+ offPlatformRevenue: {
84
+ amount: number;
85
+ currency: string;
86
+ } | null;
87
+ offPlatformTradedWeight?: {
84
88
  name: string;
85
89
  conversion: number;
86
90
  weight?: number;
87
91
  };
88
- listedWeight: {
92
+ offPlatformTradedCount: number;
93
+ onPlatformRevenue: {
94
+ amount: number;
95
+ currency: string;
96
+ } | null;
97
+ onPlatformTradedWeight?: {
89
98
  name: string;
90
99
  conversion: number;
91
100
  weight?: number;
92
101
  };
93
- listingCount: number;
94
- tradedCount: number;
95
- targetPrice: {
96
- amount: number;
97
- currency: string;
98
- } | null;
99
- averagePrice: {
102
+ onPlatformTradedCount: number;
103
+ totalRevenue: {
100
104
  amount: number;
101
105
  currency: string;
102
106
  } | null;
103
- revenue: {
107
+ totalTradedWeight: {
108
+ name: string;
109
+ conversion: number;
110
+ weight?: number;
111
+ };
112
+ totalTradedCount?: number;
113
+ totalUnrealisedRevenue: {
104
114
  amount: number;
105
115
  currency: string;
106
116
  } | null;
@@ -110,6 +120,10 @@ export type InventorySearchResultsSchema = {
110
120
  id: string;
111
121
  name: string;
112
122
  }>;
123
+ trades: Array<{
124
+ id: string;
125
+ name: string;
126
+ }>;
113
127
  }>;
114
128
  custom?: any;
115
129
  totalDocs: number;
package/models/InventorySummarySchema.d.ts CHANGED
@@ -1,36 +1,58 @@
1
1
  export type InventorySummarySchema = {
2
- id: string;
3
- organisationId: string;
4
- organisationName: string;
5
- businessId: string;
6
- businessName: string;
7
- businessUnitId: string;
8
- businessUnitName: string;
9
- commodityId: number;
10
- commodityTypeId: number;
11
- commodityGradeId: number;
12
- tagsIds: Array<number>;
13
- harvestYear: string;
14
- commodity: string;
15
- type: string;
16
- grade: string;
17
- tags: string;
18
- varieties: string;
2
+ hexCode: string;
3
+ harvestWeight: {
4
+ name: string;
5
+ conversion: number;
6
+ weight?: number;
7
+ };
19
8
  targetPrice: {
20
9
  amount: number;
21
10
  currency: string;
22
11
  } | null;
12
+ breakevenPrice: {
13
+ amount: number;
14
+ currency: string;
15
+ } | null;
23
16
  averagePrice: {
24
17
  amount: number;
25
18
  currency: string;
26
19
  } | null;
27
- revenue: {
20
+ hitTargetPrice: {
28
21
  amount: number;
29
22
  currency: string;
30
23
  } | null;
31
- harvestWeight: {
24
+ offPlatformRevenue: {
25
+ amount: number;
26
+ currency: string;
27
+ } | null;
28
+ offPlatformTradedWeight?: {
32
29
  name: string;
33
30
  conversion: number;
34
31
  weight?: number;
35
32
  };
33
+ offPlatformTradedCount: number;
34
+ onPlatformRevenue: {
35
+ amount: number;
36
+ currency: string;
37
+ } | null;
38
+ onPlatformTradedWeight?: {
39
+ name: string;
40
+ conversion: number;
41
+ weight?: number;
42
+ };
43
+ onPlatformTradedCount: number;
44
+ totalRevenue: {
45
+ amount: number;
46
+ currency: string;
47
+ } | null;
48
+ totalTradedWeight: {
49
+ name: string;
50
+ conversion: number;
51
+ weight?: number;
52
+ };
53
+ totalTradedCount?: number;
54
+ totalUnrealisedRevenue: {
55
+ amount: number;
56
+ currency: string;
57
+ } | null;
36
58
  };
package/models/ListingDetail.d.ts CHANGED
@@ -12,8 +12,10 @@ export type ListingDetail = {
12
12
  organisationName: string;
13
13
  organisationLogo: string;
14
14
  organisationVetted: boolean;
15
- businessUnitId: string;
16
- businessUnitName: string;
15
+ businessId: string;
16
+ businessName: string;
17
+ businessUnitId?: string;
18
+ businessUnitName?: string;
17
19
  businessCollectionAddressId: number | null;
18
20
  businessCollectionAddress: {
19
21
  id: number | null;
@@ -110,7 +112,6 @@ export type ListingDetail = {
110
112
  haulageTypeTASCC?: boolean | null;
111
113
  };
112
114
  inventory: {
113
- id?: string;
114
115
  type: 'crop' | 'produce';
115
116
  harvestYear: string;
116
117
  commodity: {
@@ -126,7 +127,6 @@ export type ListingDetail = {
126
127
  id: number;
127
128
  name: string;
128
129
  };
129
- variety?: string;
130
130
  varieties: Array<string>;
131
131
  attributes: Array<{
132
132
  id: number;
@@ -139,6 +139,27 @@ export type ListingDetail = {
139
139
  weight?: number;
140
140
  };
141
141
  };
142
+ measures: Array<{
143
+ specification: {
144
+ id: number;
145
+ name: string;
146
+ unit: string;
147
+ };
148
+ min: number | null;
149
+ max: number | null;
150
+ }> | null;
151
+ hasSampled: boolean;
152
+ customMeasures: boolean | null;
153
+ files?: Array<{
154
+ name?: string;
155
+ id: string;
156
+ url?: string | null;
157
+ userId?: string | null;
158
+ userName?: string | null;
159
+ organisationId?: string | null;
160
+ createdAtUTC?: string | null;
161
+ } | null>;
162
+ id?: string;
142
163
  weight: {
143
164
  min: {
144
165
  name: string;
@@ -151,17 +172,6 @@ export type ListingDetail = {
151
172
  weight?: number;
152
173
  };
153
174
  };
154
- measures: Array<{
155
- specification: {
156
- id: number;
157
- name: string;
158
- unit: string;
159
- };
160
- min: number | null;
161
- max: number | null;
162
- }> | null;
163
- hasSampled: boolean | null;
164
- customMeasures: boolean | null;
165
175
  };
166
176
  activeBids: number;
167
177
  bidInfo: {
@@ -254,8 +264,10 @@ export type ListingDetail = {
254
264
  organisationName: string;
255
265
  organisationLogo: string;
256
266
  organisationVetted: boolean;
257
- businessUnitId: string;
258
- businessUnitName: string;
267
+ businessId: string;
268
+ businessName: string;
269
+ businessUnitId?: string;
270
+ businessUnitName?: string;
259
271
  businessCollectionAddressId: number | null;
260
272
  businessCollectionAddress: {
261
273
  id: number | null;
@@ -352,7 +364,6 @@ export type ListingDetail = {
352
364
  haulageTypeTASCC?: boolean | null;
353
365
  };
354
366
  inventory: {
355
- id?: string;
356
367
  type: 'crop' | 'produce';
357
368
  harvestYear: string;
358
369
  commodity: {
@@ -368,7 +379,6 @@ export type ListingDetail = {
368
379
  id: number;
369
380
  name: string;
370
381
  };
371
- variety?: string;
372
382
  varieties: Array<string>;
373
383
  attributes: Array<{
374
384
  id: number;
@@ -381,6 +391,27 @@ export type ListingDetail = {
381
391
  weight?: number;
382
392
  };
383
393
  };
394
+ measures: Array<{
395
+ specification: {
396
+ id: number;
397
+ name: string;
398
+ unit: string;
399
+ };
400
+ min: number | null;
401
+ max: number | null;
402
+ }> | null;
403
+ hasSampled: boolean;
404
+ customMeasures: boolean | null;
405
+ files?: Array<{
406
+ name?: string;
407
+ id: string;
408
+ url?: string | null;
409
+ userId?: string | null;
410
+ userName?: string | null;
411
+ organisationId?: string | null;
412
+ createdAtUTC?: string | null;
413
+ } | null>;
414
+ id?: string;
384
415
  weight: {
385
416
  min: {
386
417
  name: string;
@@ -393,17 +424,6 @@ export type ListingDetail = {
393
424
  weight?: number;
394
425
  };
395
426
  };
396
- measures: Array<{
397
- specification: {
398
- id: number;
399
- name: string;
400
- unit: string;
401
- };
402
- min: number | null;
403
- max: number | null;
404
- }> | null;
405
- hasSampled: boolean | null;
406
- customMeasures: boolean | null;
407
427
  };
408
428
  activeBids: number;
409
429
  bidInfo: {
@@ -498,12 +518,7 @@ export type ListingDetail = {
498
518
  vatNumber?: string | null;
499
519
  };
500
520
  userId: string;
501
- userFullName?: string;
502
521
  organisationId?: string;
503
- organisationCreatedAtUTC?: string;
504
- organisationName?: string;
505
- organisationLogo?: string;
506
- organisationVetted?: boolean;
507
522
  createdAtUTC: string;
508
523
  status: 'active' | 'accepted' | 'withdrawn' | 'expired' | 'expiredOffered' | 'expiredOfferDeclined' | 'closed';
509
524
  expiresAtUTC: string;
package/models/ListingSummary.d.ts CHANGED
@@ -12,8 +12,10 @@ export type ListingSummary = {
12
12
  organisationName: string;
13
13
  organisationLogo: string;
14
14
  organisationVetted: boolean;
15
- businessUnitId: string;
16
- businessUnitName: string;
15
+ businessId: string;
16
+ businessName: string;
17
+ businessUnitId?: string;
18
+ businessUnitName?: string;
17
19
  businessCollectionAddressId: number | null;
18
20
  businessCollectionAddress: {
19
21
  id: number | null;
@@ -110,7 +112,6 @@ export type ListingSummary = {
110
112
  haulageTypeTASCC?: boolean | null;
111
113
  };
112
114
  inventory: {
113
- id?: string;
114
115
  type: 'crop' | 'produce';
115
116
  harvestYear: string;
116
117
  commodity: {
@@ -126,7 +127,6 @@ export type ListingSummary = {
126
127
  id: number;
127
128
  name: string;
128
129
  };
129
- variety?: string;
130
130
  varieties: Array<string>;
131
131
  attributes: Array<{
132
132
  id: number;
@@ -139,6 +139,27 @@ export type ListingSummary = {
139
139
  weight?: number;
140
140
  };
141
141
  };
142
+ measures: Array<{
143
+ specification: {
144
+ id: number;
145
+ name: string;
146
+ unit: string;
147
+ };
148
+ min: number | null;
149
+ max: number | null;
150
+ }> | null;
151
+ hasSampled: boolean;
152
+ customMeasures: boolean | null;
153
+ files?: Array<{
154
+ name?: string;
155
+ id: string;
156
+ url?: string | null;
157
+ userId?: string | null;
158
+ userName?: string | null;
159
+ organisationId?: string | null;
160
+ createdAtUTC?: string | null;
161
+ } | null>;
162
+ id?: string;
142
163
  weight: {
143
164
  min: {
144
165
  name: string;
@@ -151,17 +172,6 @@ export type ListingSummary = {
151
172
  weight?: number;
152
173
  };
153
174
  };
154
- measures: Array<{
155
- specification: {
156
- id: number;
157
- name: string;
158
- unit: string;
159
- };
160
- min: number | null;
161
- max: number | null;
162
- }> | null;
163
- hasSampled: boolean | null;
164
- customMeasures: boolean | null;
165
175
  };
166
176
  activeBids: number;
167
177
  bidInfo: {
package/models/MarketingPlanDetailSchema.d.ts CHANGED
@@ -1,8 +1,10 @@
1
1
  export type MarketingPlanDetailSchema = {
2
2
  id: string;
3
3
  createdAtUTC?: string;
4
- businessUnitId: string;
5
- businessUnitName: string;
4
+ businessId: string;
5
+ businessName: string;
6
+ businessUnitId?: string;
7
+ businessUnitName?: string;
6
8
  organisationId: string;
7
9
  organisationName: string;
8
10
  inventoryId: string;
@@ -23,7 +25,6 @@ export type MarketingPlanDetailSchema = {
23
25
  id: number;
24
26
  name: string;
25
27
  };
26
- variety?: string;
27
28
  varieties: Array<string>;
28
29
  attributes: Array<{
29
30
  id: number;
package/models/MarketingPlanSearchResultsSchema.d.ts CHANGED
@@ -2,8 +2,10 @@ export type MarketingPlanSearchResultsSchema = {
2
2
  docs: Array<{
3
3
  id: string;
4
4
  createdAtUTC?: string;
5
- businessUnitId: string;
6
- businessUnitName: string;
5
+ businessId: string;
6
+ businessName: string;
7
+ businessUnitId?: string;
8
+ businessUnitName?: string;
7
9
  organisationId: string;
8
10
  organisationName: string;
9
11
  inventoryId: string;
@@ -24,7 +26,6 @@ export type MarketingPlanSearchResultsSchema = {
24
26
  id: number;
25
27
  name: string;
26
28
  };
27
- variety?: string;
28
29
  varieties: Array<string>;
29
30
  attributes: Array<{
30
31
  id: number;
package/models/MarketingPlanSummarySchema.d.ts CHANGED
@@ -1,8 +1,10 @@
1
1
  export type MarketingPlanSummarySchema = {
2
2
  id: string;
3
3
  createdAtUTC?: string;
4
- businessUnitId: string;
5
- businessUnitName: string;
4
+ businessId: string;
5
+ businessName: string;
6
+ businessUnitId?: string;
7
+ businessUnitName?: string;
6
8
  organisationId: string;
7
9
  organisationName: string;
8
10
  inventoryId: string;
@@ -23,7 +25,6 @@ export type MarketingPlanSummarySchema = {
23
25
  id: number;
24
26
  name: string;
25
27
  };
26
- variety?: string;
27
28
  varieties: Array<string>;
28
29
  attributes: Array<{
29
30
  id: number;
package/models/PatchInventorySchema.d.ts ADDED
@@ -0,0 +1,11 @@
1
+ export type PatchInventorySchema = {
2
+ harvestWeight: number;
3
+ targetPrice: {
4
+ amount: number;
5
+ currency: string;
6
+ };
7
+ breakevenPrice?: {
8
+ amount: number;
9
+ currency: string;
10
+ };
11
+ };
package/models/PatchInventorySchema.js ADDED
@@ -0,0 +1 @@
1
+ export {};
package/models/PatchListingSchema.d.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  export type PatchListingSchema = {
2
2
  businessUnitId?: string | null;
3
+ businessId?: string | null;
3
4
  collectionAddressId?: number | null;
4
5
  details?: {
5
6
  buyerNotes?: string | null;
@@ -28,7 +29,6 @@ export type PatchListingSchema = {
28
29
  id: number;
29
30
  type: number;
30
31
  grade: number | null;
31
- variety?: string | null;
32
32
  varieties?: Array<string> | null;
33
33
  tags?: Array<number> | null;
34
34
  };
package/models/SearchResultsBidSchema.d.ts CHANGED
@@ -16,8 +16,10 @@ export type SearchResultsBidSchema = {
16
16
  organisationName: string;
17
17
  organisationLogo: string;
18
18
  organisationVetted: boolean;
19
- businessUnitId: string;
20
- businessUnitName: string;
19
+ businessId: string;
20
+ businessName: string;
21
+ businessUnitId?: string;
22
+ businessUnitName?: string;
21
23
  businessCollectionAddressId: number | null;
22
24
  businessCollectionAddress: {
23
25
  id: number | null;
@@ -114,7 +116,6 @@ export type SearchResultsBidSchema = {
114
116
  haulageTypeTASCC?: boolean | null;
115
117
  };
116
118
  inventory: {
117
- id?: string;
118
119
  type: 'crop' | 'produce';
119
120
  harvestYear: string;
120
121
  commodity: {
@@ -130,7 +131,6 @@ export type SearchResultsBidSchema = {
130
131
  id: number;
131
132
  name: string;
132
133
  };
133
- variety?: string;
134
134
  varieties: Array<string>;
135
135
  attributes: Array<{
136
136
  id: number;
@@ -143,6 +143,27 @@ export type SearchResultsBidSchema = {
143
143
  weight?: number;
144
144
  };
145
145
  };
146
+ measures: Array<{
147
+ specification: {
148
+ id: number;
149
+ name: string;
150
+ unit: string;
151
+ };
152
+ min: number | null;
153
+ max: number | null;
154
+ }> | null;
155
+ hasSampled: boolean;
156
+ customMeasures: boolean | null;
157
+ files?: Array<{
158
+ name?: string;
159
+ id: string;
160
+ url?: string | null;
161
+ userId?: string | null;
162
+ userName?: string | null;
163
+ organisationId?: string | null;
164
+ createdAtUTC?: string | null;
165
+ } | null>;
166
+ id?: string;
146
167
  weight: {
147
168
  min: {
148
169
  name: string;
@@ -155,17 +176,6 @@ export type SearchResultsBidSchema = {
155
176
  weight?: number;
156
177
  };
157
178
  };
158
- measures: Array<{
159
- specification: {
160
- id: number;
161
- name: string;
162
- unit: string;
163
- };
164
- min: number | null;
165
- max: number | null;
166
- }> | null;
167
- hasSampled: boolean | null;
168
- customMeasures: boolean | null;
169
179
  };
170
180
  activeBids: number;
171
181
  bidInfo: {
@@ -260,12 +270,7 @@ export type SearchResultsBidSchema = {
260
270
  vatNumber?: string | null;
261
271
  };
262
272
  userId: string;
263
- userFullName?: string;
264
273
  organisationId?: string;
265
- organisationCreatedAtUTC?: string;
266
- organisationName?: string;
267
- organisationLogo?: string;
268
- organisationVetted?: boolean;
269
274
  createdAtUTC: string;
270
275
  status: 'active' | 'accepted' | 'withdrawn' | 'expired' | 'expiredOffered' | 'expiredOfferDeclined' | 'closed';
271
276
  expiresAtUTC: string;
package/models/SearchResultsListingSchema.d.ts CHANGED
@@ -13,8 +13,10 @@ export type SearchResultsListingSchema = {
13
13
  organisationName: string;
14
14
  organisationLogo: string;
15
15
  organisationVetted: boolean;
16
- businessUnitId: string;
17
- businessUnitName: string;
16
+ businessId: string;
17
+ businessName: string;
18
+ businessUnitId?: string;
19
+ businessUnitName?: string;
18
20
  businessCollectionAddressId: number | null;
19
21
  businessCollectionAddress: {
20
22
  id: number | null;
@@ -111,7 +113,6 @@ export type SearchResultsListingSchema = {
111
113
  haulageTypeTASCC?: boolean | null;
112
114
  };
113
115
  inventory: {
114
- id?: string;
115
116
  type: 'crop' | 'produce';
116
117
  harvestYear: string;
117
118
  commodity: {
@@ -127,7 +128,6 @@ export type SearchResultsListingSchema = {
127
128
  id: number;
128
129
  name: string;
129
130
  };
130
- variety?: string;
131
131
  varieties: Array<string>;
132
132
  attributes: Array<{
133
133
  id: number;
@@ -140,6 +140,27 @@ export type SearchResultsListingSchema = {
140
140
  weight?: number;
141
141
  };
142
142
  };
143
+ measures: Array<{
144
+ specification: {
145
+ id: number;
146
+ name: string;
147
+ unit: string;
148
+ };
149
+ min: number | null;
150
+ max: number | null;
151
+ }> | null;
152
+ hasSampled: boolean;
153
+ customMeasures: boolean | null;
154
+ files?: Array<{
155
+ name?: string;
156
+ id: string;
157
+ url?: string | null;
158
+ userId?: string | null;
159
+ userName?: string | null;
160
+ organisationId?: string | null;
161
+ createdAtUTC?: string | null;
162
+ } | null>;
163
+ id?: string;
143
164
  weight: {
144
165
  min: {
145
166
  name: string;
@@ -152,17 +173,6 @@ export type SearchResultsListingSchema = {
152
173
  weight?: number;
153
174
  };
154
175
  };
155
- measures: Array<{
156
- specification: {
157
- id: number;
158
- name: string;
159
- unit: string;
160
- };
161
- min: number | null;
162
- max: number | null;
163
- }> | null;
164
- hasSampled: boolean | null;
165
- customMeasures: boolean | null;
166
176
  };
167
177
  activeBids: number;
168
178
  bidInfo: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hectare/platform.clients.trading",
3
- "version": "1.1.241",
3
+ "version": "1.1.242",
4
4
  "main": "index.js",
5
5
  "exported": true,
6
6
  "types": "index.d.ts",