How intuit/quickbooks-v3-dotnet-sdk works
Core Architectural Layers
• Data Projects:
– Include the “XsdExtension” tool and the “Intuit.Ipp.Data” project that generate and maintain classes based on the QuickBooks Online V3 service schema. These form the foundation for the strongly typed API objects.
• Core & Common Functionality:
– Represent the “Intuit.Ipp.Core” component which manages configuration, sync/async request handling, callbacks and retry policies.
– Also include the “Intuit.Ipp.Utility” (serialization, deserialization, compression and config management), “Intuit.Ipp.QueryFilter” (query logic) libraries, and the “Intuit.Ipp.Diagnostics” and “Intuit.Ipp.Exception” projects (logging and exception handling).
• Service Layer:
– Encompass the service projects such as “Intuit.Ipp.DataService” (for CRUD and batch operations on QuickBooks entities), “Intuit.Ipp.EntitlementService”, “Intuit.Ipp.GlobalTaxService”, “Intuit.Ipp.ReportService” and “Intuit.Ipp.WebHooksService” that provide APIs for specific functional areas.
• Security & Authorization:
– Include “Intuit.Ipp.OAuth2PlatformClient” which manages OAuth2 flows and logging, and “Intuit.Ipp.Security” which creates authorization headers and handles token-based security.
• Packaging and Distribution:
– Represent the “Intuit.Ipp.Nupkg” project which handles NuGet packaging, versioning and dependency configuration.
• Tests & Samples:
– Add a section for test projects (unit and integration tests found under the Code and Test folders) and for sample/template projects (such as the Installer and Template folders that provide sample apps for both ASP.NET and MVC).
Relationships and Interactions
• All Service Projects depend on the Core libraries (Ipp.Core, Ipp.Utility, Ipp.QueryFilter) for common tasks such as configuration management, request/response handling, retry logic and serialization.
• The Security components (OAuth2PlatformClient and Ipp.Security) supply authorization tokens and headers that are used by the Core and Service layers.
• The Data Projects (XsdExtension + Intuit.Ipp.Data) output schema-based classes which are then consumed by the Service components.
• Cross-cutting concerns like logging (via Ipp.Diagnostics) and error handling (via Ipp.Exception) span across all layers.
• Test projects interact with all components (core, service, security, etc.) to validate functionality.
• Packaging (NuGet project) consumes outputs from all libraries, preparing the final SDK distribution.
Representing Technologies, Frameworks, and Patterns
• Clearly label that this SDK is built using .NET Standard 2.0 while also supporting .NET Full Framework (4.6.1, 4.7.2) and .NET Core, which clarifies the cross-platform and multi-target support.
• That the SDK uses configuration-based settings (app.config), along with embedded logging capabilities that support Serilog, Fiddler trace logging and customizable log sink options.
• That the project follows a modular pattern, where each module (Data Projects, Core Libraries, Service Projects, Security) is separated to enhance maintainability and reusability.