CHANGELOG.md from uktrade/directory-api-client

CHANGELOG.md
Summary

Maintainability

Test Coverage

Issues
# Changelog

## [26.4.7](https://github.com/uktrade/directory-api-client/pull/180) (2024-02-21)

- POLS-94 - Add code owners file

## [26.4.12](https://github.com/uktrade/directory-api-client/pull/179) (2024-02-19)

- KLS-1948 - Use at least 7.2.12 of directory-client-core

## [26.4.2](https://pypi.org/project/directory-api-client/26.4.2/) (2023-07-06)

- KLS-822 - Use at least 7.2.5 of directory-client-core

## [26.4.1](https://pypi.org/project/directory-api-client/26.4.1/) (2023-07-05)

- KLS-822 - Use at least 7.2.4 of directory-client-core

## [26.4.0](https://pypi.org/project/directory-api-client/26.4.0/) (2023-07-03)

- KLS-822 - Upgrade django version to Django 4.2.3

## [26.2.1](https://pypi.org/project/directory-api-client/26.2.1/) (2023-02-16)

- KLS-400 - Upgrade vulnerable django version to Django 3.2.18

## [26.2.0](https://pypi.org/project/directory-api-client/26.2.0/) (2023-01-10)

- Upgrade Wheel package to 0.38.1

## [26.1.0](https://pypi.org/project/directory-api-client/26.1.0/) (2022-12-07)

- KLS-245 - Survey details endpoint

## [26.0.0](https://pypi.org/project/directory-api-client/26.0.0/) (2022-10-20)

- KLS-97 - Data services UK's FTAs endpoint

## [25.1.0](https://pypi.org/project/directory-api-client/25.1.0/) (2022-08-19)

- GLS-391 - Increase directory_client_core version for Django 3.2 upgrade

## [25.0.0](https://pypi.org/project/directory-api-client/25.0.0/) (2022-08-19)

- GLS-391 - Increase django requirements

## [24.6.0](https://pypi.org/project/directory-api-client/24.6.0/) (2022-05-25)

- GLS-360 - Data services economic highlights endpoint

## [24.5.1](https://pypi.org/project/directory-api-client/24.5.1/) (2022-05-25)

- GLS-186 - Remove unused year parameter

## [24.5.0](https://pypi.org/project/directory-api-client/24.5.0/) (2022-05-11)

- GLS-186 - Data Services' top five goods

## [24.4.0](https://pypi.org/project/directory-api-client/24.4.0/) (2022-05-11)

- GLS-186 - Data Services' top five services

## [24.3.0](https://pypi.org/project/directory-api-client/24.3.0/) (2022-04-27)

- GLS-186 - Data Services' trade highlights endpoint

## [24.2.0](https://pypi.org/project/directory-api-client/24.2.0/) (2022-03-11)

- GLS-163/GLS-173 - add get_total_trade_data_by_country, get_commodity_exports_data_by_country and get_trade_in_service_data_by_country

## [24.1.0](https://pypi.org/project/directory-api-client/24.1.0/) (2021-11-19)

- GP2-3123-remove-redundant-code
  removed get_population_data , get_population_data_by_country

## [24.0.0](https://pypi.org/project/directory-api-client/24.0.0/) (2021-09-16)

- GP2-3343 - Anonymous unsubscribe via token - Breaking change

## [23.1.5](https://pypi.org/project/directory-api-client/23.1.5/) (2021-09-09)

- GP2-3341-fix-ep-caching

## [23.1.4](https://pypi.org/project/directory-api-client/23.1.4/) (2021-09-02)

- No ticket - Test publish process

## [23.1.3](https://pypi.org/project/directory-api-client/23.1.3/) (2021-09-01)

- GP2-3275 - Export-plan-delete

## [23.00.0](https://pypi.org/project/directory-api-client/23.00.0/) (2021-06-07)

- GP2-3173 multi-Export-plan-list Breaking change

## [22.20.0](https://pypi.org/project/directory-api-client/22.20.0/) (2021-06-07)

- GP2-2856 - remove unused api calls

## [22.19.0](https://pypi.org/project/directory-api-client/22.19.0/) (2021-05-04)

- GP2-2401- ahh method for export plan pdf save

## [22.18.0](https://pypi.org/project/directory-api-client/22.18.0/) (2021-04-06)

- GP2-2336-collapse-api-object remove redudant collection add/remove/delete methods

## [22.17.0](https://pypi.org/project/directory-api-client/22.17.0/) (2021-04-07)

- GP2-1709 -trade barrier integratio

## [22.16.0](https://pypi.org/project/directory-api-client/22.15.0/) (2021-03-12)

- GP2-1724 - remove redundant comtrade endpoints

## [22.15.0](https://pypi.org/project/directory-api-client/22.15.0/) (2021-02-26)

