Skip to content

CHANGELOG.rst

Latest commit

 

History

History
256 lines (191 loc) · 8.05 KB

CHANGELOG.rst

File metadata and controls

256 lines (191 loc) · 8.05 KB

master

7.1.0 (2026-05-29)

Features:

  • add events_schema, query_events, and group_events for the Events API

7.0.0 (2026-05-29)

Breaking Changes:

  • require Python 3.9 or newer (3.4–3.8 are no longer supported)
  • remove track, authenticate, device management, and impersonation client methods; use risk, filter, and log instead
  • remove ImpersonationFailed

Features:

  • add Lists and List Items APIs
  • add Privacy API (request_user_data, delete_user_data)
  • add RateLimitError for HTTP 429 responses

Bug fixes:

  • fix Client.filter and Client.risk failover when user is missing; fall back to matching_user_id

Enhancements:

  • remove unused ValidatorsNotSupported validator
  • migrate CI to GitHub Actions (Python 3.9–3.13)
  • migrate packaging to pyproject.toml (PEP 621)
  • replace pylint/autopep8 with ruff
  • bump requests minimum to 2.31

6.1.0 (2022-03-14)

  • #111 fix context preparation issues
  • #111 remove SDK based validations

Features:

  • #111 add InvalidRequestTokenError

Enhancements:

  • #111 remove X-Castle headers from the allowlist
  • #112 extend failover response with policy action

6.0.0 (2021-06-02)

Breaking Changes:

Features:

  • #104 add "filter", "log" and "risk" actions

Enhancements:

  • #100 add X-Requested-With header support

5.0.1 (2021-01-19)

Enhancements:

  • #98 rename the namespace from IP to IPs

5.0.0 (2021-01-19)

Breaking Changes:

  • #92 change the impersonation-related DSL
  • #80, #81 reorganize structure of the SDK
  • #79 rename config.url to config.base_url

Features:

  • #97 allow to instantiate the configuration
  • #95 add webhooks verification
  • #88, #89, #90, #91 allow to manage the devices
  • #86, #87 add more tests
  • #85 add Verdict and Failover strategy constants
  • #84 update the default timeout
  • #83 add logger config option
  • #82 drop origin from the default context

4.0.0 (2020-07-06)

Features:

  • #69 added impersonator to properties

Breaking Changes:

  • #70 dropped blacklist and whitelist support, in favour of denylist and allowlist

3.3.0 (2020-05-22)

  • #67 add trusted_proxy_depth and trust_proxy_chain configuration options

3.2.0 (2020-02-31)

  • #64 dropped X-Client-Id from calculation of ip, drop appending default ip headers to the ip_header list config when config is provided (in that case default headers have to explicitly provided)

3.1.0 (2020-02-27)

  • #61 improve headers and ip extractions, improve ip_headers config, add trusted proxies config, added more events to events list
  • #62 move request,response, session to apis namespace, add config check before doing request

3.0.0 (2020-02-13)

  • #59 drop requests min version in ci
  • #56 drop special ip header behavior
  • #58 Adds ip_header configuration option

Breaking Changes:

  • #57 dropped support for python 2

2.4.0 (2019-11-20)

  • #53 update whitelisting and blacklisting behavior

2.3.1 (2019-04-05)

  • #50 generate new default timestamps for each call

2.3.0 (2019-01-16)

  • #48 add connection pooling
  • #47 add event constants
  • #40 remove requirement for user_id

2.2.1 (2018-09-04)

  • #41 add python 2.6, python 3.7

2.2.0 (2018-04-18)

Breaking Changes:

  • #35 usage of traits key is deprecated, use user_traits instead
  • #38 make api related errors inherit from ApiError
  • #38 rename FailoverStrategyValueError to ConfigurationError

Enhancements:

  • #37 X-Castle-Client-Id takes precedence over cid from cookies
  • #36 raise ImpersonationFailed when impersonation request failed

2.1.1 (2018-02-26)

Features:

  • add reset option to impersonation

2.1.0 (2018-02-09)

Features:

  • add support for impersonation

Breaking Changes:

  • switched configuration request_timeout from seconds to milliseconds

2.0.0 (2018-02-09)

Features:

  • code reorganization
  • added Client.to_context method which allows to generate context object from the request
  • additional timestamp and sent_at time values are automatically added to the requests
  • when data is sent in batches you may want to wrap data options with Client.to_options method before you send it to the worker (see README) to include proper timestamp in the query
  • added X-Forwarded-For and CF_CONNECTING_IP to whitelisted headers
  • fetch IP from CF_CONNECTING_IP if possible

Breaking Changes:

  • Client does not build context object anymore to use previous functionality use Client.from_request
  • code reorganization

1.0.1 (2017-12-08)

  • Handle cookies from Django request

1.0.0 (2017-10-16)

  • Initial release