@hectare/platform.clients.trading 1.1.1

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 (121) hide show
  1. package/index.d.ts +59 -0
  2. package/index.js +1 -0
  3. package/models/AcceptBid.d.ts +5 -0
  4. package/models/AcceptBid.js +1 -0
  5. package/models/AdvancePayContractSchema.d.ts +133 -0
  6. package/models/AdvancePayContractSchema.js +1 -0
  7. package/models/AdvancePayOfferSchema.d.ts +62 -0
  8. package/models/AdvancePayOfferSchema.js +1 -0
  9. package/models/AdvancePayUploadCollectionReceiptSchema.d.ts +12 -0
  10. package/models/AdvancePayUploadCollectionReceiptSchema.js +1 -0
  11. package/models/Availability.d.ts +17 -0
  12. package/models/Availability.js +1 -0
  13. package/models/BidAlerts.d.ts +10 -0
  14. package/models/BidAlerts.js +1 -0
  15. package/models/BidContract.d.ts +12 -0
  16. package/models/BidContract.js +1 -0
  17. package/models/BidDetail.d.ts +371 -0
  18. package/models/BidDetail.js +1 -0
  19. package/models/BuyerDashboard.d.ts +6 -0
  20. package/models/BuyerDashboard.js +1 -0
  21. package/models/CommodityPrices.d.ts +24 -0
  22. package/models/CommodityPrices.js +1 -0
  23. package/models/CommodityTradedInfo.d.ts +24 -0
  24. package/models/CommodityTradedInfo.js +1 -0
  25. package/models/ContractDeliverySchema.d.ts +87 -0
  26. package/models/ContractDeliverySchema.js +1 -0
  27. package/models/ContractDeliverySettlementDeductionSchema.d.ts +8 -0
  28. package/models/ContractDeliverySettlementDeductionSchema.js +1 -0
  29. package/models/ContractDeliverySettlementSchema.d.ts +48 -0
  30. package/models/ContractDeliverySettlementSchema.js +1 -0
  31. package/models/ContractDetail.d.ts +387 -0
  32. package/models/ContractDetail.js +1 -0
  33. package/models/ContractMovementPeriodSchema.d.ts +113 -0
  34. package/models/ContractMovementPeriodSchema.js +1 -0
  35. package/models/ContractRollOverSchema.d.ts +13 -0
  36. package/models/ContractRollOverSchema.js +1 -0
  37. package/models/ContractsAvailability.d.ts +112 -0
  38. package/models/ContractsAvailability.js +1 -0
  39. package/models/ContractsTraded.d.ts +76 -0
  40. package/models/ContractsTraded.js +1 -0
  41. package/models/ContractsTradedByMonth.d.ts +20 -0
  42. package/models/ContractsTradedByMonth.js +1 -0
  43. package/models/ContractsTradedPeriod.d.ts +18 -0
  44. package/models/ContractsTradedPeriod.js +1 -0
  45. package/models/CreateBid.d.ts +36 -0
  46. package/models/CreateBid.js +1 -0
  47. package/models/CreateContractDeliverySchema.d.ts +10 -0
  48. package/models/CreateContractDeliverySchema.js +1 -0
  49. package/models/CreateContractRequest.d.ts +59 -0
  50. package/models/CreateContractRequest.js +1 -0
  51. package/models/CreateListing.d.ts +68 -0
  52. package/models/CreateListing.js +1 -0
  53. package/models/CreateMarketUpdateRequest.d.ts +21 -0
  54. package/models/CreateMarketUpdateRequest.js +1 -0
  55. package/models/CreateOrUpdateTargetPriceSchema.d.ts +12 -0
  56. package/models/CreateOrUpdateTargetPriceSchema.js +1 -0
  57. package/models/CreateOrUpdateTargetPricesSchema.d.ts +12 -0
  58. package/models/CreateOrUpdateTargetPricesSchema.js +1 -0
  59. package/models/CreateTradeRequest.d.ts +31 -0
  60. package/models/CreateTradeRequest.js +1 -0
  61. package/models/ExFarmPriceCommodity.d.ts +7 -0
  62. package/models/ExFarmPriceCommodity.js +1 -0
  63. package/models/ExFarmPricesRegionSchema.d.ts +13 -0
  64. package/models/ExFarmPricesRegionSchema.js +1 -0
  65. package/models/ExFarmPricesSchema.d.ts +45 -0
  66. package/models/ExFarmPricesSchema.js +1 -0
  67. package/models/ExpiredBidOffer.d.ts +4 -0
  68. package/models/ExpiredBidOffer.js +1 -0
  69. package/models/FeedItem.d.ts +8 -0
  70. package/models/FeedItem.js +1 -0
  71. package/models/FinMidWebhook.d.ts +10 -0
  72. package/models/FinMidWebhook.js +1 -0
  73. package/models/FinMidWebhookEvent.d.ts +6 -0
  74. package/models/FinMidWebhookEvent.js +1 -0
  75. package/models/InsightPrices.d.ts +17 -0
  76. package/models/InsightPrices.js +1 -0
  77. package/models/InsightsLivestockTaxonomySchema.d.ts +18 -0
  78. package/models/InsightsLivestockTaxonomySchema.js +1 -0
  79. package/models/LinkContractSchema.d.ts +7 -0
  80. package/models/LinkContractSchema.js +1 -0
  81. package/models/ListingBidInfoBid.d.ts +13 -0
  82. package/models/ListingBidInfoBid.js +1 -0
  83. package/models/ListingDetail.d.ts +571 -0
  84. package/models/ListingDetail.js +1 -0
  85. package/models/ListingNextAutoCloseDateSchema.d.ts +3 -0
  86. package/models/ListingNextAutoCloseDateSchema.js +1 -0
  87. package/models/ListingSummary.d.ts +158 -0
  88. package/models/ListingSummary.js +1 -0
  89. package/models/MarketBuyers.d.ts +10 -0
  90. package/models/MarketBuyers.js +1 -0
  91. package/models/MarketUpdateDetail.d.ts +15 -0
  92. package/models/MarketUpdateDetail.js +1 -0
  93. package/models/NewsFeed.d.ts +8 -0
  94. package/models/NewsFeed.js +1 -0
  95. package/models/PatchBid.d.ts +26 -0
  96. package/models/PatchBid.js +1 -0
  97. package/models/PatchBidOption.d.ts +12 -0
  98. package/models/PatchBidOption.js +1 -0
  99. package/models/PatchContractDeliverySchema.d.ts +42 -0
  100. package/models/PatchContractDeliverySchema.js +1 -0
  101. package/models/PatchContractPricingSchema.d.ts +13 -0
  102. package/models/PatchContractPricingSchema.js +1 -0
  103. package/models/PatchContractRequest.d.ts +47 -0
  104. package/models/PatchContractRequest.js +1 -0
  105. package/models/PatchMarketUpdateRequest.d.ts +14 -0
  106. package/models/PatchMarketUpdateRequest.js +1 -0
  107. package/models/PublishExFarmPricingSchema.d.ts +16 -0
  108. package/models/PublishExFarmPricingSchema.js +1 -0
  109. package/models/PutContractFile.d.ts +9 -0
  110. package/models/PutContractFile.js +1 -0
  111. package/models/TargetPriceDetailSchema.d.ts +12 -0
  112. package/models/TargetPriceDetailSchema.js +1 -0
  113. package/models/Templates.d.ts +9 -0
  114. package/models/Templates.js +1 -0
  115. package/models/TradeRequestDetail.d.ts +64 -0
  116. package/models/TradeRequestDetail.js +1 -0
  117. package/models/TradingConfig.d.ts +21 -0
  118. package/models/TradingConfig.js +1 -0
  119. package/models/UnlinkContractSchema.d.ts +4 -0
  120. package/models/UnlinkContractSchema.js +1 -0
  121. package/package.json +13 -0
