From 5af74fdb7fdd688c238a5e3b4f97ef5cfae92d1e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Emilio=20Vargas=20Mill=C3=A1n?= <103036961+EmilioVar@users.noreply.github.com> Date: Wed, 11 Jun 2025 10:07:39 +0200 Subject: [PATCH] Update README.md, document getSignatures method parameters Add parameter descriptions and usage examples for getSignatures method to improve API documentation clarity. --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 277bad6..fba32da 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,22 @@ $response = $client->getSignatures(50); ##### Getting signatures with custom field "crm_id" ```php -$response = $client->getSignatures(100, 0, ['crm_id' => 'CUSTOM_ID']) +$response = $client->getSignatures(100, 0, ['crm_id' => 'CUSTOM_ID']); +``` + +**Parameters:** + +- **`$limit`** (int): Maximum number of signatures to return in the response. In this example: `100` +- **`$offset`** (int): Number of records to skip from the beginning. Useful for pagination. In this example: `0` (start from the first record) +- **`$filters`** (array, optional): Associative array with filters to search for specific signatures. In this example: `['crm_id' => 'CUSTOM_ID']` filters by the custom field "crm_id" + +**Usage examples:** +```php +// Get the first 100 signatures with a specific CRM ID +$response = $client->getSignatures(100, 0, ['crm_id' => 'CUSTOM_ID']); + +// Get the next 50 signatures (pagination) +$response = $client->getSignatures(50, 100, ['crm_id' => 'CUSTOM_ID']); ``` ### Get signature request