Repository navigation
Releases
Releases · gajaguar/clockify-sdk
v1.10.1
v1.10.0
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_pageandlist_for_addon, with the delivery-log models (#44).ws.time_off_policies,ws.time_off_requestsandws.time_off_balances, with their models, filters and typed ids; includes the balance-assignment endpoints (#46).ws.expenses.download_file, backed by the newTransport.request_bytesandAsyncTransport.request_bytes, which return a response body as raw bytes (#49).ws.invoices,ws.invoice_itemsandws.invoice_payments, with their models and filters;ws.invoices.exportreturns 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 asForbiddenError. - 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
403for 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
Added
ws.expenses(list,list_page,get,create,update,delete) andws.expense_categories(list,list_page,create,update,update_status,delete), sync and async, with the expense models andExpenseCategoryFilter(#42).- Creating and updating an expense send
multipart/form-data;ExpenseFiletakes the receipt as bytes so a retry can resend it.
Notes
- Expenses need the Pro plan; a lower plan answers
403, raised asForbiddenError. - 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
Added
ws.approvals(list,list_page,submit,submit_for_user,update,resubmit), sync and async, with the approval models andApprovalRequestFilter(#40).
Notes
- Approvals need the Standard plan or above; a lower plan answers
403, raised asForbiddenError. - The approval models follow Clockify's OpenAPI spec and are not yet checked against a live workspace;
timeViewModeis a free string because the spec lists no values.
v1.4.0
Added
ws.webhooks(list,get,create,update,delete,regenerate_token), sync and async, with the webhook models and event enums (#37).verify_signature,SIGNATURE_HEADERandEVENT_TYPE_HEADERfor 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, andWeeklyFilter.subgrouptakes the newWeeklySubgroupenum (TIMEorEARNINGS) (#34). - The developer reports host uses
/report/v1(#33). - A successful response with no body now returns
Noneinstead of raising, which a webhook delete needs (#37).
Notes
WeeklyFilter.subgroupno longer accepts aReportGroup.Clockify-Signaturecarrying the webhook'sauthToken, and an empty200on webhook delete, are not yet checked against a live workspace.
v1.2.0
v1.1.0
v1.0.1
Patch release. The public API is unchanged since 1.0.0.
Transportnow receives itshttpx.Authfrom the client instead of building it (private module).MissingCredentialsErrornames 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
- @dependabot[bot] made their first contribution in #16
Full Changelog: v1.0.0...v1.0.1
v1.0.0
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