Skip to content

Add PHP SDK Documentation #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicolasiscoding merged 4 commits into from
Jan 19, 2026
Merged

Add PHP SDK Documentation #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f5b7aaf
Add comprehensive PHP SDK documentation
nicolasiscoding Jan 17, 2026
a5883f0
fix(php-sdk): address technical review findings
nicolasiscoding Jan 17, 2026
9163f52
fix(javascript-sdk): remove incorrect N8n prefix from type names
nicolasiscoding Jan 18, 2026
89298c8
fix: fixed some changes
AmitSharma512 Jan 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 79 additions & 6 deletions docs/SDKs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,13 @@ Official client libraries for the TurboDocx API. Build document generation and d

## Available SDKs

| Language | Package | Install Command | Links |
| :------------------------ | :------------------------- | :------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------- |
| **JavaScript/TypeScript** | `@turbodocx/sdk` | `npm install @turbodocx/sdk` | [Docs](/docs/SDKs/javascript) [GitHub](https://github.com/TurboDocx/SDK/tree/main/packages/js-sdk) |
| **Python** | `turbodocx-sdk` | `pip install turbodocx-sdk` | [Docs](/docs/SDKs/python) [GitHub](https://github.com/TurboDocx/SDK/tree/main/packages/py-sdk) |
| **Go** | `github.com/turbodocx/sdk` | `go get github.com/turbodocx/sdk` | [Docs](/docs/SDKs/go) [GitHub](https://github.com/TurboDocx/SDK/tree/main/packages/go-sdk) |
| **Java** | `com.turbodocx:sdk` | [Maven Central](https://search.maven.org/artifact/com.turbodocx/sdk) | [Docs](/docs/SDKs/java) [GitHub](https://github.com/TurboDocx/SDK/tree/main/packages/java-sdk) |
| Language | Package | Install Command | Links |
| :------------------------ | :------------------------- | :------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------- |
| **JavaScript/TypeScript** | `@turbodocx/sdk` | `npm install @turbodocx/sdk` | [Docs](/docs/SDKs/javascript) [GitHub](https://github.com/TurboDocx/SDK/tree/main/packages/js-sdk) |
| **Python** | `turbodocx-sdk` | `pip install turbodocx-sdk` | [Docs](/docs/SDKs/python) [GitHub](https://github.com/TurboDocx/SDK/tree/main/packages/py-sdk) |
| **PHP** | `turbodocx/sdk` | `composer require turbodocx/sdk` | [Docs](/docs/SDKs/php) [GitHub](https://github.com/TurboDocx/SDK/tree/main/packages/php-sdk) |
| **Go** | `github.com/turbodocx/sdk` | `go get github.com/turbodocx/sdk` | [Docs](/docs/SDKs/go) [GitHub](https://github.com/TurboDocx/SDK/tree/main/packages/go-sdk) |
| **Java** | `com.turbodocx:sdk` | [Maven Central](https://search.maven.org/artifact/com.turbodocx/sdk) | [Docs](/docs/SDKs/java) [GitHub](https://github.com/TurboDocx/SDK/tree/main/packages/java-sdk) |

:::tip Low-code or No-code?
Check out our [n8n community node](https://www.npmjs.com/package/@turbodocx/n8n-nodes-turbodocx) for workflow automation, or get [TurboDocx Writer](https://appsource.microsoft.com/en-us/product/office/WA200007397) for Microsoft Word.
Expand Down Expand Up @@ -100,6 +101,13 @@ pip install turbodocx-sdk
poetry add turbodocx-sdk
```

</TabItem>
<TabItem value="php" label="PHP">

```bash
composer require turbodocx/sdk
```

</TabItem>
<TabItem value="go" label="Go">

Expand Down Expand Up @@ -220,6 +228,50 @@ result = TurboSign.send_signature(
print(f"Document sent! ID: {result.documentId}")
```

</TabItem>
<TabItem value="php" label="PHP">

```php
<?php

use TurboDocx\TurboSign;
use TurboDocx\Config\HttpClientConfig;
use TurboDocx\Types\Recipient;
use TurboDocx\Types\Field;
use TurboDocx\Types\SignatureFieldType;
use TurboDocx\Types\Requests\SendSignatureRequest;

// Configure with your API key
TurboSign::configure(new HttpClientConfig(
apiKey: $_ENV['TURBODOCX_API_KEY'],
orgId: $_ENV['TURBODOCX_ORG_ID'],
senderEmail: $_ENV['TURBODOCX_SENDER_EMAIL']
));

// Send a document for signature
$result = TurboSign::sendSignature(
new SendSignatureRequest(
recipients: [
new Recipient('John Doe', '[email protected]', 1)
],
fields: [
new Field(
type: SignatureFieldType::SIGNATURE,
recipientEmail: '[email protected]',
page: 1,
x: 100,
y: 500,
width: 200,
height: 50
)
],
fileLink: 'https://example.com/contract.pdf'
)
);

echo "Document sent! ID: {$result->documentId}\n";
```

</TabItem>
<TabItem value="go" label="Go">

Expand Down Expand Up @@ -408,6 +460,27 @@ except TurboDocxError as e:
pass
```

</TabItem>
<TabItem value="php" label="PHP">

```php
<?php

use TurboDocx\TurboSign;
use TurboDocx\Exceptions\TurboDocxException;
use TurboDocx\Exceptions\ValidationException;

try {
$result = TurboSign::sendSignature(/* ... */);
} catch (ValidationException $e) {
echo "Validation error: {$e->getMessage()}\n";
// Handle validation error
} catch (TurboDocxException $e) {
echo "Error {$e->getCode()}: {$e->getMessage()}\n";
echo "Status code: {$e->statusCode}\n";
}
```

</TabItem>
<TabItem value="go" label="Go">

Expand Down
12 changes: 6 additions & 6 deletions docs/SDKs/javascript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1030,8 +1030,8 @@ The SDK exports TypeScript types for full type safety. Import them directly from
import type {
// Field types
SignatureFieldType,
N8nField,
N8nRecipient,
Field,
Recipient,
// Request types
CreateSignatureReviewLinkRequest,
SendSignatureRequest,
Expand All @@ -1057,7 +1057,7 @@ type SignatureFieldType =
| "checkbox";
```

### N8nRecipient
### Recipient

Recipient configuration for signature requests:

Expand All @@ -1067,7 +1067,7 @@ Recipient configuration for signature requests:
| `email` | `string` | Yes | Recipient's email address |
| `signingOrder` | `number` | Yes | Signing order (1-indexed) |

### N8nField
### Field

Field configuration supporting both coordinate-based and template-based positioning:

Expand Down Expand Up @@ -1110,8 +1110,8 @@ Request configuration for `createSignatureReviewLink` and `sendSignature` method
| `fileLink` | `string` | Conditional | URL to document file |
| `deliverableId` | `string` | Conditional | TurboDocx deliverable ID |
| `templateId` | `string` | Conditional | TurboDocx template ID |
| `recipients` | `N8nRecipient[]` | Yes | Recipients who will sign |
| `fields` | `N8nField[]` | Yes | Signature fields configuration |
| `recipients` | `Recipient[]` | Yes | Recipients who will sign |
| `fields` | `Field[]` | Yes | Signature fields configuration |
| `documentName` | `string` | No | Document name |
| `documentDescription` | `string` | No | Document description |
| `senderName` | `string` | No | Sender name |
Expand Down
Loading