Skip to content

Add execute event block API and rollforward mechanics models#120

Merged
jfrench9 merged 1 commit into
mainfrom
feature/rollforward-ib
May 20, 2026
Merged

Add execute event block API and rollforward mechanics models#120
jfrench9 merged 1 commit into
mainfrom
feature/rollforward-ib

Conversation

@jfrench9
Copy link
Copy Markdown
Member

Summary

Introduces support for the execute event block API operation and a comprehensive set of rollforward mechanics models to the robosystems_client SDK. This feature enables clients to execute event blocks against the RoboLedger extension and express rollforward logic (create, update, delete) for information blocks.

Key Accomplishments

New API Operation

  • op_execute_event_block: New endpoint for executing event blocks within the RoboLedger extensions API, including full request/response lifecycle support.

Rollforward Mechanics Models

  • RollforwardMechanics: Core model defining how rollforward operations are structured, including validation mode configuration.
  • CreateRollforwardArm / CreateRollforwardRequest: Models for creating new information blocks via rollforward, with validation mode support.
  • UpdateRollforwardArm / UpdateRollforwardRequest: Models for updating existing information blocks via rollforward, with optional validation mode.
  • DeleteRollforwardArm / DeleteRollforwardRequest: Models for deleting information blocks via rollforward.

Event Block Request/Response Models

  • ExecuteEventBlockRequest and ExecuteEventBlockResponse: Full request/response models including error handling (qb_error union type).
  • OperationEnvelopeExecuteEventBlockResponse: Envelope wrapper with status enum for standardized API responses.

Supporting Models

  • AttributionFilter: New model for filtering by attribution criteria.
  • LineItemMetadataPredicate: Model for expressing predicates over line item metadata.
  • JournalEntryLineItemInputMetadataType0: Typed metadata support for journal entry line item inputs.

Modifications to Existing Code

  • op_create_information_block, op_delete_information_block, op_update_information_block: Updated to align with new API patterns (likely signature or import changes).
  • ArtifactResponse: Extended with additional fields or updated serialization.
  • JournalEntryLineItemInput: Enhanced with optional metadata support.
  • models/__init__.py: All new models properly exported (48 new lines of imports/exports).

Breaking Changes

  • Modifications to existing information block operations (create, update, delete) and the ArtifactResponse / JournalEntryLineItemInput models may introduce breaking changes for consumers relying on the previous API signatures or serialization shapes. Review the diff for these 4 modified files carefully.

Testing Notes

  • Verify that the new op_execute_event_block operation correctly serializes requests and deserializes responses, including the union-typed qb_error field.
  • Validate all rollforward arm models (create, update, delete) handle their respective validation mode enums and optional fields correctly.
  • Ensure backward compatibility for existing information block operations after the modifications.
  • Test the OperationEnvelope wrapper to confirm status enum mapping works as expected.

Infrastructure Considerations

  • This is an SDK/client library change — downstream consumers will need to update their dependency to access the new models and operations.
  • The new models appear to be auto-generated or follow a code-generation pattern; ensure the generation source (e.g., OpenAPI spec) is kept in sync with these additions.

🤖 Generated with Claude Code

Branch Info:

  • Source: feature/rollforward-ib
  • Target: main
  • Type: feature

Co-Authored-By: Claude noreply@anthropic.com

- Introduced `ExecuteEventBlockResponse` and `ExecuteEventBlockResponseQbErrorType0` models to handle the response structure of the execute event block API.
- Added `JournalEntryLineItemInputMetadataType0` and `LineItemMetadataPredicate` models for enhanced metadata handling in journal entries.
- Created `OperationEnvelopeExecuteEventBlockResponse` and `OperationEnvelopeExecuteEventBlockResponseStatus` to manage operation envelope responses.
- Implemented `RollforwardMechanics` and `RollforwardMechanicsValidationMode` for rollforward attribution mechanics.
- Added `UpdateRollforwardArm` and `UpdateRollforwardRequest` models to facilitate updates to rollforward blocks, including validation modes.
- Introduced `UpdateRollforwardRequestValidationModeType0` for validation mode handling in rollforward requests.
@jfrench9 jfrench9 merged commit 134ad37 into main May 20, 2026
1 check passed
@jfrench9 jfrench9 deleted the feature/rollforward-ib branch May 20, 2026 01:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant