Skip to content

#6418 support 'referentie' attribute when updating Customer Interactions API - #6486

Draft
annashamray wants to merge 3 commits into
mainfrom
feature/6418-open-klant-referentie
Draft

#6418 support 'referentie' attribute when updating Customer Interactions API#6486
annashamray wants to merge 3 commits into
mainfrom
feature/6418-open-klant-referentie

Conversation

@annashamray

@annashamray annashamray commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Closes #6418
Depends on maykinmedia/open-klant-client#8
Blocked by maykinmedia/open-klant#625

Changes

What's left to do:

Here are all user flows for profile component. Updates are added in bold

The flows of using "profile component"

  1. User is not authenticated:
  • create contactMoment, betrokkene and onderwerpObject
  • create digitaalAdres records linked to the created betrokkene
  • NO REFERENTIE UPDATE
  1. User is authenticated, but unknown in the API:
  • create partij for the user
  • create contactMoment, betrokkene and onderwerpObject and link betrokkene
    to the created partij
  • create digitaalAdres records linked to the created betrokkene. If the address is
    submitted as isNewPreferred, then it's also linked to the created partij
  • NEW: If the address is submitted as isNewPreferred, its referentie is included
  1. User is authenticated, known in the API and uses pre-filled data this is the case in this US:
  • find partij for the user
  • create contactMoment, betrokkene and onderwerpObject and link betrokkene
    to the found partij
  • create digitaalAdres records linked to the created betrokkene if the used address is not default
  • NO REFERENTIE UPDATE
  1. User is authenticated, known in the API and submits new addresses:
  • find partij for the user
  • create contactMoment, betrokkene and onderwerpObject and link betrokkene
    to the found partij
  • create digitaalAdres records linked to the created betrokkene for the new addresses.
    If the address is submitted as isNewPreferred, then it's also linked to the partij
  • NEW: CAN CRASH! If the address is submitted as isNewPreferred, its referentie is included
  1. User is authenticated, known in the API and submits existing addresses with the changed preference:
  • find partij for the user
  • create contactMoment, betrokkene and onderwerpObject and link betrokkene
    to the found partij
  • if the address is submitted as useOnlyOnce, then we don't update it
  • if the address is submitted as isNewPreferred, and the existing address is not
    preferred (isStandaardAdres == False) then we update it with isStandaardAdres = True
  • NEW: CAN CRASH! If the address is submitted as isNewPreferred, its referentie is updated

Checklist

Check off the items that are completed or not relevant.

  • Impact on features

    • Checked copying a form
    • Checked import/export of a form
    • Config checks in the configuration overview admin page
    • Checked new model fields are usable in the admin
    • Problem detection in the admin email digest is handled
  • Dockerfile/scripts

    • Updated the Dockerfile with the necessary scripts from the ./bin folder
  • Commit hygiene

    • Commit messages refer to the relevant Github issue
    • Commit messages explain the "why" of change, not the how
  • Documentation

    • Added documentation which describes the changes

@github-actions github-actions Bot added the needs-backport Fix must be backported to stable release branch label Jul 23, 2026
@codecov

codecov Bot commented Jul 23, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 20.00000% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 97.21%. Comparing base (098df3f) to head (2c1f9a9).

Files with missing lines Patch % Lines
.../openforms/contrib/customer_interactions/client.py 0.00% 2 Missing and 2 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6486      +/-   ##
==========================================
- Coverage   97.22%   97.21%   -0.02%     
==========================================
  Files         860      860              
  Lines       33061    33066       +5     
  Branches     2999     3001       +2     
==========================================
+ Hits        32143    32144       +1     
- Misses        606      608       +2     
- Partials      312      314       +2     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 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.

The tests are failing because Open Klant doesn't have the needed change implemented.
After the new Open Klant version is released, the supported vertsion in the docs should be updated and
VCR cassettes should be re-recorded
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-backport Fix must be backported to stable release branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Open Klant: add digitaalAdres.referentie for addresses

1 participant