Skip to content

Releases

v1.10.1

Choose a tag to compare

@gajaguar gajaguar released this 02 Oct 15:04
5a12ccc

What's Changed

  • fix(models): accept the object-shaped project estimate by @gajaguar in #54
  • chore(release): bump version to 1.10.1 by @gajaguar in #55

Full Changelog: v1.10.0...v1.10.1

v1.10.0

Choose a tag to compare

@gajaguar gajaguar released this 02 Oct 01:57
c167345

Added

Since 1.6.0 (this release also covers 1.7.0 to 1.9.0, which were tagged but not published separately):

  • ws.webhooks.logs, logs_page, statuses, statuses_page and list_for_addon, with the delivery-log models (#44).
  • ws.time_off_policies, ws.time_off_requests and ws.time_off_balances, with their models, filters and typed ids; includes the balance-assignment endpoints (#46).
  • ws.expenses.download_file, backed by the new Transport.request_bytes and AsyncTransport.request_bytes, which return a response body as raw bytes (#49).
  • ws.invoices, ws.invoice_items and ws.invoice_payments, with their models and filters; ws.invoices.export returns the file as bytes (#52).

All of it is sync and async. There are no breaking changes: request() keeps its signature and behavior.

Notes

  • Time off, Invoices and Expenses need a paid plan; a lower plan answers 403, raised as ForbiddenError.
  • None of the models added since 1.6.0 is verified against a real response. They follow Clockify's OpenAPI spec, with doubtful fields optional, because the account used to build the SDK is on the Free plan. That plan also answers 403 for every webhook endpoint.
  • A balance change, a balance-assignment update and deleting an invoice item are not retried after a 5xx, because repeating them would apply the change twice.

v1.6.0

Choose a tag to compare

@gajaguar gajaguar released this 01 Oct 16:24
9d63cb3

Added

  • ws.expenses (list, list_page, get, create, update, delete) and ws.expense_categories (list, list_page, create, update, update_status, delete), sync and async, with the expense models and ExpenseCategoryFilter (#42).
  • Creating and updating an expense send multipart/form-data; ExpenseFile takes the receipt as bytes so a retry can resend it.

Notes

  • Expenses need the Pro plan; a lower plan answers 403, raised as ForbiddenError.
  • The expense models follow Clockify's OpenAPI spec and are not verified against a real response.
  • Downloading an expense file is not covered yet.

v1.5.0

Choose a tag to compare

@gajaguar gajaguar released this 01 Oct 15:41
5b8135a

Added

  • ws.approvals (list, list_page, submit, submit_for_user, update, resubmit), sync and async, with the approval models and ApprovalRequestFilter (#40).

Notes

  • Approvals need the Standard plan or above; a lower plan answers 403, raised as ForbiddenError.
  • The approval models follow Clockify's OpenAPI spec and are not yet checked against a live workspace; timeViewMode is a free string because the spec lists no values.

v1.4.0

Choose a tag to compare

@gajaguar gajaguar released this 01 Oct 04:26
376069d

Added

  • ws.webhooks (list, get, create, update, delete, regenerate_token), sync and async, with the webhook models and event enums (#37).
  • verify_signature, SIGNATURE_HEADER and EVENT_TYPE_HEADER for webhook receivers (#37).
  • ws.reports (summary, detailed, weekly, shared) and its models, first versioned as 1.3.0, which was never released (#31).

Fixed

  • A detailed report without an explicit filter now sends the default detailedFilter, and WeeklyFilter.subgroup takes the new WeeklySubgroup enum (TIME or EARNINGS) (#34).
  • The developer reports host uses /report/v1 (#33).
  • A successful response with no body now returns None instead of raising, which a webhook delete needs (#37).

Notes

  • WeeklyFilter.subgroup no longer accepts a ReportGroup.
  • Clockify-Signature carrying the webhook's authToken, and an empty 200 on webhook delete, are not yet checked against a live workspace.

v1.2.0

Choose a tag to compare

@gajaguar gajaguar released this 01 Oct 02:33
ac11d7c

Added

  • user_groups.add_user and user_groups.remove_user, sync and async, covering POST and DELETE .../user-groups/{id}/users. Both return the updated UserGroup (#29).

No breaking changes.

v1.1.0

Choose a tag to compare

@gajaguar gajaguar released this 01 Oct 01:58
7e620d2

Added

  • AsyncClockifyClient and AsyncWorkspaceClient, built on httpx.AsyncClient, with the same resources and methods as the sync client (#19, #27).
  • Add-on token authentication via addon_token= or CLOCKIFY_ADDON_TOKEN, sent as X-Addon-Token (#25).

No breaking changes.

v1.0.1

Choose a tag to compare

@gajaguar gajaguar released this 30 Sep 04:21
0dd31df

Patch release. The public API is unchanged since 1.0.0.

  • Transport now receives its httpx.Auth from the client instead of building it (private module).
  • MissingCredentialsError names where to create the API key.
  • Docs: the shared credential notes under docs/sdk/ and a "Getting a credential" section in the README.

What's Changed

  • chore: sync with project-template by @gajaguar in #17
  • chore: bump pydantic from 2.13.4 to 2.13.5 by @dependabot[bot] in #16
  • ci: bump actions/upload-artifact from 4 to 7 by @dependabot[bot] in #13
  • ci: bump actions/download-artifact from 4 to 8 by @dependabot[bot] in #15
  • ci: bump actions/checkout from 5 to 7 by @dependabot[bot] in #14
  • feat(auth): align credential handling with the SDK credential contract by @gajaguar in #21
  • docs: adopt the shared credential notes by @gajaguar in #22
  • chore: release 1.0.1 by @gajaguar in #23

New Contributors

Full Changelog: v1.0.0...v1.0.1

v1.0.0

Choose a tag to compare

@gajaguar gajaguar released this 29 Sep 01:57
89bb2cb

What's Changed

  • docs: prepare project for public release by @gajaguar in #4
  • chore: standardize project against the internal Python project template by @gajaguar in #5
  • feat: support api key provider callbacks by @gajaguar in #6
  • fix(docs): prune boilerplate and leaked scaffold references by @gajaguar in #7
  • chore: sync project with the standard template by @gajaguar in #9
  • docs: add CONTRIBUTING.md by @gajaguar in #10
  • fix: align branch types with the Conventional Branch spec by @gajaguar in #11
  • chore(release): prepare v1.0.0 for public release by @gajaguar in #12

Full Changelog: https://github.com/gajaguar/clockify-sdk/commits/v1.0.0