feat: Add typed response models and improve operation envelope handling#112
Merged
Conversation
…, and legacy updates - Introduced `SecurityResponseTerms` model to handle instrument-specific terms. - Added `StatementMechanics` model for renderer mechanics related to various statement types. - Created `UpdateLegacyArm` and `UpdateLegacyArmBlockType` models for handling updates to legacy arms. - Implemented `UpdateLegacyArmPayload` model for untyped payloads in legacy updates. - Developed `UpdateScheduleArm` and `UpdateScheduleRequest` models for schedule updates. - Added `ValidationLite` and `VerificationResultLite` models for validation outcomes and verification results. - Introduced `ViewProjections` model to manage different view projections at the envelope boundary.
- Introduced StructureSummary model to represent various report structures. - Added TaxonomyBlockAssociation model for associations within taxonomy blocks. - Created TaxonomyBlockElement model to represent elements in taxonomy. - Implemented TaxonomyBlockElementOrigin enum for element provenance. - Developed TaxonomyBlockEnvelope model to encapsulate taxonomy block data. - Added TaxonomyBlockEnvelopeVerificationResultsItem model for verification results. - Created TaxonomyBlockRule model to define rules for taxonomy blocks. - Implemented TaxonomyBlockStructure model for structure definitions. - Added TransactionPreview model for planned GL entry lines.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Large-scale enhancement of the
robosystems_clientSDK to introduce strongly-typed response models across all API operations, refactorOperationEnvelopehandling in bothInvestorClientandLedgerClient, and add new domain models for taxonomy blocks, security response terms, statement mechanics, and legacy/schedule operations.Key Accomplishments
Typed Response Models
InvestorClientandLedgerClientto return typed response models instead of raw/untyped responses, improving developer experience and type safety across the entire client surface area.ArtifactResponse,AssociationResponse,ClosePeriodResponse,DeleteInformationBlockResponse,DeletePortfolioBlockResponse,DeleteTaxonomyBlockResponse,DeleteResult,EntityTaxonomyResponse,EvaluateRulesResponse,EventBlockEnvelope,EventHandlerResponse, and more.New Domain Models
ClassificationLite,ConnectionLite,ElementLite,EntityLiteand related entities for lightweight taxonomy representations.EntryTemplateRequest,EntryTemplateRequestEntryType,EvaluateRulesResponseSummary, and supporting models.CreateLegacyArm,DeleteLegacyArm,CreateScheduleArm,DeleteScheduleArm,CreateScheduleRequest,DeleteScheduleRequestwith associated payload and block type models.Refactored Operation Envelope Handling
OperationEnvelopeprocessing in bothInvestorClientandLedgerClientfor more consistent and robust response parsing.OperationEnvelopeResultType0→ArtifactResponseTemplateType0to better reflect its purpose.API Operation Updates
extensions_robo_investor,extensions_robo_ledger,graph_operations, andsubscriptionshave been updated to align with the new typed response patterns and envelope handling.CreateAgentRequest,CreateEventBlockRequest,CreateSecurityRequest,DeleteJournalEntryRequest, etc.) to reflect schema changes.Breaking Changes
OperationEnvelopeResultType0has been renamed toArtifactResponseTemplateType0.CreateInformationBlockRequestandDeleteInformationBlockRequestPayloadhave been removed/replaced by restructured models (CreateLegacyArm,DeleteLegacyArm, and their payloads).UpdateInformationBlockRequestandUpdateInformationBlockRequestPayloadhave been replaced byDeleteLegacyArmandEventBlockEnvelopeMetadatarespectively.InvestorClientandLedgerClientnow return typed model instances rather than generic responses — callers relying on raw response structures will need to update.__init__.pyexports expanded significantly: ~382 lines of additions to the models package exports.Testing Notes
OperationEnvelopeResultType0to ensure the rename toArtifactResponseTemplateType0is fully propagated.Infrastructure Considerations
🤖 Generated with Claude Code
Branch Info:
feature/ops-docsmainCo-Authored-By: Claude noreply@anthropic.com