{"id":19383885,"url":"https://github.com/docspring/formapi-php","last_synced_at":"2025-06-21T06:05:06.121Z","repository":{"id":62506636,"uuid":"126843741","full_name":"DocSpring/formapi-php","owner":"DocSpring","description":"PHP API client for FormAPI","archived":false,"fork":false,"pushed_at":"2019-10-09T17:51:11.000Z","size":208,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-21T06:04:45.221Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://packagist.org/packages/formapi/formapi","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}},"created_at":"2018-03-26T14:44:46.000Z","updated_at":"2019-11-06T18:40:11.000Z","dependencies_parsed_at":"2022-11-02T10:16:06.640Z","dependency_job_id":null,"html_url":"https://github.com/DocSpring/formapi-php","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/DocSpring/formapi-php","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DocSpring","download_url":"https://codeload.github.com/DocSpring/formapi-php/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-php/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261073340,"owners_count":23105638,"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","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-11-10T09:28:16.556Z","updated_at":"2025-06-21T06:05:01.108Z","avatar_url":"https://github.com/DocSpring.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FormAPI\nFormAPI is a service that helps you fill out and sign PDF templates.\n\nThis PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: v1\n- Package version: 1.13.0\n- Build package: io.formapi.codegen.FormApiPhpClientCodegen\n\n## Requirements\n\nPHP 5.5 and later\n\n## Installation \u0026 Usage\n### Composer\n\nTo install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:\n\n```\n{\n  \"repositories\": [\n    {\n      \"type\": \"git\",\n      \"url\": \"https://github.com/formapi/formapi.git\"\n    }\n  ],\n  \"require\": {\n    \"formapi/formapi\": \"*@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    require_once('/path/to/FormAPI/vendor/autoload.php');\n```\n\n## Tests\n\nTo run the unit tests:\n\n```\ncomposer install\n./vendor/bin/phpunit\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// Configure HTTP basic authorization: api_token_basic\n$config = FormAPI\\Configuration::getDefaultConfiguration()\n    -\u003esetUsername('YOUR_USERNAME')\n    -\u003esetPassword('YOUR_PASSWORD');\n\n$apiInstance = new FormAPI\\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_000000000000000001; // string | \n$request_body = array(new \\FormAPI\\Model\\array()); // object[] | \n\ntry {\n    $result = $apiInstance-\u003ebatchGeneratePdfV1($template_id, $request_body);\n    print_r($result);\n} catch (Exception $e) {\n    echo 'Exception when calling PDFApi-\u003ebatchGeneratePdfV1: ', $e-\u003egetMessage(), PHP_EOL;\n}\n\n?\u003e\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.formapi.io/api/v1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*PDFApi* | [**batchGeneratePdfV1**](docs/Api/PDFApi.md#batchgeneratepdfv1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs\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* | [**createCustomFileFromUpload**](docs/Api/PDFApi.md#createcustomfilefromupload) | **POST** /custom_files | Create a new custom file from a cached presign upload\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* | [**createTemplate**](docs/Api/PDFApi.md#createtemplate) | **POST** /templates | Upload a new PDF template with a file upload\n*PDFApi* | [**createTemplateFromUpload**](docs/Api/PDFApi.md#createtemplatefromupload) | **POST** /templates?v\u0026#x3D;2 | 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* | [**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* | [**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* | [**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} | Get a single template\n*PDFApi* | [**getTemplateSchema**](docs/Api/PDFApi.md#gettemplateschema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template\n*PDFApi* | [**listFolders**](docs/Api/PDFApi.md#listfolders) | **GET** /folders/ | Get a list of all folders\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* | [**renameFolder**](docs/Api/PDFApi.md#renamefolder) | **POST** /folders/{folder_id}/rename | Rename a folder\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\n\n## Documentation For Models\n\n - [AuthenticationError](docs/Model/AuthenticationError.md)\n - [AuthenticationSuccessResponse](docs/Model/AuthenticationSuccessResponse.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 - [CreateCombinedSubmissionResponse](docs/Model/CreateCombinedSubmissionResponse.md)\n - [CreateCustomFileData](docs/Model/CreateCustomFileData.md)\n - [CreateCustomFileResponse](docs/Model/CreateCustomFileResponse.md)\n - [CreateFolderData](docs/Model/CreateFolderData.md)\n - [CreateSubmissionBatchResponse](docs/Model/CreateSubmissionBatchResponse.md)\n - [CreateSubmissionBatchSubmissionsResponse](docs/Model/CreateSubmissionBatchSubmissionsResponse.md)\n - [CreateSubmissionDataRequestData](docs/Model/CreateSubmissionDataRequestData.md)\n - [CreateSubmissionDataRequestTokenResponse](docs/Model/CreateSubmissionDataRequestTokenResponse.md)\n - [CreateSubmissionDataRequestTokenResponseToken](docs/Model/CreateSubmissionDataRequestTokenResponseToken.md)\n - [CreateSubmissionResponse](docs/Model/CreateSubmissionResponse.md)\n - [CreateTemplateData](docs/Model/CreateTemplateData.md)\n - [CustomFile](docs/Model/CustomFile.md)\n - [Error](docs/Model/Error.md)\n - [Folder](docs/Model/Folder.md)\n - [FoldersFolder](docs/Model/FoldersFolder.md)\n - [InvalidRequest](docs/Model/InvalidRequest.md)\n - [MoveFolderData](docs/Model/MoveFolderData.md)\n - [MoveTemplateData](docs/Model/MoveTemplateData.md)\n - [PendingTemplate](docs/Model/PendingTemplate.md)\n - [RenameFolderData](docs/Model/RenameFolderData.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 - [SubmissionData](docs/Model/SubmissionData.md)\n - [SubmissionDataBatchRequest](docs/Model/SubmissionDataBatchRequest.md)\n - [SubmissionDataRequest](docs/Model/SubmissionDataRequest.md)\n - [Template](docs/Model/Template.md)\n - [Templatesv2Template](docs/Model/Templatesv2Template.md)\n - [Templatesv2TemplateDocument](docs/Model/Templatesv2TemplateDocument.md)\n - [Templatesv2TemplateDocumentMetadata](docs/Model/Templatesv2TemplateDocumentMetadata.md)\n - [UpdateDataRequestResponse](docs/Model/UpdateDataRequestResponse.md)\n - [UpdateSubmissionDataRequestData](docs/Model/UpdateSubmissionDataRequestData.md)\n\n\n## Documentation For Authorization\n\n\n## api_token_basic\n\n- **Type**: HTTP basic authentication\n\n\n## Author\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fformapi-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocspring%2Fformapi-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fformapi-php/lists"}