Digitalmarketplace-apiclient

Latest version: v24.0.0

Safety actively analyzes 715081 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 4 of 4

6.0.0

PR: [31](https://github.com/alphagov/digitalmarketplace-apiclient/pull/31)

What changed

Removed `update_brief_status` method.

This functionality has been removed and calls to publish a brief (i.e. change it's status from
'draft' to 'live') should now use the `publish_brief` method. There should no other current
uses of the `update_brief_status` in our apps that set a status to something other than 'live'.

Example app change

Old
python
api_client.update_brief_status(brief_id, 'live', user)


New
python
api_client.publish_brief(brief_id, user)

5.0.0

PR: [28](https://github.com/alphagov/digitalmarketplace-apiclient/pull/28)

What changed

Changed `register_framework_agreement_returned` from taking an optional `agreement_details`
parameter to taking an optional `uploader_user_id` parameter. This is because when returning an
agreement (that has a framework agreement version), we expect only an `uploader_user_id` instead
of a flexible dictionary and have made this method stricter to enforce/strongly encourage this.

At the moment, this should cause no actual breaks in our applications as the `agreement_details`
parameter is not yet being used.

4.0.0

PR: [26](https://github.com/alphagov/digitalmarketplace-apiclient/pull/26)

What changed

Removed the `unset_framework_agreement_returned` method.

This shouldn't require any changes as this method is only used in at most one old script and should
never need to be used again.

3.0.0

PR: [14](https://github.com/alphagov/digitalmarketplace-apiclient/pull/14)

What changed

All POST, PUT and DELETE methods are now sending `"updated_by"` payload instead of `"update_details"`.
The new payload should be supported by the data API for all methods.

This shouldn't require any changes to the code that's using `DataAPIClient`, but might break test
expectations if any of them rely on `update_details` payload key.

Example app change

Search for `update_details` and replace all instances of `{"update_details": {"updated_by": ...}}` with
`{"updated_by": ...}` if they affect the tests.

2.0.0

PR: [8](https://github.com/alphagov/digitalmarketplace-apiclient/pull/8)

What changed

The `authenticate_user` method used to take a boolean flag to indicate if the user is a supplier user.
Now it just returns users with any role, and it is up to the front-end apps to decide if the authenticated
user should be allowed to access a resource.

Example app change

Old
python
user = api_client.authenticate_user("email_address", "password", supplier=False)


New
python
user = api_client.authenticate_user("email_address", "password")

1.0.0

PR: [1](https://github.com/alphagov/digitalmarketplace-apiclient/pull/1)

What changed

Initial import from digitalmarketplace-utils. Compared to the latest utils version
the package name is now changed from `dmutils.apiclient` to `dmapiclient` and
audit module was moved from `dmutils.audit` to `dmapiclient.audit`.

Main package imports (ie `from dmutils.apiclient import ...`) can be preserved by
`dmutils`, however imports from `dmutils.apiclient.*` modules will have to be
changed to either imports from the main package namespace or the new package name
(eg `from dmapiclient.errors import ...`).

Example app change

Old
python
from dmutils.apiclient import SearchAPIClient
from dmutils.apiclient.base import BaseAPIClient
from dmutils.audit import AuditTypes


New
python
from dmapiclient import SearchAPIClient
from dmapiclient.base import BaseAPIClient
from dmapiclient.audit import AuditTypes

Page 4 of 4

© 2025 Safety CLI Cybersecurity Inc. All Rights Reserved.