meioco3/docspring

2.3.3 2023-09-26 07:00 UTC

Requires

• php: >=5.6
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^7.8

Requires (Dev)

• friendsofphp/php-cs-fixer: ~2.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

proprietary

• OpenAPI-Generator contributors

• php
• rest
• api
• sdk
• openapitools
• openapi-generator

README

DocSpring is a service that helps you fill out and sign PDF templates.

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: v1
• Package version: 1.3.2
• Build package: com.docspring.codegen.DocSpringPhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, 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:

    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 and then run the following:

<?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_000000000000000002; // string | 
$add_fields_data = new \DocSpring\Model\AddFieldsData(); // \DocSpring\Model\AddFieldsData | 

try {
    $result = $apiInstance->addFieldsToTemplate($template_id, $add_fields_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PDFApi->addFieldsToTemplate: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.docspring.com/api/v1

Documentation For Models

• AddFieldsData
• AddFieldsTemplateResponse
• AuthenticationError
• AuthenticationSuccessResponse
• CombinePdfsData
• CombinedSubmission
• CombinedSubmissionAction
• CombinedSubmissionData
• CopyTemplateData
• CreateCombinedSubmissionResponse
• CreateCustomFileData
• CreateCustomFileResponse
• CreateFolderData
• CreateHtmlTemplateData
• CreateSubmissionBatchResponse
• CreateSubmissionBatchSubmissionsResponse
• CreateSubmissionDataRequestData
• CreateSubmissionDataRequestTokenResponse
• CreateSubmissionDataRequestTokenResponseToken
• CreateSubmissionResponse
• CreateTemplateFromUploadData
• CustomFile
• Error
• Folder
• FoldersFolder
• FullTemplate
• FullTemplateDefaults
• HtmlTemplateData
• InvalidRequest
• ListSubmissionsResponse
• MoveFolderData
• MoveTemplateData
• PendingTemplate
• RenameFolderData
• Submission
• SubmissionAction
• SubmissionBatch
• SubmissionBatchData
• SubmissionData
• SubmissionDataBatchRequest
• SubmissionDataRequest
• Template
• TemplateData
• TemplatestemplateIdaddFieldsFields
• UpdateDataRequestResponse
• UpdateSubmissionDataRequestData
• UpdateTemplateData
• UpdateTemplateResponse
• UploadTemplateData
• UploadTemplateDataDocument
• UploadTemplateDataDocumentMetadata

Documentation For Authorization

api_token_basic

• Type: HTTP basic authentication

Author