@hectare/platform.clients.trading 1.1.117 → 1.1.118

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.
package/index.d.ts CHANGED
@@ -23,6 +23,7 @@ export type { ContractsTradedPeriod } from './models/ContractsTradedPeriod.js';
23
23
  export type { CreateBid } from './models/CreateBid.js';
24
24
  export type { CreateContractDeliverySchema } from './models/CreateContractDeliverySchema.js';
25
25
  export type { CreateContractRequest } from './models/CreateContractRequest.js';
26
+ export type { CreateInventorySchema } from './models/CreateInventorySchema.js';
26
27
  export type { CreateListing } from './models/CreateListing.js';
27
28
  export type { CreateMarketingPlanSchema } from './models/CreateMarketingPlanSchema.js';
28
29
  export type { CreateMarketUpdateRequest } from './models/CreateMarketUpdateRequest.js';
@@ -43,6 +44,10 @@ export type { InsightPriceSpreadMonths } from './models/InsightPriceSpreadMonths
43
44
  export type { InsightsDailySpotPricesByDateRangeSchema } from './models/InsightsDailySpotPricesByDateRangeSchema.js';
44
45
  export type { InsightsDailySpotPricesSchema } from './models/InsightsDailySpotPricesSchema.js';
45
46
  export type { InsightsHistoricalFuturesPricesSchema } from './models/InsightsHistoricalFuturesPricesSchema.js';
47
+ export type { InventoryDetailSchema } from './models/InventoryDetailSchema.js';
48
+ export type { InventorySchema } from './models/InventorySchema.js';
49
+ export type { InventorySearchResultsSchema } from './models/InventorySearchResultsSchema.js';
50
+ export type { InventorySummarySchema } from './models/InventorySummarySchema.js';
46
51
  export type { LinkContractSchema } from './models/LinkContractSchema.js';
47
52
  export type { ListingBidInfoBid } from './models/ListingBidInfoBid.js';
48
53
  export type { ListingDetail } from './models/ListingDetail.js';