- GP2-1398 - added multiple country endpoints for import data and country data

## [22.14.0](https://pypi.org/project/directory-api-client/22.14.0/) (2021-02-08)

- NOTICKET - add generic model object export plan CRUD endpoints
- NOTICKET - upgrade pip install on publish and test

## [22.13.0](https://pypi.org/project/directory-api-client/22.13.0/) (2021-02-03)

- GP2-1344 - added trading blocs endpoint

## [22.12.0](https://pypi.org/project/directory-api-client/22.12.0/) (2021-01-21)

- GP2-1359 - add credit funding options methods

## [22.11.0](https://pypi.org/project/directory-api-client/22.11.0/) (2021-01-14)

- GP2-1258 - Add endpoint for society data

## [22.10.0](https://pypi.org/project/directory-api-client/22.10.0/) (2020-12-10)

- GP2-1025 - Refactor comtrade endpoint

## [22.9.1](https://pypi.org/project/directory-api-client/22.9.1/) (2020-12-10)

- GP2-1068 - adopt Black auto-formatting + provide optional pre-commit config

## [22.9.0](https://pypi.org/project/directory-api-client/22.9.0/) (2020-11-30)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/128/files)

- GP2-1063 - Moved SuggestedCountries under dataservices app

## [22.8.0](https://pypi.org/project/directory-api-client/22.8.0/) (2020-11-23)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/127/files)

- GB2-1025 - Added endpoint for ComTrade's economy data

## [22.7.0](https://pypi.org/project/directory-api-client/22.7.0/) (2020-11-09)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/126/files)

- GB2-918 - Amended request param to plural

## [22.6.0](https://pypi.org/project/directory-api-client/22.6.0/) (2020-11-04)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/125/files)

- GB2-918 - Added endpoint for target market data

## [22.5.0](https://pypi.org/project/directory-api-client/22.5.0/) (2020-11-03)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/124/files)

- GBAU-217 - Data retention - added delete endpoint for complete deletion by sso_id

## [22.4.0](https://pypi.org/project/directory-api-client/22.4.0/) (2020-10-21)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/123/files)

- GP2-510 - Suggested Countries endpoint

## [22.3.0](https://pypi.org/project/directory-api-client/22.3.0/) (2020-08-18)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/122/files)
GP2-339-add-adaption-tm-documents

## [22.2.0](https://pypi.org/project/directory-api-client/22.2.0/) (2020-08-04)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/201/files)
GP2-315-route-to-market

# Changelog

## [22.1.0](https://pypi.org/project/directory-api-client/22.1.0/) (2020-07-28)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/200/files)
GP2-188 target-research-data

# Changelog

## [22.0.0](https://pypi.org/project/directory-api-client/22.0.0/) (2020-07-02)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/119/files)
GP2-169-load-IMF-Data
Update method names for data services

# Changelog

## [21.10.0](https://pypi.org/project/directory-api-client/21.10.0/) (2020-06-12)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/118/files)
GP2-125 - Add business objectives delete endpoint

## [21.9.0](https://pypi.org/project/directory-api-client/21.9.0/) (2020-06-12)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/117/files)
GP2-125 - Add business objectives rest CRUD api

## [21.8.0](https://pypi.org/project/directory-api-client/21.8.0/) (2020-04-06)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/115/files)
MVP-384 recommended countries

## [21.7.0](https://pypi.org/project/directory-api-client/21.7.0/) (2020-03-12)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/113/files)

- MVP Add search term to personalisation ExOps Api

## [21.6.0](https://pypi.org/project/directory-api-client/21.6.0/) (2020-03-11)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/114/files)

- MVP Add Comtrade data

## [21.5.0](https://pypi.org/project/directory-api-client/21.5.0/) (2020-03-03)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/112/files)

- MVP add dataservices

## [21.4.0](https://pypi.org/project/directory-api-client/21.4.0/) (2020-02-20)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/111/files)

- MVP Add events personalisation

## [21.3.0](https://pypi.org/project/directory-api-client/21.3.0/) (2020-02-18)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/109/files)

- TT-2288 Add support for custom authenticators in Test API helpers

## [21.2.2](https://pypi.org/project/directory-api-client/21.2.2/) (2020-02-14)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/108/files)

- fix expose exportplan client

## [21.2.1](https://pypi.org/project/directory-api-client/21.2.1/) (2020-02-13)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/104/files)

- Add personalisation accessor to client

## [21.2.0](https://pypi.org/project/directory-api-client/21.2.0/) (2020-02-12)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/104/files)

- Add user location create handler

## [21.1.0](https://pypi.org/project/directory-api-client/21.1.0/) (2020-02-11)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/103/files)

- add export plan saving and retrieving

