{"id":17972431,"url":"https://github.com/docspring/docspring-php","last_synced_at":"2025-08-16T17:31:03.522Z","repository":{"id":56970632,"uuid":"220522809","full_name":"DocSpring/docspring-php","owner":"DocSpring","description":"PHP API Client for DocSpring","archived":false,"fork":false,"pushed_at":"2025-03-22T10:22:02.000Z","size":527,"stargazers_count":0,"open_issues_count":2,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-14T21:36:23.096Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://packagist.org/packages/docspring/docspring","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DocSpring.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-08T18:11:15.000Z","updated_at":"2025-03-22T10:22:06.000Z","dependencies_parsed_at":"2024-11-14T18:48:26.563Z","dependency_job_id":null,"html_url":"https://github.com/DocSpring/docspring-php","commit_stats":{"total_commits":10,"total_committers":1,"mean_commits":10.0,"dds":0.0,"last_synced_commit":"2f12ceac80414dbcee561bfc0dd792eeaf550d3c"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/DocSpring/docspring-php","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DocSpring","download_url":"https://codeload.github.com/DocSpring/docspring-php/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-php/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270746033,"owners_count":24638267,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-16T02:00:11.002Z","response_time":91,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-29T16:15:48.175Z","updated_at":"2025-08-16T17:31:03.496Z","avatar_url":"https://github.com/DocSpring.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DocSpring\n\nDocSpring provides an API that helps you fill out and sign PDF templates.\n\n\n## Installation \u0026 Usage\n\n### Requirements\n\nPHP 7.4 and later.\nShould also work with PHP 8.0.\n\n### Composer\n\nTo install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:\n\n```json\n{\n  \"repositories\": [\n    {\n      \"type\": \"vcs\",\n      \"url\": \"https://github.com/docspring/docspring.git\"\n    }\n  ],\n  \"require\": {\n    \"docspring/docspring\": \"*@dev\"\n  }\n}\n```\n\nThen run `composer install`\n\n### Manual Installation\n\nDownload the files and include `autoload.php`:\n\n```php\n\u003c?php\nrequire_once('/path/to/DocSpring/vendor/autoload.php');\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```php\n\u003c?php\nrequire_once(__DIR__ . '/vendor/autoload.php');\n\n\n\n// Configure HTTP basic authorization: api_token_basic\n$config = DocSpring\\Configuration::getDefaultConfiguration()\n              -\u003esetUsername('YOUR_USERNAME')\n              -\u003esetPassword('YOUR_PASSWORD');\n\n\n$apiInstance = new DocSpring\\Api\\PDFApi(\n    // If you want use custom http client, pass your client which implements `GuzzleHttp\\ClientInterface`.\n    // This is optional, `GuzzleHttp\\Client` will be used as default.\n    new GuzzleHttp\\Client(),\n    $config\n);\n$template_id = tpl_1234567890abcdef02; // string\n$data = new \\DocSpring\\Model\\AddFieldsData(); // \\DocSpring\\Model\\AddFieldsData\n\ntry {\n    $result = $apiInstance-\u003eaddFieldsToTemplate($template_id, $data);\n    print_r($result);\n} catch (Exception $e) {\n    echo 'Exception when calling PDFApi-\u003eaddFieldsToTemplate: ', $e-\u003egetMessage(), PHP_EOL;\n}\n\n```\n\n## API Endpoints\n\nAll URIs are relative to *https://sync.api.docspring.com/api/v1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*PDFApi* | [**addFieldsToTemplate**](docs/Api/PDFApi.md#addfieldstotemplate) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template\n*PDFApi* | [**batchGeneratePdfs**](docs/Api/PDFApi.md#batchgeneratepdfs) | **POST** /submissions/batches | Generates multiple PDFs\n*PDFApi* | [**combinePdfs**](docs/Api/PDFApi.md#combinepdfs) | **POST** /combined_submissions?v\u0026#x3D;2 | Merge submission PDFs, template PDFs, or custom files\n*PDFApi* | [**combineSubmissions**](docs/Api/PDFApi.md#combinesubmissions) | **POST** /combined_submissions | Merge generated PDFs together\n*PDFApi* | [**copyTemplate**](docs/Api/PDFApi.md#copytemplate) | **POST** /templates/{template_id}/copy | Copy a Template\n*PDFApi* | [**createCustomFileFromUpload**](docs/Api/PDFApi.md#createcustomfilefromupload) | **POST** /custom_files | Create a new custom file from a cached presign upload\n*PDFApi* | [**createDataRequestEvent**](docs/Api/PDFApi.md#createdatarequestevent) | **POST** /data_requests/{data_request_id}/events | Creates a new event for emailing a signee a request for signature\n*PDFApi* | [**createDataRequestToken**](docs/Api/PDFApi.md#createdatarequesttoken) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication\n*PDFApi* | [**createFolder**](docs/Api/PDFApi.md#createfolder) | **POST** /folders/ | Create a folder\n*PDFApi* | [**createHTMLTemplate**](docs/Api/PDFApi.md#createhtmltemplate) | **POST** /templates?endpoint_description\u0026#x3D;html | Create a new HTML template\n*PDFApi* | [**createPDFTemplate**](docs/Api/PDFApi.md#createpdftemplate) | **POST** /templates | Create a new PDF template with a form POST file upload\n*PDFApi* | [**createPDFTemplateFromUpload**](docs/Api/PDFApi.md#createpdftemplatefromupload) | **POST** /templates?endpoint_description\u0026#x3D;cached_upload | Create a new PDF template from a cached presign upload\n*PDFApi* | [**deleteFolder**](docs/Api/PDFApi.md#deletefolder) | **DELETE** /folders/{folder_id} | Delete a folder\n*PDFApi* | [**deleteTemplate**](docs/Api/PDFApi.md#deletetemplate) | **DELETE** /templates/{template_id} | Delete a template\n*PDFApi* | [**expireCombinedSubmission**](docs/Api/PDFApi.md#expirecombinedsubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission\n*PDFApi* | [**expireSubmission**](docs/Api/PDFApi.md#expiresubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission\n*PDFApi* | [**generatePdf**](docs/Api/PDFApi.md#generatepdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF\n*PDFApi* | [**generatePdfForHtmlTemplate**](docs/Api/PDFApi.md#generatepdfforhtmltemplate) | **POST** /templates/{template_id}/submissions?endpoint_description\u0026#x3D;html_templates | Generates a new PDF for an HTML template\n*PDFApi* | [**generatePreview**](docs/Api/PDFApi.md#generatepreview) | **POST** /submissions/{submission_id}/generate_preview | Generated a preview PDF for partially completed data requests\n*PDFApi* | [**getCombinedSubmission**](docs/Api/PDFApi.md#getcombinedsubmission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)\n*PDFApi* | [**getDataRequest**](docs/Api/PDFApi.md#getdatarequest) | **GET** /data_requests/{data_request_id} | Look up a submission data request\n*PDFApi* | [**getFullTemplate**](docs/Api/PDFApi.md#getfulltemplate) | **GET** /templates/{template_id}?full\u0026#x3D;true | Fetch the full attributes for a PDF template\n*PDFApi* | [**getPresignUrl**](docs/Api/PDFApi.md#getpresignurl) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket\n*PDFApi* | [**getSubmission**](docs/Api/PDFApi.md#getsubmission) | **GET** /submissions/{submission_id} | Check the status of a PDF\n*PDFApi* | [**getSubmissionBatch**](docs/Api/PDFApi.md#getsubmissionbatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job\n*PDFApi* | [**getTemplate**](docs/Api/PDFApi.md#gettemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template\n*PDFApi* | [**getTemplateSchema**](docs/Api/PDFApi.md#gettemplateschema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template\n*PDFApi* | [**listCombinedSubmissions**](docs/Api/PDFApi.md#listcombinedsubmissions) | **GET** /combined_submissions | Get a list of all combined submissions\n*PDFApi* | [**listFolders**](docs/Api/PDFApi.md#listfolders) | **GET** /folders/ | Get a list of all folders\n*PDFApi* | [**listSubmissions**](docs/Api/PDFApi.md#listsubmissions) | **GET** /submissions | List all submissions\n*PDFApi* | [**listTemplateSubmissions**](docs/Api/PDFApi.md#listtemplatesubmissions) | **GET** /templates/{template_id}/submissions | List all submissions for a given template\n*PDFApi* | [**listTemplates**](docs/Api/PDFApi.md#listtemplates) | **GET** /templates | Get a list of all templates\n*PDFApi* | [**moveFolderToFolder**](docs/Api/PDFApi.md#movefoldertofolder) | **POST** /folders/{folder_id}/move | Move a folder\n*PDFApi* | [**moveTemplateToFolder**](docs/Api/PDFApi.md#movetemplatetofolder) | **POST** /templates/{template_id}/move | Move Template to folder\n*PDFApi* | [**publishTemplateVersion**](docs/Api/PDFApi.md#publishtemplateversion) | **POST** /templates/{template_id}/publish_version | Publish a template version\n*PDFApi* | [**renameFolder**](docs/Api/PDFApi.md#renamefolder) | **POST** /folders/{folder_id}/rename | Rename a folder\n*PDFApi* | [**restoreTemplateVersion**](docs/Api/PDFApi.md#restoretemplateversion) | **POST** /templates/{template_id}/restore_version | Restore a template version\n*PDFApi* | [**testAuthentication**](docs/Api/PDFApi.md#testauthentication) | **GET** /authentication | Test Authentication\n*PDFApi* | [**updateDataRequest**](docs/Api/PDFApi.md#updatedatarequest) | **PUT** /data_requests/{data_request_id} | Update a submission data request\n*PDFApi* | [**updateTemplate**](docs/Api/PDFApi.md#updatetemplate) | **PUT** /templates/{template_id} | Update a Template\n\n## Models\n\n- [AddFieldsData](docs/Model/AddFieldsData.md)\n- [BatchGeneratePdfs201Response](docs/Model/BatchGeneratePdfs201Response.md)\n- [CombinePdfsData](docs/Model/CombinePdfsData.md)\n- [CombinedSubmission](docs/Model/CombinedSubmission.md)\n- [CombinedSubmissionAction](docs/Model/CombinedSubmissionAction.md)\n- [CombinedSubmissionData](docs/Model/CombinedSubmissionData.md)\n- [CopyTemplateOptions](docs/Model/CopyTemplateOptions.md)\n- [CreateCombinedSubmissionResponse](docs/Model/CreateCombinedSubmissionResponse.md)\n- [CreateCustomFileData](docs/Model/CreateCustomFileData.md)\n- [CreateCustomFileResponse](docs/Model/CreateCustomFileResponse.md)\n- [CreateFolderData](docs/Model/CreateFolderData.md)\n- [CreateHtmlSubmissionData](docs/Model/CreateHtmlSubmissionData.md)\n- [CreateHtmlTemplate](docs/Model/CreateHtmlTemplate.md)\n- [CreatePdfSubmissionData](docs/Model/CreatePdfSubmissionData.md)\n- [CreatePdfTemplate](docs/Model/CreatePdfTemplate.md)\n- [CreateSubmissionDataRequestData](docs/Model/CreateSubmissionDataRequestData.md)\n- [CreateSubmissionDataRequestEventRequest](docs/Model/CreateSubmissionDataRequestEventRequest.md)\n- [CreateSubmissionDataRequestEventResponse](docs/Model/CreateSubmissionDataRequestEventResponse.md)\n- [CreateSubmissionDataRequestResponse](docs/Model/CreateSubmissionDataRequestResponse.md)\n- [CreateSubmissionDataRequestTokenResponse](docs/Model/CreateSubmissionDataRequestTokenResponse.md)\n- [CreateSubmissionResponse](docs/Model/CreateSubmissionResponse.md)\n- [CustomFile](docs/Model/CustomFile.md)\n- [ErrorResponse](docs/Model/ErrorResponse.md)\n- [Folder](docs/Model/Folder.md)\n- [JsonSchema](docs/Model/JsonSchema.md)\n- [ListSubmissionsResponse](docs/Model/ListSubmissionsResponse.md)\n- [MoveFolderData](docs/Model/MoveFolderData.md)\n- [MoveTemplateData](docs/Model/MoveTemplateData.md)\n- [MultipleErrorsResponse](docs/Model/MultipleErrorsResponse.md)\n- [PublishVersionData](docs/Model/PublishVersionData.md)\n- [RenameFolderData](docs/Model/RenameFolderData.md)\n- [RestoreVersionData](docs/Model/RestoreVersionData.md)\n- [Submission](docs/Model/Submission.md)\n- [SubmissionAction](docs/Model/SubmissionAction.md)\n- [SubmissionBatch](docs/Model/SubmissionBatch.md)\n- [SubmissionBatchData](docs/Model/SubmissionBatchData.md)\n- [SubmissionBatchWithSubmissions](docs/Model/SubmissionBatchWithSubmissions.md)\n- [SubmissionDataRequest](docs/Model/SubmissionDataRequest.md)\n- [SubmissionDataRequestEvent](docs/Model/SubmissionDataRequestEvent.md)\n- [SubmissionDataRequestShow](docs/Model/SubmissionDataRequestShow.md)\n- [SubmissionDataRequestToken](docs/Model/SubmissionDataRequestToken.md)\n- [SubmissionPreview](docs/Model/SubmissionPreview.md)\n- [SuccessErrorResponse](docs/Model/SuccessErrorResponse.md)\n- [SuccessMultipleErrorsResponse](docs/Model/SuccessMultipleErrorsResponse.md)\n- [Template](docs/Model/Template.md)\n- [TemplateAddFieldsResponse](docs/Model/TemplateAddFieldsResponse.md)\n- [TemplateDeleteResponse](docs/Model/TemplateDeleteResponse.md)\n- [TemplatePreview](docs/Model/TemplatePreview.md)\n- [TemplatePublishVersionResponse](docs/Model/TemplatePublishVersionResponse.md)\n- [UpdateHtmlTemplate](docs/Model/UpdateHtmlTemplate.md)\n- [UpdateSubmissionDataRequestData](docs/Model/UpdateSubmissionDataRequestData.md)\n- [UploadPresignResponse](docs/Model/UploadPresignResponse.md)\n\n## Authorization\n\nAuthentication schemes defined for the API:\n### api_token_basic\n\n- **Type**: HTTP basic authentication\n\n## Tests\n\nTo run the tests, use:\n\n```bash\ncomposer install\nvendor/bin/phpunit\n```\n\n## Author\n\n\n\n## About this package\n\nThis PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: `v1`\n    - Package version: `2.1.0`\n    - Generator version: `7.11.0`\n- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fdocspring-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocspring%2Fdocspring-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fdocspring-php/lists"}