feat: add BATCH_COMMIT_COMMANDS effect

Add BatchCommitCommandEffect and _commit_payload_for_batch() to enable
committing multiple commands in a single batch operation, mirroring the
existing BATCH_ORIGINATE_COMMANDS pattern.

Author: beaugunderson

canvas_generated/messages/effects_pb2.py

@@ -324,6 +324,7 @@ class EffectType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
     REVENUE__PAYMENT_PROCESSOR__PAYMENT_METHOD__REMOVE_RESPONSE: _ClassVar[EffectType]
     GENERATE_FULL_CHART_PDF: _ClassVar[EffectType]
     BATCH_ORIGINATE_COMMANDS: _ClassVar[EffectType]
+    BATCH_COMMIT_COMMANDS: _ClassVar[EffectType]
     CALENDAR__CREATE: _ClassVar[EffectType]
     CALENDAR__EVENT__CREATE: _ClassVar[EffectType]
     CALENDAR__EVENT__UPDATE: _ClassVar[EffectType]
@@ -652,6 +653,7 @@ REVENUE__PAYMENT_PROCESSOR__PAYMENT_METHOD__ADD_RESPONSE: EffectType
 REVENUE__PAYMENT_PROCESSOR__PAYMENT_METHOD__REMOVE_RESPONSE: EffectType
 GENERATE_FULL_CHART_PDF: EffectType
 BATCH_ORIGINATE_COMMANDS: EffectType
+BATCH_COMMIT_COMMANDS: EffectType
 CALENDAR__CREATE: EffectType
 CALENDAR__EVENT__CREATE: EffectType
 CALENDAR__EVENT__UPDATE: EffectType

canvas_generated/messages/effects_pb2.pyi

@@ -137,6 +137,14 @@ def _origination_payload_for_batch(self, line_number: int = -1) -> dict:
             "line_number": line_number,
         }
 
+    def _commit_payload_for_batch(self) -> dict:
+        """Commit a command for batch processing."""
+        self._validate_before_effect("commit")
+        return {
+            "type": f"COMMIT_{self.constantized_key()}_COMMAND",
+            "command": self.command_uuid,
+        }
+
     def edit(self) -> Effect:
         """Edit the command."""
         self._validate_before_effect("edit")

canvas_sdk/commands/base.py

@@ -0,0 +1,22 @@
+from typing import Any
+
+from pydantic import Field
+
+from canvas_sdk.effects import EffectType, _BaseEffect
+
+
+class BatchCommitCommandEffect(_BaseEffect):
+    """An Effect that will commit multiple commands in a batch operation."""
+
+    class Meta:
+        effect_type = EffectType.BATCH_COMMIT_COMMANDS
+
+    commands: list = Field(min_length=1)
+
+    @property
+    def values(self) -> dict[str, Any]:
+        """The BatchCommitCommandEffect's values."""
+        return {"commands": [command._commit_payload_for_batch() for command in self.commands]}
+
+
+__exports__ = ("BatchCommitCommandEffect",)

canvas_sdk/effects/batch_commit.py

@@ -131,6 +131,26 @@ def test_batch_originate_raises_error_when_required_fields_not_set() -> None:
         cmd._origination_payload_for_batch()
 
 
+def test_batch_commit_successfully_returns_dict(
+    dummy_command_instance: DummyCommand,
+) -> None:
+    """Test that _commit_payload_for_batch() successfully returns the correct dict."""
+    batch_payload = dummy_command_instance._commit_payload_for_batch()
+
+    assert batch_payload == {
+        "type": "COMMIT_PLAN_COMMAND",
+        "command": dummy_command_instance.command_uuid,
+    }
+
+
+def test_batch_commit_raises_error_when_required_fields_not_set() -> None:
+    """Test that _commit_payload_for_batch() raises an error when a required field is not set."""
+    cmd = DummyCommand()
+
+    with pytest.raises(ValueError, match="command_uuid"):
+        cmd._commit_payload_for_batch()
+
+
 def test_commit_successfully_returns_commit_effect(
     dummy_command_instance: DummyCommand,
 ) -> None:

canvas_sdk/tests/commands/test_base_command.py

@@ -422,6 +422,9 @@
     "EffectType",
     "_BaseEffect"
   ],
+  "canvas_sdk.effects.batch_commit": [
+    "BatchCommitCommandEffect"
+  ],
   "canvas_sdk.effects.batch_originate": [
     "BatchOriginateCommandEffect"
   ],

plugin_runner/allowed-module-imports.json

@@ -406,6 +406,7 @@ enum EffectType {
   GENERATE_FULL_CHART_PDF = 6101;
 
   BATCH_ORIGINATE_COMMANDS = 6024;
+  BATCH_COMMIT_COMMANDS = 6033;
 
   CALENDAR__CREATE = 8001;
   CALENDAR__EVENT__CREATE = 8002;