doc: add pending coupon payment error

cusma · cusma · commit 4458f39bce76 · 2025-01-07T19:01:08.000+01:00
diff --git a/docs/include/interface.update-coupon-rates.json b/docs/include/interface.update-coupon-rates.json
@@ -33,6 +33,10 @@
     {
       "code": "INVALID_PAST_RATE",
       "message": "Due coupon rates can not be modified"
+    },
+    {
+      "code": "PENDING_COUPON_PAYMENT",
+      "message": "Pending due coupon payment"
     }
   ]
 }
diff --git a/docs/include/interface.update-global-unit-value.json b/docs/include/interface.update-global-unit-value.json
@@ -25,6 +25,10 @@
     {
       "code": "SUSPENDED",
       "message": "Asset operations are suspended"
+    },
+    {
+      "code": "PENDING_COUPON_PAYMENT",
+      "message": "Pending due coupon payment"
     }
   ]
 }
diff --git a/docs/include/interface.update-interest-rate.json b/docs/include/interface.update-interest-rate.json
@@ -28,7 +28,7 @@
     },
     {
       "code": "PENDING_COUPON_PAYMENT",
-      "message": "ending due coupon payment"
+      "message": "Pending due coupon payment"
     }
   ]
 }
diff --git a/docs/include/interface.update-time-events.json b/docs/include/interface.update-time-events.json
@@ -41,6 +41,10 @@
     {
       "code": "INVALID_PAST_EVENT",
       "message": "Past time events can not be modified"
+    },
+    {
+      "code": "PENDING_COUPON_PAYMENT",
+      "message": "Pending due coupon payment"
     }
   ]
 }
diff --git a/docs/include/interface.update-time-periods.json b/docs/include/interface.update-time-periods.json
@@ -29,6 +29,10 @@
     {
       "code": "INVALID_TIME_PERIOD",
       "message": "Time period durations must be greater than zero"
+    },
+    {
+      "code": "PENDING_COUPON_PAYMENT",
+      "message": "Pending due coupon payment"
     }
   ]
 }
diff --git a/docs/include/interface.update-total-units.json b/docs/include/interface.update-total-units.json
@@ -25,6 +25,10 @@
     {
       "code": "SUSPENDED",
       "message": "Asset operations are suspended"
+    },
+    {
+      "code": "PENDING_COUPON_PAYMENT",
+      "message": "Pending due coupon payment"
     }
   ]
 }
diff --git a/docs/interface-update-coupon-rates.md b/docs/interface-update-coupon-rates.md
@@ -16,3 +16,6 @@ length of the *coupon rates* is not equal to *total_coupons*.
 
 The call **MUST** fail with the `INVALID_PAST_RATE` error code if a due coupon rate
 is modified.
+
+The call **MUST** fail with the `PENDING_COUPON_PAYMENT` error code if there is
+any due coupon still to be paid.
diff --git a/docs/interface-update-global-unit-value.md b/docs/interface-update-global-unit-value.md
@@ -10,3 +10,6 @@ caller.
 The call **MUST** fail with the `DEFAULTED` error code if the asset is defaulted.
 
 The call **MAY** fail with the `SUSPENDED` error code if the asset is suspended.
+
+The call **MUST** fail with the `PENDING_COUPON_PAYMENT` error code if there is
+any due coupon still to be paid.
diff --git a/docs/interface-update-time-events.md b/docs/interface-update-time-events.md
@@ -22,3 +22,6 @@ are not sorted in strictly ascending order.
 
 The call **MUST** fail with the `INVALID_PAST_EVENT` error code if a past event
 is modified.
+
+The call **MUST** fail with the `PENDING_COUPON_PAYMENT` error code if there is
+any due coupon still to be paid.
diff --git a/docs/interface-update-time-periods.md b/docs/interface-update-time-periods.md
@@ -13,3 +13,6 @@ The call **MAY** fail with the `SUSPENDED` error code if the asset is suspended.
 
 The call **MUST** fail with the `INVALID_TIME_PERIOD` error code if the *time period
 durations* are not strictly greater than zero.
+
+The call **MUST** fail with the `PENDING_COUPON_PAYMENT` error code if there is
+any due coupon still to be paid.
diff --git a/docs/interface-update-total-units.md b/docs/interface-update-total-units.md
@@ -10,3 +10,6 @@ caller.
 The call **MUST** fail with the `DEFAULTED` error code if the asset is defaulted.
 
 The call **MAY** fail with the `SUSPENDED` error code if the asset is suspended.
+
+The call **MUST** fail with the `PENDING_COUPON_PAYMENT` error code if there is
+any due coupon still to be paid.

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,10 @@`
`33`	`33`	`{`
`34`	`34`	`"code": "INVALID_PAST_RATE",`
`35`	`35`	`"message": "Due coupon rates can not be modified"`
	`36`	`+ },`
	`37`	`+ {`
	`38`	`+ "code": "PENDING_COUPON_PAYMENT",`
	`39`	`+ "message": "Pending due coupon payment"`
`36`	`40`	`}`
`37`	`41`	`]`
`38`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,10 @@`
`25`	`25`	`{`
`26`	`26`	`"code": "SUSPENDED",`
`27`	`27`	`"message": "Asset operations are suspended"`
	`28`	`+ },`
	`29`	`+ {`
	`30`	`+ "code": "PENDING_COUPON_PAYMENT",`
	`31`	`+ "message": "Pending due coupon payment"`
`28`	`32`	`}`
`29`	`33`	`]`
`30`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@`
`28`	`28`	`},`
`29`	`29`	`{`
`30`	`30`	`"code": "PENDING_COUPON_PAYMENT",`
`31`		`- "message": "ending due coupon payment"`
	`31`	`+ "message": "Pending due coupon payment"`
`32`	`32`	`}`
`33`	`33`	`]`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,10 @@`
`41`	`41`	`{`
`42`	`42`	`"code": "INVALID_PAST_EVENT",`
`43`	`43`	`"message": "Past time events can not be modified"`
	`44`	`+ },`
	`45`	`+ {`
	`46`	`+ "code": "PENDING_COUPON_PAYMENT",`
	`47`	`+ "message": "Pending due coupon payment"`
`44`	`48`	`}`
`45`	`49`	`]`
`46`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,10 @@`
`29`	`29`	`{`
`30`	`30`	`"code": "INVALID_TIME_PERIOD",`
`31`	`31`	`"message": "Time period durations must be greater than zero"`
	`32`	`+ },`
	`33`	`+ {`
	`34`	`+ "code": "PENDING_COUPON_PAYMENT",`
	`35`	`+ "message": "Pending due coupon payment"`
`32`	`36`	`}`
`33`	`37`	`]`
`34`	`38`	`}`