feat(simint): make simulator_integration_external_id optional on runs, routines and routine revisions

[mohammad-arif662]

Description

Currently, the simulatorIntegrationExternalId field is required in the response objects for routine, routine revision, and simulation run endpoints. This forces users to bind a routine to a specific connector at creation time.
We want to make simulatorIntegrationExternalId optional in routine/routine revision creation, so users can create routines not tied to a connector. The binding will happen at runtime (simulation run will get the connector assigned at some point).

This PR only makes the field optional in response objects of SimulationRun, SimulatorRoutine, SimulatorRoutineRevision.

Since SimulatorRoutineWrite extends SimulatorRoutineCore (which now accepts str | None), the write class also technically accepts None values. However, the backend API currently still requires this field for write operations, so users should continue to provide it when creating routines. Once the backend supports optional simulatorIntegrationExternalId in writes, we can update the documentation accordingly.

Note: Since simint pysdk is under alpha, we are doing this breaking change.

Changes

• Changed simulator_integration_external_id: str to simulator_integration_external_id: str | None in SimulationRun, SimulatorRoutineCore, SimulatorRoutineRevision.
• Changed from resource["simulatorIntegrationExternalId"] to resource.get("simulatorIntegrationExternalId") to safely handle missing or None values.
• Added unit tests.

Checklist:

• Tests added/updated.
• Documentation updated. Documentation is generated from docstrings - these must be updated according to your change.
  If a new method has been added it should be referenced in cognite.rst in order to generate docs based on its docstring.
• The PR title follows the Conventional Commit spec.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.27%. Comparing base (0aa6dd7) to head (0041543).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2420      +/-   ##
==========================================
- Coverage   91.28%   91.27%   -0.01%     
==========================================
  Files         192      192              
  Lines       26184    26184              
==========================================
- Hits        23901    23900       -1     
- Misses       2283     2284       +1     

Files with missing lines	Coverage Δ
...lient/data_classes/simulators/routine_revisions.py	91.41% <ø> (ø)
cognite/client/data_classes/simulators/routines.py	100.00% <ø> (ø)
cognite/client/data_classes/simulators/runs.py	99.02% <ø> (ø)

... and 3 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[polomani]

you need to put a bit more explanation into the description, as this will be reviewed by pysdk maintainers.
the change is breaking, so you need to explain that we are doing that since the simint pysdk is under alpha

[polomani]

/gemini review

[gemini-code-assist]

Code Review

This pull request modifies the simulator_integration_external_id field across several simulator-related data classes, including SimulatorRoutineRevision, SimulatorRoutine, and SimulationRun. The changes involve updating the type hints for this field from str to str | None in class definitions and __init__ methods, and modifying the _load methods to use resource.get("simulatorIntegrationExternalId") instead of direct dictionary access to gracefully handle cases where the field might be missing. Corresponding unit tests have been added to verify that these classes correctly load instances both with and without the simulator_integration_external_id.

[polomani]

The field remains required for write operation (SimulatorRoutineWrite) because the backend logic still requires it. Once the backend supports optional simulatorIntegrationExternalId in write operations, we can update the write classes accordingly.

this sentence is not true, it's stil required on the API but is optional in SDK now

[haakonvt]

LGTM, just one comment in need of addressing

[haakonvt]

🦄