doc: add pending coupon payment error

cusma · Jan 7, 2025 · 4458f39 · 4458f39
1 parent 609cdd9
commit 4458f39
Show file tree

Hide file tree

Showing 11 changed files with 36 additions and 1 deletion.
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.