@@ -0,0 +1,35 @@
1
+ export type CreateInventorySchema = {
2
+ organisationId?: string | null;
3
+ organisationName?: string;
4
+ businessUnitId: string | null;
5
+ businessUnitName: string;
6
+ weight?: number;
7
+ inventory?: {
8
+ type: 'crop' | 'produce';
9
+ harvestYear: string;
10
+ commodity: {
11
+ id: number;
12
+ type: number;
13
+ grade: number | null;
14
+ variety?: string | null;
15
+ varieties?: Array<string> | null;
16
+ tags?: Array<number> | null;
17
+ };
18
+ measures: Array<{
19
+ specificationId: number;
20
+ min: number | null;
21
+ max: number | null;
22
+ }> | null;
23
+ hasSampled: boolean;
24
+ files?: Array<{
25
+ name?: string;
26
+ id: string;
27
+ url?: string | null;
28
+ userId?: string | null;
29
+ userName?: string | null;
30
+ organisationId?: string | null;
31
+ createdAtUTC?: string | null;
32
+ } | null>;
33
+ };
34
+ tags?: Array<string> | null;
35
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -41,6 +41,8 @@ export type CreateListing = {
41
41
  haulageType?: 'ex-farm' | 'delivered' | null;
42
42
  };
43
43
  inventory: {
44
+ type: 'crop' | 'produce';
45
+ harvestYear: string;
44
46
  commodity: {
45
47
  id: number;
46
48
  type: number;
@@ -49,18 +51,16 @@ export type CreateListing = {
49
51
  varieties?: Array<string> | null;
50
52
  tags?: Array<number> | null;
51
53
  };
52
- harvestYear: string;
53
54
  measures: Array<{
54
55
  specificationId: number;
55
56
  min: number | null;
56
57
  max: number | null;
57
58
  }> | null;
58
- type: 'crop' | 'produce';
59
+ hasSampled?: boolean;
59
60
  weight: {
60
61
  min: number;
61
62
  max: number;
62
63
  };
63
- hasSampled?: boolean;
64
64
  };
65
65
  tags?: Array<string> | null;
66
66
  tradeRequestId?: string;
@@ -1,9 +1,10 @@
1
1
  export type CreateMarketingPlanSchema = {
2
+ inventoryId?: string | null;
2
3
  organisationId?: string | null;
3
4
  organisationName?: string;
4
5
  businessUnitId: string | null;
5
6
  businessUnitName: string;
6
- inventory: {
7
+ inventory?: {
7
8
  type: 'crop' | 'produce';
8
9
  harvestYear: string;
9
10
  commodity: {
@@ -20,6 +21,15 @@ export type CreateMarketingPlanSchema = {
20
21
  max: number | null;
21
22
  }> | null;
22
23
  hasSampled: boolean;
24
+ files?: Array<{
25
+ name?: string;
26
+ id: string;
27
+ url?: string | null;
28
+ userId?: string | null;
29
+ userName?: string | null;
30
+ organisationId?: string | null;
31
+ createdAtUTC?: string | null;
32
+ } | null>;
23
33
  };
24
34
  details: {
25
35
  files: Array<{
@@ -0,0 +1,62 @@
1
+ export type InventoryDetailSchema = {
2
+ id: string;
3
+ createdAtUTC?: string;
4
+ updatedAtUTC?: string;
5
+ businessUnitId: string;
6
+ businessUnitName: string;
7
+ organisationId: string;
8
+ organisationName: string;
9
+ status: 'active' | 'deleted';
10
+ weight: {
11
+ name: string;
12
+ conversion: number;
13
+ weight?: number;
14
+ };
15
+ details: {
16
+ type: 'crop' | 'produce';
17
+ harvestYear: string;
18
+ commodity: {
19
+ commodity: {
20
+ id: number;
21
+ name: string;
22
+ };
23
+ type: {
24
+ id: number;
25
+ name: string;
26
+ };
27
+ grade: {
28
+ id: number;
29
+ name: string;
30
+ };
31
+ variety?: string;
32
+ varieties: Array<string>;
33
+ tags: Array<number>;
34
+ weight: {
35
+ name: string;
36
+ conversion: number;
37
+ weight?: number;
38
+ };
39
+ };
40
+ measures: Array<{
41
+ specification: {
42
+ id: number;
43
+ name: string;
44
+ unit: string;
45
+ };
46
+ min: number | null;
47
+ max: number | null;
48
+ }> | null;
49
+ hasSampled: boolean;
50
+ customMeasures?: boolean | null;
51
+ files: Array<{
52
+ name?: string;
53
+ id: string;
54
+ url?: string | null;
55
+ userId?: string | null;
56
+ userName?: string | null;
57
+ organisationId?: string | null;
58
+ createdAtUTC?: string | null;
59
+ } | null>;
60
+ };
61
+ tags: Array<string>;
62
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,46 @@
1
+ export type InventorySchema = {
2
+ type: 'crop' | 'produce';
3
+ harvestYear: string;
4
+ commodity: {
5
+ commodity: {
6
+ id: number;
7
+ name: string;
8
+ };
9
+ type: {
10
+ id: number;
11
+ name: string;
12
+ };
13
+ grade: {
14
+ id: number;
15
+ name: string;
16
+ };
17
+ variety?: string;
18
+ varieties: Array<string>;
19
+ tags: Array<number>;
20
+ weight: {
21
+ name: string;
22
+ conversion: number;
23
+ weight?: number;
24
+ };
25
+ };
26
+ measures: Array<{
27
+ specification: {
28
+ id: number;
29
+ name: string;
30
+ unit: string;
31
+ };
32
+ min: number | null;
33
+ max: number | null;
34
+ }> | null;
35
+ hasSampled: boolean;
36
+ customMeasures?: boolean | null;
37
+ files: Array<{
38
+ name?: string;
39
+ id: string;
40
+ url?: string | null;
41
+ userId?: string | null;
42
+ userName?: string | null;
43
+ organisationId?: string | null;
44
+ createdAtUTC?: string | null;
45
+ } | null>;
46
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,196 @@
1
+ export type InventorySearchResultsSchema = {
2
+ docs?: Array<{
3
+ id: string;
4
+ createdAtUTC?: string;
5
+ businessUnitId: string;
6
+ businessUnitName: string;
7
+ organisationId: string;
8
+ organisationName: string;
9
+ status: 'pending' | 'active' | 'completed' | 'inactive';
10
+ inventory: {
11
+ type: 'crop' | 'produce';
12
+ harvestYear: string;
13
+ commodity: {
14
+ commodity: {
15
+ id: number;
16
+ name: string;
17
+ };
18
+ type: {
19
+ id: number;
20
+ name: string;
21
+ };
22
+ grade: {
23
+ id: number;
24
+ name: string;
25
+ };
26
+ variety?: string;
27
+ varieties: Array<string>;
28
+ tags: Array<number>;
29
+ weight: {
30
+ name: string;
31
+ conversion: number;
32
+ weight?: number;
33
+ };
34
+ };
35
+ measures: Array<{
36
+ specification: {
37
+ id: number;
38
+ name: string;
39
+ unit: string;
40
+ };
41
+ min: number | null;
42
+ max: number | null;
43
+ }> | null;
44
+ hasSampled: boolean;
45
+ customMeasures?: boolean | null;
46
+ files: Array<{
47
+ name?: string;
48
+ id: string;
49
+ url?: string | null;
50
+ userId?: string | null;
51
+ userName?: string | null;
52
+ organisationId?: string | null;
53
+ createdAtUTC?: string | null;
54
+ } | null>;
55
+ };
56
+ weight?: {
57
+ name: string;
58
+ conversion: number;
59
+ weight?: number;
60
+ };
61
+ details: {
62
+ isBasePremOnly: boolean;
63
+ targetPrice: {
64
+ amount: number;
65
+ currency: string;
66
+ } | null;
67
+ movementPeriod: {
68
+ startDateUTC: string;
69
+ endDateUTC: string;
70
+ type: 'date' | 'month';
71
+ excludedDatesUTC?: Array<string> | null;
72
+ asAvailable?: boolean | null;
73
+ };
74
+ haulageType: 'ex-farm' | 'delivered' | null;
75
+ buyerNotes: string | null;
76
+ };
77
+ strategy: {
78
+ type: 'steady';
79
+ startDateUTC: string;
80
+ endDateUTC: string;
81
+ deadlines: Array<{
82
+ id: number;
83
+ endDateUTC: string;
84
+ weight: {
85
+ name: string;
86
+ conversion: number;
87
+ weight?: number;
88
+ };
89
+ weightPerListingAvg: {
90
+ name: string;
91
+ conversion: number;
92
+ weight?: number;
93
+ };
94
+ weightPerListingMin: {
95
+ name: string;
96
+ conversion: number;
97
+ weight?: number;
98
+ };
99
+ weightPerListingMax: {
100
+ name: string;
101
+ conversion: number;
102
+ weight?: number;
103
+ };
104
+ canListLowerWeight: boolean;
105
+ }>;
106
+ priceOfferReview: {
107
+ type: 'first' | 'second' | 'third' | 'fourth' | 'last' | 'every';
108
+ dayOfWeek: 1 | 2 | 3 | 4 | 5 | 6 | 7;
109
+ hourOfDay: number;
110
+ };
111
+ };
112
+ summary: {
113
+ totalListingCount: number;
114
+ soldWeight: {
115
+ name: string;
116
+ conversion: number;
117
+ weight?: number;
118
+ };
119
+ unsoldWeight: {
120
+ name: string;
121
+ conversion: number;
122
+ weight?: number;
123
+ };
124
+ averageSoldPrice: {
125
+ amount: number;
126
+ currency: string;
127
+ } | null;
128
+ };
129
+ schedule?: Array<{
130
+ id?: number;
131
+ deadlineId?: number;
132
+ minTonnes?: number;
133
+ maxTonnes?: number;
134
+ reviewDateUTC?: string;
135
+ listingId?: string;
136
+ weight?: {
137
+ name: string;
138
+ conversion: number;
139
+ weight?: number;
140
+ };
141
+ movementPeriod?: {
142
+ startDateUTC: string;
143
+ endDateUTC: string;
144
+ type: 'date' | 'month';
145
+ };
146
+ skipped?: boolean;
147
+ }>;
148
+ tags?: Array<string>;
149
+ }>;
150
+ custom?: any;
151
+ totalDocs?: number;
152
+ limit?: number;
153
+ offset?: number;
154
+ clearUrl?: string;
155
+ activeFilters?: Array<{
156
+ name?: string;
157
+ clearUrl?: string;
158
+ terms?: Array<{
159
+ name?: string;
160
+ clearUrl?: string;
161
+ }>;
162
+ }>;
163
+ facets?: Array<{
164
+ displayName?: string;
165
+ clearUrl?: string;
166
+ disabled?: boolean;
167
+ name?: string;
168
+ selected?: boolean;
169
+ active?: boolean;
170
+ terms?: Array<{
171
+ name?: string;
172
+ url?: string;
173
+ hits?: string;
174
+ selected?: string;
175
+ id?: string;
176
+ state?: 'checked disabled' | 'checked' | 'disabled' | '';
177
+ aggregations?: Record<string, {
178
+ sum?: number;
179
+ min?: number;
180
+ max?: number;
181
+ average?: number;
182
+ }>;
183
+ }>;
184
+ }>;
185
+ aggregations?: Array<{
186
+ name?: string;
187
+ sum?: number;
188
+ min?: number;
189
+ max?: number;
190
+ average?: number;
191
+ count?: number;
192
+ range?: string;
193
+ hits?: number;
194
+ unit?: string;
195
+ }>;
196
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,62 @@
1
+ export type InventorySummarySchema = {
2
+ id: string;
3
+ createdAtUTC?: string;
4
+ updatedAtUTC?: string;
5
+ businessUnitId: string;
6
+ businessUnitName: string;
7
+ organisationId: string;
8
+ organisationName: string;
9
+ status: 'active' | 'deleted';
10
+ weight: {
11
+ name: string;
12
+ conversion: number;
13
+ weight?: number;
14
+ };
15
+ details: {
16
+ type: 'crop' | 'produce';
17
+ harvestYear: string;
18
+ commodity: {
19
+ commodity: {
20
+ id: number;
21
+ name: string;
22
+ };
23
+ type: {
24
+ id: number;
25
+ name: string;
26
+ };
27
+ grade: {
28
+ id: number;
29
+ name: string;
30
+ };
31
+ variety?: string;
32
+ varieties: Array<string>;
33
+ tags: Array<number>;
34
+ weight: {
35
+ name: string;
36
+ conversion: number;
37
+ weight?: number;
38
+ };
39
+ };
40
+ measures: Array<{
41
+ specification: {
42
+ id: number;
43
+ name: string;
44
+ unit: string;
45
+ };
46
+ min: number | null;
47
+ max: number | null;
48
+ }> | null;
49
+ hasSampled: boolean;
50
+ customMeasures?: boolean | null;
51
+ files: Array<{
52
+ name?: string;
53
+ id: string;
54
+ url?: string | null;
55
+ userId?: string | null;
56
+ userName?: string | null;
57
+ organisationId?: string | null;
58
+ createdAtUTC?: string | null;
59
+ } | null>;
60
+ };
61
+ tags: Array<string>;
62
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -31,11 +31,6 @@ export type MarketingPlanDetailSchema = {
31
31
  weight?: number;
32
32
  };
33
33
  };
34
- weight: {
35
- name: string;
36
- conversion: number;
37
- weight?: number;
38
- };
39
34
  measures: Array<{
40
35
  specification: {
41
36
  id: number;
@@ -47,8 +42,6 @@ export type MarketingPlanDetailSchema = {
47
42
  }> | null;
48
43
  hasSampled: boolean;
49
44
  customMeasures?: boolean | null;
50
- };
51
- details: {
52
45
  files: Array<{
53
46
  name?: string;
54
47
  id: string;
@@ -58,6 +51,13 @@ export type MarketingPlanDetailSchema = {
58
51
  organisationId?: string | null;
59
52
  createdAtUTC?: string | null;
60
53
  } | null>;
54
+ };
55
+ weight?: {
56
+ name: string;
57
+ conversion: number;
58
+ weight?: number;
59
+ };
60
+ details: {
61
61
  isBasePremOnly: boolean;
62
62
  targetPrice: {
63
63
  amount: number;
@@ -32,11 +32,6 @@ export type MarketingPlanSearchResultsSchema = {
32
32
  weight?: number;
33
33
  };
34
34
  };
35
- weight: {
36
- name: string;
37
- conversion: number;
38
- weight?: number;
39
- };
40
35
  measures: Array<{
41
36
  specification: {
42
37
  id: number;
@@ -48,8 +43,6 @@ export type MarketingPlanSearchResultsSchema = {
48
43
  }> | null;
49
44
  hasSampled: boolean;
50
45
  customMeasures?: boolean | null;
51
- };
52
- details: {
53
46
  files: Array<{
54
47
  name?: string;
55
48
  id: string;
@@ -59,6 +52,13 @@ export type MarketingPlanSearchResultsSchema = {
59
52
  organisationId?: string | null;
60
53
  createdAtUTC?: string | null;
61
54
  } | null>;
55
+ };
56
+ weight?: {
57
+ name: string;
58
+ conversion: number;
59
+ weight?: number;
60
+ };
61
+ details: {
62
62
  isBasePremOnly: boolean;
63
63
  targetPrice: {
64
64
  amount: number;
@@ -31,11 +31,6 @@ export type MarketingPlanSummarySchema = {
31
31
  weight?: number;
32
32
  };
33
33
  };
34
- weight: {
35
- name: string;
36
- conversion: number;
37
- weight?: number;
38
- };
39
34
  measures: Array<{
40
35
  specification: {
41
36
  id: number;
@@ -47,8 +42,6 @@ export type MarketingPlanSummarySchema = {
47
42
  }> | null;
48
43
  hasSampled: boolean;
49
44
  customMeasures?: boolean | null;
50
- };
51
- details: {
52
45
  files: Array<{
53
46
  name?: string;
54
47
  id: string;
@@ -58,6 +51,13 @@ export type MarketingPlanSummarySchema = {
58
51
  organisationId?: string | null;
59
52
  createdAtUTC?: string | null;
60
53
  } | null>;
54
+ };
55
+ weight?: {
56
+ name: string;
57
+ conversion: number;
58
+ weight?: number;
59
+ };
60
+ details: {
61
61
  isBasePremOnly: boolean;
62
62
  targetPrice: {
63
63
  amount: number;
@@ -32,6 +32,8 @@ export type PatchListingSchema = {
32
32
  haulageType?: 'ex-farm' | 'delivered' | null;
33
33
  };
34
34
  inventory?: {
35
+ type?: 'crop' | 'produce';
36
+ harvestYear?: string;
35
37
  commodity?: {
36
38
  id: number;
37
39
  type: number;
@@ -40,18 +42,16 @@ export type PatchListingSchema = {
40
42
  varieties?: Array<string> | null;
41
43
  tags?: Array<number> | null;
42
44
  };
43
- harvestYear?: string;
44
45
  measures?: Array<{
45
46
  specificationId: number;
46
47
  min: number | null;
47
48
  max: number | null;
48
49
  }> | null;
49
- type?: 'crop' | 'produce';
50
+ hasSampled?: boolean;
50
51
  weight?: {
51
52
  min: number;
52
53
  max: number;
53
54
  };
54
- hasSampled?: boolean;
55
55
  };
56
56
  feedback?: {
57
57
  sellerTargetPrice?: {
@@ -4,6 +4,8 @@ export type PatchMarketingPlanScheduleSchema = {
4
4
  deadlineId?: number;
5
5
  reviewDateUTC: string;
6
6
  weight: number;
7
+ minWeight: number;
8
+ maxWeight: number;
7
9
  movementPeriod: {
8
10
  startDateUTC: string;
9
11
  endDateUTC: string;
@@ -1,4 +1,5 @@
1
1
  export type PatchMarketingPlanSchema = {
2
+ inventoryId?: string | null;
2
3
  organisationId?: string | null;
3
4
  organisationName?: string;
4
5
  businessUnitId: string | null;
@@ -20,6 +21,15 @@ export type PatchMarketingPlanSchema = {
20
21
  max: number | null;
21
22
  }> | null;
22
23
  hasSampled: boolean;
24
+ files?: Array<{
25
+ name?: string;
26
+ id: string;
27
+ url?: string | null;
28
+ userId?: string | null;
29
+ userName?: string | null;
30
+ organisationId?: string | null;
31
+ createdAtUTC?: string | null;
32
+ } | null>;
23
33
  };
24
34
  details: {
25
35
  files: Array<{
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hectare/platform.clients.trading",
3
- "version": "1.1.117",
3
+ "version": "1.1.118",
4
4
  "main": "index.js",
5
5
  "exported": true,
6
6
  "types": "index.d.ts",