README

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This PHP package is automatically generated by the Swagger Codegen project:

API version: 0.0.1
Package version: 0.0.28
Build package: class io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/squiggle-dev/squiggle-php.git"
    }
  ],
  "require": {
    "squiggle-dev/squiggle-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/squiggle-php/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 API key authorization: jwt
Squiggle\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Squiggle\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Squiggle\Api\DefaultApi();
$data = new \Squiggle\Model\Address(); // \Squiggle\Model\Address | 

try {
    $result = $api_instance->addAddress($data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addAddress: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

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

Class	Method	HTTP request
DefaultApi	addAddress	POST /addresses
DefaultApi	addAddressBatch	POST /addresses/batch
DefaultApi	addClient	POST /clients
DefaultApi	addFile	POST /files
DefaultApi	addGlobalTemplate	POST /global-templates
DefaultApi	addSnippet	POST /snippets
DefaultApi	addTemplate	POST /templates
DefaultApi	addUser	POST /users
DefaultApi	deleteAddress	DELETE /addresses/{id}
DefaultApi	deleteFile	DELETE /files/{id}
DefaultApi	deleteGlobalTemplate	DELETE /global-templates/{id}
DefaultApi	deleteSnippet	DELETE /snippets/{id}
DefaultApi	deleteTemplate	DELETE /templates/{id}
DefaultApi	deleteUser	DELETE /users/{id}
DefaultApi	editAddress	PATCH /addresses/{id}
DefaultApi	editFile	PATCH /files/{id}
DefaultApi	editGlobalTemplate	PATCH /global-templates/{id}
DefaultApi	editSnippet	PATCH /snippets/{id}
DefaultApi	editTemplate	PATCH /templates/{id}
DefaultApi	editUser	PATCH /users/{id}
DefaultApi	findAddresses	GET /addresses
DefaultApi	findFiles	GET /files
DefaultApi	findGlobalTemplates	GET /global-templates
DefaultApi	findSignatures	GET /signatures
DefaultApi	findSnippets	GET /snippets
DefaultApi	findTemplates	GET /templates
DefaultApi	findUsers	GET /users
DefaultApi	generateAddressAuthCode	POST /addresses/generate-auth-code
DefaultApi	generateAddressAuthCodeById	POST /addresses/generate-auth-code/{id}
DefaultApi	getAddress	GET /addresses/{id}
DefaultApi	getAddressToken	POST /token/address
DefaultApi	getFile	GET /files/{id}
DefaultApi	getGlobalTemplate	GET /global-templates/{id}
DefaultApi	getImage	GET /image/{id}
DefaultApi	getSignature	GET /signatures/{id}
DefaultApi	getSnippet	GET /snippets/{id}
DefaultApi	getTemplate	GET /templates/{id}
DefaultApi	getUser	GET /users/{id}
DefaultApi	getUserToken	POST /token/user
DefaultApi	render	POST /render

squiggle-dev / squiggle-php

Maintainers

Details