-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated on 2019-11-09 01:22:13. Version: 1.0.0
- Loading branch information
0 parents
commit af2e630
Showing
139 changed files
with
36,118 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# ref: https://github.com/github/gitignore/blob/master/Composer.gitignore | ||
|
||
composer.phar | ||
/vendor/ | ||
vendor | ||
|
||
# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control | ||
# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file | ||
composer.lock | ||
|
||
# Custom | ||
build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# OpenAPI Generator Ignore | ||
# Generated by openapi-generator https://github.com/openapitools/openapi-generator | ||
|
||
# Use this file to prevent files from being overwritten by the generator. | ||
# The patterns follow closely to .gitignore or .dockerignore. | ||
|
||
# As an example, the C# client generator defines ApiClient.cs. | ||
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: | ||
#ApiClient.cs | ||
|
||
# You can match any string of characters against a directory, file or extension with a single asterisk (*): | ||
#foo/*/qux | ||
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux | ||
|
||
# You can recursively match patterns against a directory, file or extension with a double asterisk (**): | ||
#foo/**/qux | ||
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux | ||
|
||
# You can also negate patterns with an exclamation (!). | ||
# For example, you can ignore all files in a docs folder with the file extension .md: | ||
#docs/*.md | ||
# Then explicitly reverse the ignore rule for a single file: | ||
#!docs/README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
3.3.0-SNAPSHOT |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
<?php | ||
|
||
return PhpCsFixer\Config::create() | ||
->setUsingCache(true) | ||
->setRules([ | ||
'@PSR2' => true, | ||
'ordered_imports' => true, | ||
'phpdoc_order' => true, | ||
'array_syntax' => [ 'syntax' => 'short' ], | ||
'strict_comparison' => true, | ||
'strict_param' => true, | ||
'no_trailing_whitespace' => false, | ||
'no_trailing_whitespace_in_comment' => false, | ||
'braces' => false, | ||
'single_blank_line_at_eof' => false, | ||
'blank_line_after_namespace' => false, | ||
]) | ||
->setFinder( | ||
PhpCsFixer\Finder::create() | ||
->exclude('test') | ||
->exclude('tests') | ||
->in(__DIR__) | ||
); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
language: php | ||
sudo: false | ||
php: | ||
- 5.4 | ||
- 5.5 | ||
- 5.6 | ||
- 7.0 | ||
- hhvm | ||
before_install: "composer install" | ||
script: "vendor/bin/phpunit" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
### 1.13.0 [October 10, 2019] | ||
|
||
- Add permanent_download_url attribute to Submission model | ||
|
||
### 1.12.0 [October 9, 2019] | ||
|
||
- Add parent folder ID and path params to GET template response | ||
- Add parent folder ID param when creating a new template, so you can upload a template into a folder | ||
|
||
### 1.11.0 [July 31, 2019] | ||
* Added Create Folder, List Folder, Move to Folder endpoints | ||
* **BREAKING CHANGE** Added parent_folder_id query parameter to "List Templates". | ||
|
||
### 1.10.1 [July 3, 2019] | ||
|
||
- Fixed combineSubmissions and combinePdfs helpers when "strict mode" is enabled by setting error_reporting | ||
|
||
### 1.10.0 [July 3, 2019] | ||
|
||
- Added combinePdfs wrapper that handles polling and doesn't return a pending combined submission job | ||
|
||
### 1.9.0 [June 22, 2019] | ||
|
||
- **BREAKING CHANGE** Renamed "Get Templates" endpoint to "List Templates". Added a search query parameter. | ||
|
||
### 1.8.0 [April 11, 2019] | ||
|
||
- Added support for editable PDFS (editable: true) | ||
|
||
### 1.7.0 [December 23, 2018] | ||
|
||
- Added CustomFiles, and combinePdf call to support many different types of source PDFs. Renamed a few models | ||
|
||
### 1.6.0 [December 18, 2018] | ||
|
||
- Updated API host to api.formapi.io | ||
|
||
### 1.5.0 [December 13, 2018] | ||
|
||
- Fix model name for newly created Templates (PendingTemplate) | ||
- Added "actions" to submission and combined_submission responses. Includes information about custom S3 uploads | ||
|
||
### 1.4.0 [December 1, 2018] | ||
|
||
- Added Create Template, Get Template, and Get Template Schema endpoints | ||
|
||
### 1.3.1 [November 4, 2018] | ||
|
||
- Initial changelog |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
Copyright © 2018 Form Applications Inc. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,174 @@ | ||
# DocSpring | ||
DocSpring is a service that helps you fill out and sign PDF templates. | ||
|
||
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: | ||
|
||
- API version: v1 | ||
- Package version: 1.0.0 | ||
- Build package: com.docspring.codegen.DocSpringPhpClientCodegen | ||
|
||
## Requirements | ||
|
||
PHP 5.5 and later | ||
|
||
## Installation & Usage | ||
### Composer | ||
|
||
To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`: | ||
|
||
``` | ||
{ | ||
"repositories": [ | ||
{ | ||
"type": "git", | ||
"url": "https://github.com/docspring/docspring.git" | ||
} | ||
], | ||
"require": { | ||
"docspring/docspring": "*@dev" | ||
} | ||
} | ||
``` | ||
|
||
Then run `composer install` | ||
|
||
### Manual Installation | ||
|
||
Download the files and include `autoload.php`: | ||
|
||
```php | ||
require_once('/path/to/DocSpring/vendor/autoload.php'); | ||
``` | ||
|
||
## Tests | ||
|
||
To run the unit tests: | ||
|
||
``` | ||
composer install | ||
./vendor/bin/phpunit | ||
``` | ||
|
||
## Getting Started | ||
|
||
Please follow the [installation procedure](#installation--usage) and then run the following: | ||
|
||
```php | ||
<?php | ||
require_once(__DIR__ . '/vendor/autoload.php'); | ||
|
||
// Configure HTTP basic authorization: api_token_basic | ||
$config = DocSpring\Configuration::getDefaultConfiguration() | ||
->setUsername('YOUR_USERNAME') | ||
->setPassword('YOUR_PASSWORD'); | ||
|
||
$apiInstance = new DocSpring\Api\PDFApi( | ||
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. | ||
// This is optional, `GuzzleHttp\Client` will be used as default. | ||
new GuzzleHttp\Client(), | ||
$config | ||
); | ||
$template_id = tpl_000000000000000001; // string | | ||
$request_body = array(new \DocSpring\Model\array()); // object[] | | ||
|
||
try { | ||
$result = $apiInstance->batchGeneratePdfV1($template_id, $request_body); | ||
print_r($result); | ||
} catch (Exception $e) { | ||
echo 'Exception when calling PDFApi->batchGeneratePdfV1: ', $e->getMessage(), PHP_EOL; | ||
} | ||
|
||
?> | ||
``` | ||
|
||
## Documentation for API Endpoints | ||
|
||
All URIs are relative to *https://api.docspring.com/api/v1* | ||
|
||
Class | Method | HTTP request | Description | ||
------------ | ------------- | ------------- | ------------- | ||
*PDFApi* | [**batchGeneratePdfV1**](docs/Api/PDFApi.md#batchgeneratepdfv1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs | ||
*PDFApi* | [**batchGeneratePdfs**](docs/Api/PDFApi.md#batchgeneratepdfs) | **POST** /submissions/batches | Generates multiple PDFs | ||
*PDFApi* | [**combinePdfs**](docs/Api/PDFApi.md#combinepdfs) | **POST** /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files | ||
*PDFApi* | [**combineSubmissions**](docs/Api/PDFApi.md#combinesubmissions) | **POST** /combined_submissions | Merge generated PDFs together | ||
*PDFApi* | [**createCustomFileFromUpload**](docs/Api/PDFApi.md#createcustomfilefromupload) | **POST** /custom_files | Create a new custom file from a cached presign upload | ||
*PDFApi* | [**createDataRequestToken**](docs/Api/PDFApi.md#createdatarequesttoken) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication | ||
*PDFApi* | [**createFolder**](docs/Api/PDFApi.md#createfolder) | **POST** /folders/ | Create a folder | ||
*PDFApi* | [**createTemplate**](docs/Api/PDFApi.md#createtemplate) | **POST** /templates | Upload a new PDF template with a file upload | ||
*PDFApi* | [**createTemplateFromUpload**](docs/Api/PDFApi.md#createtemplatefromupload) | **POST** /templates?v=2 | Create a new PDF template from a cached presign upload | ||
*PDFApi* | [**deleteFolder**](docs/Api/PDFApi.md#deletefolder) | **DELETE** /folders/{folder_id} | Delete a folder | ||
*PDFApi* | [**expireCombinedSubmission**](docs/Api/PDFApi.md#expirecombinedsubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission | ||
*PDFApi* | [**expireSubmission**](docs/Api/PDFApi.md#expiresubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission | ||
*PDFApi* | [**generatePDF**](docs/Api/PDFApi.md#generatepdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF | ||
*PDFApi* | [**getCombinedSubmission**](docs/Api/PDFApi.md#getcombinedsubmission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs) | ||
*PDFApi* | [**getDataRequest**](docs/Api/PDFApi.md#getdatarequest) | **GET** /data_requests/{data_request_id} | Look up a submission data request | ||
*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 | ||
*PDFApi* | [**getSubmission**](docs/Api/PDFApi.md#getsubmission) | **GET** /submissions/{submission_id} | Check the status of a PDF | ||
*PDFApi* | [**getSubmissionBatch**](docs/Api/PDFApi.md#getsubmissionbatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job | ||
*PDFApi* | [**getTemplate**](docs/Api/PDFApi.md#gettemplate) | **GET** /templates/{template_id} | Get a single template | ||
*PDFApi* | [**getTemplateSchema**](docs/Api/PDFApi.md#gettemplateschema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template | ||
*PDFApi* | [**listFolders**](docs/Api/PDFApi.md#listfolders) | **GET** /folders/ | Get a list of all folders | ||
*PDFApi* | [**listTemplates**](docs/Api/PDFApi.md#listtemplates) | **GET** /templates | Get a list of all templates | ||
*PDFApi* | [**moveFolderToFolder**](docs/Api/PDFApi.md#movefoldertofolder) | **POST** /folders/{folder_id}/move | Move a folder | ||
*PDFApi* | [**moveTemplateToFolder**](docs/Api/PDFApi.md#movetemplatetofolder) | **POST** /templates/{template_id}/move | Move Template to folder | ||
*PDFApi* | [**renameFolder**](docs/Api/PDFApi.md#renamefolder) | **POST** /folders/{folder_id}/rename | Rename a folder | ||
*PDFApi* | [**testAuthentication**](docs/Api/PDFApi.md#testauthentication) | **GET** /authentication | Test Authentication | ||
*PDFApi* | [**updateDataRequest**](docs/Api/PDFApi.md#updatedatarequest) | **PUT** /data_requests/{data_request_id} | Update a submission data request | ||
|
||
|
||
## Documentation For Models | ||
|
||
- [AuthenticationError](docs/Model/AuthenticationError.md) | ||
- [AuthenticationSuccessResponse](docs/Model/AuthenticationSuccessResponse.md) | ||
- [CombinePdfsData](docs/Model/CombinePdfsData.md) | ||
- [CombinedSubmission](docs/Model/CombinedSubmission.md) | ||
- [CombinedSubmissionAction](docs/Model/CombinedSubmissionAction.md) | ||
- [CombinedSubmissionData](docs/Model/CombinedSubmissionData.md) | ||
- [CreateCombinedSubmissionResponse](docs/Model/CreateCombinedSubmissionResponse.md) | ||
- [CreateCustomFileData](docs/Model/CreateCustomFileData.md) | ||
- [CreateCustomFileResponse](docs/Model/CreateCustomFileResponse.md) | ||
- [CreateFolderData](docs/Model/CreateFolderData.md) | ||
- [CreateSubmissionBatchResponse](docs/Model/CreateSubmissionBatchResponse.md) | ||
- [CreateSubmissionBatchSubmissionsResponse](docs/Model/CreateSubmissionBatchSubmissionsResponse.md) | ||
- [CreateSubmissionDataRequestData](docs/Model/CreateSubmissionDataRequestData.md) | ||
- [CreateSubmissionDataRequestTokenResponse](docs/Model/CreateSubmissionDataRequestTokenResponse.md) | ||
- [CreateSubmissionDataRequestTokenResponseToken](docs/Model/CreateSubmissionDataRequestTokenResponseToken.md) | ||
- [CreateSubmissionResponse](docs/Model/CreateSubmissionResponse.md) | ||
- [CreateTemplateData](docs/Model/CreateTemplateData.md) | ||
- [CustomFile](docs/Model/CustomFile.md) | ||
- [Error](docs/Model/Error.md) | ||
- [Folder](docs/Model/Folder.md) | ||
- [FoldersFolder](docs/Model/FoldersFolder.md) | ||
- [InvalidRequest](docs/Model/InvalidRequest.md) | ||
- [MoveFolderData](docs/Model/MoveFolderData.md) | ||
- [MoveTemplateData](docs/Model/MoveTemplateData.md) | ||
- [PendingTemplate](docs/Model/PendingTemplate.md) | ||
- [RenameFolderData](docs/Model/RenameFolderData.md) | ||
- [Submission](docs/Model/Submission.md) | ||
- [SubmissionAction](docs/Model/SubmissionAction.md) | ||
- [SubmissionBatch](docs/Model/SubmissionBatch.md) | ||
- [SubmissionBatchData](docs/Model/SubmissionBatchData.md) | ||
- [SubmissionData](docs/Model/SubmissionData.md) | ||
- [SubmissionDataBatchRequest](docs/Model/SubmissionDataBatchRequest.md) | ||
- [SubmissionDataRequest](docs/Model/SubmissionDataRequest.md) | ||
- [Template](docs/Model/Template.md) | ||
- [Templatesv2Template](docs/Model/Templatesv2Template.md) | ||
- [Templatesv2TemplateDocument](docs/Model/Templatesv2TemplateDocument.md) | ||
- [Templatesv2TemplateDocumentMetadata](docs/Model/Templatesv2TemplateDocumentMetadata.md) | ||
- [UpdateDataRequestResponse](docs/Model/UpdateDataRequestResponse.md) | ||
- [UpdateSubmissionDataRequestData](docs/Model/UpdateSubmissionDataRequestData.md) | ||
|
||
|
||
## Documentation For Authorization | ||
|
||
|
||
## api_token_basic | ||
|
||
- **Type**: HTTP basic authentication | ||
|
||
|
||
## Author | ||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
{ | ||
"name": "docspring/docspring", | ||
"version": "1.0.0", | ||
"description": "", | ||
"keywords": [ | ||
"openapitools", | ||
"openapi-generator", | ||
"php", | ||
"sdk", | ||
"rest", | ||
"api" | ||
], | ||
"homepage": "http://openapi-generator.tech", | ||
"license": "proprietary", | ||
"authors": [ | ||
{ | ||
"name": "OpenAPI-Generator contributors", | ||
"homepage": "https://openapi-generator.tech" | ||
} | ||
], | ||
"require": { | ||
"php": ">=5.5", | ||
"ext-curl": "*", | ||
"ext-json": "*", | ||
"ext-mbstring": "*", | ||
"guzzlehttp/guzzle": "^6.2" | ||
}, | ||
"require-dev": { | ||
"phpunit/phpunit": "^4.8", | ||
"squizlabs/php_codesniffer": "~2.6", | ||
"friendsofphp/php-cs-fixer": "~2.12" | ||
}, | ||
"autoload": { | ||
"psr-4": { "DocSpring\\" : "lib/" } | ||
}, | ||
"autoload-dev": { | ||
"psr-4": { "DocSpring\\" : "test/" } | ||
} | ||
} |
Oops, something went wrong.