## [21.0.0](https://pypi.org/project/directory-api-client/21.0.0/) (2019-10-02)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/102/files)
-- Add Name to be saved to supplier on collaborator_invite_accept

## [20.0.0](https://pypi.org/project/directory-api-client/20.0.0/) (2019-09-13)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/101/files)

## Fixed Bugs

- Added authentication to collaborator_create

## [19.0.0](https://pypi.org/project/directory-api-client/19.0.0/) (2019-09-09)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/101/files)

## Breaking changes

- `supplier.retrieve_profile` now expects sso_id rather than sso_session_id

## [18.0.0](https://pypi.org/project/directory-api-client/18.0.0/) (2019-09-03)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/99/files)

## Breaking changes

- Remove `sso_session_id` from call signature of `company.collaborator_invite_retrieve`

## [17.1.0](https://pypi.org/project/directory-api-client/17.1.0/) (2019-08-30)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/98/files)

## Implemented enhancements

- added method `company.collaborator_invite_delete`
- added method `company.collaborator_role_update`

## [17.0.0](https://pypi.org/project/directory-api-client/17.0.0/) (2019-08-29)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/97/files)

## Implemented enhancements

- added method `collaborator_invite_list`

## Breaking changes

The following methods on `company` have been renamed for consistency:

| old name                      | new name                      |
| ----------------------------- | ----------------------------- |
| update_profile                | profile_update                |
| retrieve_private_profile      | profile_retrieve              |
| retrieve_public_profile       | published_profile_retrieve    |
| create_case_study             | case_study_create             |
| update_case_study             | case_study_update             |
| delete_case_study             | case_study_delete             |
| retrieve_private_case_study   | case_study_retrieve           |
| retrieve_public_case_study    | published_case_study_retrieve |
| request_collaboration         | collaborator_request_create   |
| remove_collaborators          | collaborator_disconnect       |
| add_collaborator              | collaborator_create           |
| retrieve_collaborators        | collaborator_list             |
| create_transfer_invite        | collaborator_invite_create    |
| retrieve_transfer_invite      | collaborator_invite_retrieve  |
| accept_transfer_invite        | collaborator_invite_accept    |
| create_collaboration_invite   | collaborator_invite_create    |
| retrieve_collaboration_invite | collaborator_invite_retrieve  |
| accept_collaboration_invite   | collaborator_invite_accept    |

## [16.3.0](https://pypi.org/project/directory-api-client/16.3.0/) (2019-08-28)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/96/files)

- Add handler for listing supplier sso ids

## [16.2.0](https://pypi.org/project/directory-api-client/16.2.0/) (2019-08-21)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/95/files)

## Implemented enhancements

- Add a new method to remove self from company profile

## [16.1.0](https://pypi.org/project/directory-api-client/16.1.0/) (2019-08-20)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/94/files)

## Implemented enhancements

- Add a new method to register second user to company profile

## [16.0.0](https://pypi.org/project/directory-api-client/16.0.0/) (2019-08-16)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/92/files)

### Implemented enhancements

- Support Django 1.11.23 through 3.x
- Added request identity verification handler
- Removed use of TestCase with pytest

### Breaking changes

- Dropped support form Django <1.11.23
- Removed company.list_public_profiles

## [15.1.0](https://pypi.org/project/directory-api-client/15.1.0/) (2019-07-04)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/91/files)

### Implemented enhancements

- Support Django 1.11.22 through 2.x

## [15.0.0](https://pypi.org/project/directory-api-client/15.0.0/) (2019-07-04)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/90/files)

### Implemented enhancements

- Use fallback cache on more endpoints that support it

### Bugs fixed

- Removed fallback cache usage for endpoints can leak user details

### Breaking changes

- Removed `company.search_case_study`
- Renamed `company.search_company` to `company.search_find_a_supplier`

## [14.0.1](https://pypi.org/project/directory-api-client/14.0.1/) (2019-07-04)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/88/files)

### Implemented enhancements

- No ticket - Can now import the instantiated client as `from directory_api_client import api_client`
- No ticket - Remove `version.py`

### Bugs fixed

- No ticket - Upgrade vulnerable django version to django 1.11.22

## [14.0.0](https://pypi.org/project/directory-api-client/14.0.0/) (2019-04-23)

[Full Changelog](https://github.com/uktrade/directory-api-client/pull/87/files)

**Implemented enhancements:**

- Upgraded directory client core to reduce overzealous logging from the fallback cache.
- Improved documentation in readme.
- The client responses are now subclasses of `request.Response`.

**Breaking changes:**

- Directory client core has been upgraded a major version 5.0.0. [See](https://github.com/uktrade/directory-client-core/pull/16)
- Dropped support for Python 3.5
- The client responses dropped the `raw_response` property. The attributes of `raw_response` are now available on the client responses.