v0.7.2

Fixes

• Fix race condition for concurrent requests using the protected decorator.

Additions

• The Client can now be used as an async context manager which starts
  and closes the client automatically.

Changes

• The InvalidKeyHandlerT and ExcHandlerT types no longer include Optional,
  and instead are wrapped in Optional in the function signature.

---

Diff: v0.7.1...v0.7.2
Changelog: v0.7.2

v0.7.1

Fixes

• Fix invalid docs link.

---

Diff: v0.7.0...v0.7.1
Changelog: v0.7.1

v0.7.0

Additions

• Add protected decorator for verifying keys easily in web frameworks.

Changes

• Client constructor parameter api_key is now optional.

---

Diff: v0.6.1...v0.7.0
Changelog: v0.7.0

v0.6.1

Changes

• Inner return type of KeyService.update_remaining is now correctly
  Optional.

---

Diff: v0.6.0...v0.6.1
Changelog: v0.6.1

v0.6.0

Additions

• Add Refill, RefillInterval, and UpdateOp models/enums.
• Add id property onto ApiKeyVerification.
• Add refill property onto ApiKeyMeta and ApiKeyVerification.
• Add serialization methods for new properties and models.
• Add support for refill when creating and updating a key.
• Add update_remaining method to KeyService and corresponding Route.

---

Diff: v0.5.0...v0.6.0
Changelog: v0.6.0

v0.5.0

Breaking Changes

• verify_key now requires an api_id parameter.
• list_keys no longer accepts the offset parameter.

Additions

• Add Conflict variant to ErrorCode.
• Add get_key method to KeyService.
• Add cursor parameter to list_keys.

Bugfixes

• Fix invalid default used when ratelimit was not passed in create_key.

Changes

• Refactor internal routes to use new API endpoints.

---

Diff: v0.4.3...v0.5.0
Changelog: v0.5.0

v0.4.3

v0.4.3 (Sep 2023)

Additions

• Add NotUnique and InvalidKeyType variants to ErrorCode.

Changes

• Rename UsageExceeded error code to KeyUsageExceeded.

---

Diff: v0.4.2...v0.4.3
Changelog: v0.4.3

v0.4.2

v0.4.2

Additions

• Add RatelimitState model.
• Add ratelimit and expires fields to ApiKeyVerification.

---

Diff: v0.4.1...v0.4.2
Changelog: v0.4.2

v0.4.1

Changes

• UNDEFINED is now guaranteed to be a singleton, preventing id(obj) mismatches.

Bugfixes

• Client.start() now correctly initializes a new client session if called
  after closing the client previously.

Additions

• Tests :).

---

Diff: v0.4.0...v0.4.1
Changelog: v0.4.1

v0.4.0

Additions

• Add UNDEFINED, UndefinedOr, and UndefinedNoneOr types.
• Add update_key method to key service.
• Add name parameter to the create_key method.

Changes

• Refactor existing methods to use the new UNDEFINED type.

---

Diff: v0.3.0...v0.4.0
Changelog: v0.4.0