package/index.d.ts ADDED
@@ -0,0 +1,59 @@
1
+ export type { AcceptBid } from './models/AcceptBid.js';
2
+ export type { AdvancePayContractSchema } from './models/AdvancePayContractSchema.js';
3
+ export type { AdvancePayOfferSchema } from './models/AdvancePayOfferSchema.js';
4
+ export type { AdvancePayUploadCollectionReceiptSchema } from './models/AdvancePayUploadCollectionReceiptSchema.js';
5
+ export type { Availability } from './models/Availability.js';
6
+ export type { BidAlerts } from './models/BidAlerts.js';
7
+ export type { BidContract } from './models/BidContract.js';
8
+ export type { BidDetail } from './models/BidDetail.js';
9
+ export type { BuyerDashboard } from './models/BuyerDashboard.js';
10
+ export type { CommodityPrices } from './models/CommodityPrices.js';
11
+ export type { CommodityTradedInfo } from './models/CommodityTradedInfo.js';
12
+ export type { ContractDeliverySchema } from './models/ContractDeliverySchema.js';
13
+ export type { ContractDeliverySettlementDeductionSchema } from './models/ContractDeliverySettlementDeductionSchema.js';
14
+ export type { ContractDeliverySettlementSchema } from './models/ContractDeliverySettlementSchema.js';
15
+ export type { ContractDetail } from './models/ContractDetail.js';
16
+ export type { ContractMovementPeriodSchema } from './models/ContractMovementPeriodSchema.js';
17
+ export type { ContractRollOverSchema } from './models/ContractRollOverSchema.js';
18
+ export type { ContractsAvailability } from './models/ContractsAvailability.js';
19
+ export type { ContractsTraded } from './models/ContractsTraded.js';
20
+ export type { ContractsTradedByMonth } from './models/ContractsTradedByMonth.js';
21
+ export type { ContractsTradedPeriod } from './models/ContractsTradedPeriod.js';
22
+ export type { CreateBid } from './models/CreateBid.js';
23
+ export type { CreateContractDeliverySchema } from './models/CreateContractDeliverySchema.js';
24
+ export type { CreateContractRequest } from './models/CreateContractRequest.js';
25
+ export type { CreateListing } from './models/CreateListing.js';
26
+ export type { CreateMarketUpdateRequest } from './models/CreateMarketUpdateRequest.js';
27
+ export type { CreateOrUpdateTargetPriceSchema } from './models/CreateOrUpdateTargetPriceSchema.js';
28
+ export type { CreateOrUpdateTargetPricesSchema } from './models/CreateOrUpdateTargetPricesSchema.js';
29
+ export type { CreateTradeRequest } from './models/CreateTradeRequest.js';
30
+ export type { ExFarmPriceCommodity } from './models/ExFarmPriceCommodity.js';
31
+ export type { ExFarmPricesRegionSchema } from './models/ExFarmPricesRegionSchema.js';
32
+ export type { ExFarmPricesSchema } from './models/ExFarmPricesSchema.js';
33
+ export type { ExpiredBidOffer } from './models/ExpiredBidOffer.js';
34
+ export type { FeedItem } from './models/FeedItem.js';
35
+ export type { FinMidWebhook } from './models/FinMidWebhook.js';
36
+ export type { FinMidWebhookEvent } from './models/FinMidWebhookEvent.js';
37
+ export type { InsightPrices } from './models/InsightPrices.js';
38
+ export type { InsightsLivestockTaxonomySchema } from './models/InsightsLivestockTaxonomySchema.js';
39
+ export type { LinkContractSchema } from './models/LinkContractSchema.js';
40
+ export type { ListingBidInfoBid } from './models/ListingBidInfoBid.js';
41
+ export type { ListingDetail } from './models/ListingDetail.js';
42
+ export type { ListingNextAutoCloseDateSchema } from './models/ListingNextAutoCloseDateSchema.js';
43
+ export type { ListingSummary } from './models/ListingSummary.js';
44
+ export type { MarketBuyers } from './models/MarketBuyers.js';
45
+ export type { MarketUpdateDetail } from './models/MarketUpdateDetail.js';
46
+ export type { NewsFeed } from './models/NewsFeed.js';
47
+ export type { PatchBid } from './models/PatchBid.js';
48
+ export type { PatchBidOption } from './models/PatchBidOption.js';
49
+ export type { PatchContractDeliverySchema } from './models/PatchContractDeliverySchema.js';
50
+ export type { PatchContractPricingSchema } from './models/PatchContractPricingSchema.js';
51
+ export type { PatchContractRequest } from './models/PatchContractRequest.js';
52
+ export type { PatchMarketUpdateRequest } from './models/PatchMarketUpdateRequest.js';
53
+ export type { PublishExFarmPricingSchema } from './models/PublishExFarmPricingSchema.js';
54
+ export type { PutContractFile } from './models/PutContractFile.js';
55
+ export type { TargetPriceDetailSchema } from './models/TargetPriceDetailSchema.js';
56
+ export type { Templates } from './models/Templates.js';
57
+ export type { TradeRequestDetail } from './models/TradeRequestDetail.js';
58
+ export type { TradingConfig } from './models/TradingConfig.js';
59
+ export type { UnlinkContractSchema } from './models/UnlinkContractSchema.js';
package/index.js ADDED
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,5 @@
1
+ export type AcceptBid = {
2
+ optionId: number;
3
+ weight: number;
4
+ price?: number;
5
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,133 @@
1
+ export type AdvancePayContractSchema = {
2
+ id: string;
3
+ finmidPaymentId: string;
4
+ status: 'pending' | 'captured' | 'settled';
5
+ inventory: {
6
+ harvestYear: string;
7
+ commodity: {
8
+ commodity: {
9
+ id: number;
10
+ name: string;
11
+ };
12
+ type: {
13
+ id: number;
14
+ name: string;
15
+ };
16
+ grade: {
17
+ id: number;
18
+ name: string;
19
+ };
20
+ variety: string;
21
+ tags: Array<number>;
22
+ weight: {
23
+ name: string;
24
+ conversion: number;
25
+ weight?: number;
26
+ };
27
+ };
28
+ };
29
+ trade: {
30
+ listingId: string;
31
+ bidId: string;
32
+ buyer: {
33
+ userId: string;
34
+ organisationId: string;
35
+ organisationName: string;
36
+ };
37
+ seller: {
38
+ userId: string;
39
+ organisationId: string;
40
+ organisationName: string;
41
+ };
42
+ movement: {
43
+ startDateUTC: string;
44
+ endDateUTC: string;
45
+ type: 'date' | 'month';
46
+ };
47
+ settlementDateUTC: string;
48
+ buyerTermDays: number;
49
+ amount: {
50
+ amount: number;
51
+ currency: string;
52
+ };
53
+ };
54
+ offer: {
55
+ totalWeight: {
56
+ name: string;
57
+ conversion: number;
58
+ weight?: number;
59
+ };
60
+ totalTradeValue: {
61
+ amount: number;
62
+ currency: string;
63
+ };
64
+ totalSellerReceivable: {
65
+ amount: number;
66
+ currency: string;
67
+ };
68
+ movementTermUTC: string;
69
+ pricePerUnit: {
70
+ amount: number;
71
+ currency: string;
72
+ };
73
+ payments: {
74
+ fees: {
75
+ amount: number;
76
+ currency: string;
77
+ };
78
+ };
79
+ };
80
+ payments: {
81
+ advance: {
82
+ percentage: number;
83
+ amount: {
84
+ amount: number;
85
+ currency: string;
86
+ };
87
+ amountAfterFees?: {
88
+ amount: number;
89
+ currency: string;
90
+ } | null;
91
+ status: 'pending' | 'captured';
92
+ capturedAtUTC: string;
93
+ dueAtUTC: string;
94
+ };
95
+ intermediate: {
96
+ percentage: number;
97
+ amount: {
98
+ amount: number;
99
+ currency: string;
100
+ };
101
+ amountAfterFees?: {
102
+ amount: number;
103
+ currency: string;
104
+ } | null;
105
+ status: 'pending' | 'captured';
106
+ capturedAtUTC: string;
107
+ dueAtUTC: string;
108
+ } | null;
109
+ settlement: {
110
+ percentage: number;
111
+ amount: {
112
+ amount: number;
113
+ currency: string;
114
+ };
115
+ amountAfterFees?: {
116
+ amount: number;
117
+ currency: string;
118
+ } | null;
119
+ status: 'pending' | 'captured';
120
+ capturedAtUTC: string;
121
+ };
122
+ };
123
+ collectionReceipts: Array<{
124
+ name?: string;
125
+ id: string;
126
+ url?: string | null;
127
+ userId?: string | null;
128
+ userName?: string | null;
129
+ organisationId?: string | null;
130
+ createdAtUTC?: string | null;
131
+ } | null>;
132
+ tags: Array<string>;
133
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,62 @@
1
+ export type AdvancePayOfferSchema = {
2
+ totalWeight: {
3
+ name: string;
4
+ conversion: number;
5
+ weight?: number;
6
+ };
7
+ totalTradeValue: {
8
+ amount: number;
9
+ currency: string;
10
+ };
11
+ totalSellerReceivable: {
12
+ amount: number;
13
+ currency: string;
14
+ };
15
+ movementTermUTC: string;
16
+ pricePerUnit: {
17
+ amount: number;
18
+ currency: string;
19
+ };
20
+ payments: {
21
+ fees: {
22
+ amount: number;
23
+ currency: string;
24
+ };
25
+ advance: {
26
+ amount: {
27
+ amount: number;
28
+ currency: string;
29
+ };
30
+ amountAfterFees?: {
31
+ amount: number;
32
+ currency: string;
33
+ } | null;
34
+ percentage: number;
35
+ type: 'advance' | 'intermediate' | 'settlement';
36
+ };
37
+ intermediate?: {
38
+ amount: {
39
+ amount: number;
40
+ currency: string;
41
+ };
42
+ amountAfterFees?: {
43
+ amount: number;
44
+ currency: string;
45
+ } | null;
46
+ percentage: number;
47
+ type: 'advance' | 'intermediate' | 'settlement';
48
+ };
49
+ settlement: {
50
+ amount: {
51
+ amount: number;
52
+ currency: string;
53
+ };
54
+ amountAfterFees?: {
55
+ amount: number;
56
+ currency: string;
57
+ } | null;
58
+ percentage: number;
59
+ type: 'advance' | 'intermediate' | 'settlement';
60
+ };
61
+ };
62
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,12 @@
1
+ export type AdvancePayUploadCollectionReceiptSchema = {
2
+ collectionReceipts: Array<{
3
+ name?: string;
4
+ id: string;
5
+ url?: string | null;
6
+ userId?: string | null;
7
+ userName?: string | null;
8
+ organisationId?: string | null;
9
+ createdAtUTC?: string | null;
10
+ } | null>;
11
+ movementDateUTC: string;
12
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,17 @@
1
+ export type Availability = {
2
+ id?: string | null;
3
+ name?: string;
4
+ type?: string;
5
+ pricedWeight?: number;
6
+ unpricedWeight?: number;
7
+ availableWeight?: number;
8
+ totalWeight?: number;
9
+ soldWeight?: number;
10
+ soldPercent?: number;
11
+ priceDelta?: number | null;
12
+ targetPrice?: number | null;
13
+ currentPrice?: number | null;
14
+ averagePrice?: number | null;
15
+ area?: string | null;
16
+ region?: string | null;
17
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,10 @@
1
+ export type BidAlerts = {
2
+ bidAlerts: Array<{
3
+ authPlatformId: string;
4
+ emailAddress: string;
5
+ fullName: string;
6
+ mobileNumber: string | null;
7
+ organisationId?: string | null;
8
+ userId: string;
9
+ }> | null;
10
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,12 @@
1
+ export type BidContract = {
2
+ reference: string;
3
+ files: Array<{
4
+ name?: string;
5
+ id: string;
6
+ url?: string | null;
7
+ userId?: string | null;
8
+ userName?: string | null;
9
+ organisationId?: string | null;
10
+ createdAtUTC?: string | null;
11
+ } | null>;
12
+ };
@@ -0,0 +1 @@
1
+ export {};