assinafy 2.0.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83473f4fd075a7c665a16ee6ea6c38c64c548927930221d24ecd468cce1f4203
-  data.tar.gz: 57c81beb685fe09baf9de80eb36abc628d224952b2b08e582d19e24ecb402c16
+  metadata.gz: d98e9a7dcc345cedc9196fe2356abde16e37ba098253ee66892fd62522d7eb92
+  data.tar.gz: 63ea42ed9f2f171f111f174766a29e2df588fbc832bcee3ff57747ee539a7b34
 SHA512:
-  metadata.gz: dda868b4808b8885693edc57d8825eaf25a31dd628395180f651bd479a2b59ced524205683900812aa61654b2e79a7c69a110ca8c99c54ea084f21ea3515640a
-  data.tar.gz: ba6c518504f42fddaa0f9cfe4f58b0bfe6e23a83255f2cee5ef1a76551fba72b628f8ea448ba93b24201b055fd41c2ee95882534c3eedfb334f49a5b23cb5439
+  metadata.gz: 1e6c49c00aa499cc06db92281c54f41a58afbe5431d03e319153057f417a1490b65b128873d6201845d95e69b1ac90283dc8fbbaf5cc83517a8dc430b5b460a1
+  data.tar.gz: ee0b354da27acc2bf7faa70e5416eec3e98fad6f72b822697d13d0dd7ff3938907848b772426157e5270f91f5f22d3b8c213390e8b114ef0a5adfb68ae3167b9

data/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 All notable changes to the `assinafy` Ruby gem are documented here.
 
+## [2.1.1] - 2026-11-02
+
+### Fixed
+
+- Daily account and user statistics require a `YYYY-MM` month before a request is sent.
+- Signer confirmation, field regex and tag color payloads reject malformed values before a request is sent.
+- WhatsApp notification `sent_at` values are documented as ISO 8601 date-time strings.
+
+## [2.1.0] - 2026-10-28
+
+### Added
+
+- `ContractResource` and `client.contracts` cover listing, reading, updating, relating, renewing and terminating
+  the contract terms tracked on documents, including nullable fields and optimistic `updated_at` preconditions.
+- User notification preferences support `ContractRenewalNotice`, `ContractExpiring`, `ContractExpired` and
+  `ContractRenewed`.
+
+### Changed
+
+- New or changed webhook endpoint URLs must be absolute HTTPS URLs; invalid URLs raise `ValidationError` before a
+  request.
+- Contract, document, assignment, webhook and reminder-cost response fields reflect the current API contract.
+
 ## [2.0.1] - 2026-10-19
 
 ### Fixed

data/README.en.md

@@ -691,7 +691,7 @@ See [Errors](#errors) for the full hierarchy.
 
 ## Resource reference
 
-`Assinafy::Client` exposes thirteen accessors — twelve API resources plus the local `webhook_verifier` helper:
+`Assinafy::Client` exposes fourteen accessors — thirteen API resources plus the local `webhook_verifier` helper:
 
 | Accessor                    | What it covers                                                     |
 | --------------------------- | ------------------------------------------------------------------ |
@@ -700,6 +700,7 @@ See [Errors](#errors) for the full hierarchy.
 | `client.accounts`           | Account CRUD, theme, KPI stats, brand logo                         |
 | `client.users`              | User profile, notification preferences, cross-account KPIs         |
 | `client.documents`          | Upload, list, search, rename, download, delete, verify, tags       |
+| `client.contracts`          | Contract terms, amendments, renewals, terminations                 |
 | `client.signers`            | Workspace signer CRUD + signer self-service endpoints              |
 | `client.signer_documents`   | Signer-authenticated multi-document operations + search            |
 | `client.assignments`        | List/create/sign/decline/resend/estimate assignments               |
@@ -729,11 +730,12 @@ client.accounts.delete_logo
 ```ruby
 client.users.me
 client.users.stats(granularity: 'daily', month: '2026-06')  # cross-account KPI rows
-client.users.notification_preferences                 # returns all nine owner-email preferences
-client.users.update_notification_preferences(SignerDeclined: false) # partial request; returns all nine
+client.users.notification_preferences                 # returns all thirteen owner-email preferences
+client.users.update_notification_preferences(SignerDeclined: false) # partial request; returns all thirteen
 ```
 
-Both stats methods validate `granularity` (`monthly` or `daily`) and `month` (`YYYY-MM`) locally, and return rows
+Both stats methods validate `granularity` (`monthly` or `daily`) and `month` (`YYYY-MM`) locally; daily statistics
+require `month`. They return rows
 with `period`, `documents_uploaded`, `documents_sent`, `signature_requests`,
 `signature_requests_notification_email`, `signature_requests_notification_whatsapp`,
 `signature_requests_notification_bypass`, `signature_requests_verification_email`,
@@ -781,6 +783,27 @@ client.documents.signing_progress('document-id')   # => { signed: 1, total: 2, p
 An Array `tags` filter is sent as comma-separated tag IDs. The tag arrays of `replace_tags`/`append_tags` take tag
 IDs.
 
+### Contracts
+
+```ruby
+contract = client.contracts.update(
+  'document-id',
+  status: 'active', counterparty_name: 'Example Ltda', value: 120_000, currency: 'BRL',
+  start_date: '2026-11-01', end_date: '2027-10-31', auto_renew: true,
+  renewal_term_months: 12, notice_period_days: 30
+)
+
+client.contracts.get('document-id')
+client.contracts.list(status: ['active'], ending_within_days: 30)
+client.contracts.related('document-id')
+client.contracts.renew('document-id', term: contract['term'], updated_at: contract['updated_at'])
+client.contracts.terminate('document-id', reason: 'Ended by the parties')
+```
+
+`update` is partial and preserves explicit `nil` values as JSON `null`. Link an amendment document with
+`parent_document_id` and `relation_type`. Reads require OAuth scope `documents:read`; writes require
+`documents:write` and a plan with contract tracking. `get` and `related` return `nil` when no tracked terms exist.
+
 ### Signers (workspace CRUD)
 
 ```ruby