Squiggle\DefaultApi

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

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

addAddress

\Squiggle\Model\Address addAddress($data)

Creates a new address

Example

<?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;
}
?>

Parameters

Name	Type	Description	Notes
data	\Squiggle\Model\Address

Return type

\Squiggle\Model\Address

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addAddressBatch

map[string,\Squiggle\Model\Address] addAddressBatch($data)

Creates multiple new addresses

Example

<?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 = array(new Address()); // \Squiggle\Model\Address[] | 

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

Parameters

Name	Type	Description	Notes
data	\Squiggle\Model\Address[]

Return type

map[string,\Squiggle\Model\Address]

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addClient

addClient($data)

Registers a client against an address

Example

<?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\Client(); // \Squiggle\Model\Client | 

try {
    $api_instance->addClient($data);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addClient: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
data	\Squiggle\Model\Client

Return type

void (empty response body)

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addFile

\Squiggle\Model\FileObject addFile($file, $name)

Upload a new file

Example

<?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();
$file = "/path/to/file.txt"; // \SplFileObject | 
$name = "name_example"; // string | 

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

Parameters

Name	Type	Description	Notes
file	\SplFileObject
name	string		[optional]

Return type

\Squiggle\Model\FileObject

Authorization

jwt

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addGlobalTemplate

\Squiggle\Model\GlobalTemplate addGlobalTemplate($data)

Creates a new global template

Example

<?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\GlobalTemplate(); // \Squiggle\Model\GlobalTemplate | 

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

Parameters

Name	Type	Description	Notes
data	\Squiggle\Model\GlobalTemplate

Return type

\Squiggle\Model\GlobalTemplate

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addSnippet

\Squiggle\Model\Snippet addSnippet($data)

Creates a new snippet

Example

<?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\Snippet(); // \Squiggle\Model\Snippet | 

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

Parameters

Name	Type	Description	Notes
data	\Squiggle\Model\Snippet

Return type

\Squiggle\Model\Snippet

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addTemplate

\Squiggle\Model\Template addTemplate($data)

Creates a new template

Example

<?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\Template(); // \Squiggle\Model\Template | 

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

Parameters

Name	Type	Description	Notes
data	\Squiggle\Model\Template

Return type

\Squiggle\Model\Template

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addUser

\Squiggle\Model\User addUser($data)

Creates a new user

Example

<?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\User(); // \Squiggle\Model\User | 

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

Parameters

Name	Type	Description	Notes
data	\Squiggle\Model\User

Return type

\Squiggle\Model\User

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAddress

deleteAddress($id, $force)

Deletes an address with the specified ID

Example

<?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();
$id = 789; // int | ID of address to delete
$force = true; // bool | Disables soft-delete when true, completely removing the row (use with caution!)

try {
    $api_instance->deleteAddress($id, $force);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteAddress: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	ID of address to delete
force	bool	Disables soft-delete when true, completely removing the row (use with caution!)	[optional]

Return type

void (empty response body)

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteFile

deleteFile($id)

Deletes a file with the specified ID

Example

<?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();
$id = 789; // int | ID of file to delete

try {
    $api_instance->deleteFile($id);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	ID of file to delete

Return type

void (empty response body)

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteGlobalTemplate

deleteGlobalTemplate($id, $force)

Deletes a global template with the specified ID

Example

<?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();
$id = 789; // int | ID of global template to delete
$force = true; // bool | Disables soft-delete when true, completely removing the row (use with caution!)

try {
    $api_instance->deleteGlobalTemplate($id, $force);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteGlobalTemplate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	ID of global template to delete
force	bool	Disables soft-delete when true, completely removing the row (use with caution!)	[optional]

Return type

void (empty response body)

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteSnippet

deleteSnippet($id, $force)

Deletes a snippet with the specified ID

Example

<?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();
$id = 789; // int | ID of snippet to delete
$force = true; // bool | Disables soft-delete when true, completely removing the row (use with caution!)

try {
    $api_instance->deleteSnippet($id, $force);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteSnippet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	ID of snippet to delete
force	bool	Disables soft-delete when true, completely removing the row (use with caution!)	[optional]

Return type

void (empty response body)

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteTemplate

deleteTemplate($id, $force)

Deletes a template with the specified ID

Example

<?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();
$id = 789; // int | ID of template to delete
$force = true; // bool | Disables soft-delete when true, completely removing the row (use with caution!)

try {
    $api_instance->deleteTemplate($id, $force);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteTemplate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	ID of template to delete
force	bool	Disables soft-delete when true, completely removing the row (use with caution!)	[optional]

Return type

void (empty response body)

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteUser

deleteUser($id, $force)

Deletes a user with the specified ID

Example

<?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();
$id = 789; // int | ID of user to delete
$force = true; // bool | Disables soft-delete when true, completely removing the row (use with caution!)

try {
    $api_instance->deleteUser($id, $force);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteUser: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	ID of user to delete
force	bool	Disables soft-delete when true, completely removing the row (use with caution!)	[optional]

Return type

void (empty response body)

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editAddress

\Squiggle\Model\Address editAddress($id, $data)

Updates an existing address with the specified ID

Example

<?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();
$id = 789; // int | ID of address to update
$data = new \Squiggle\Model\Address(); // \Squiggle\Model\Address | 

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

Parameters

Name	Type	Description	Notes
id	int	ID of address to update
data	\Squiggle\Model\Address

Return type

\Squiggle\Model\Address

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editFile

\Squiggle\Model\FileObject editFile($id, $file, $name)

Updates an existing file with the specified ID

Example

<?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();
$id = 789; // int | ID of file to update
$file = "/path/to/file.txt"; // \SplFileObject | 
$name = "name_example"; // string | 

try {
    $result = $api_instance->editFile($id, $file, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->editFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	ID of file to update
file	\SplFileObject		[optional]
name	string		[optional]

Return type

\Squiggle\Model\FileObject

Authorization

jwt

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editGlobalTemplate

\Squiggle\Model\GlobalTemplate editGlobalTemplate($id, $data)

Updates an existing global template with the specified ID

Example

<?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();
$id = 789; // int | ID of global template to update
$data = new \Squiggle\Model\GlobalTemplate(); // \Squiggle\Model\GlobalTemplate | 

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

Parameters

Name	Type	Description	Notes
id	int	ID of global template to update
data	\Squiggle\Model\GlobalTemplate

Return type

\Squiggle\Model\GlobalTemplate

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editSnippet

\Squiggle\Model\Snippet editSnippet($id, $data)

Updates an existing snippet with the specified ID

Example

<?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();
$id = 789; // int | ID of snippet to update
$data = new \Squiggle\Model\Snippet(); // \Squiggle\Model\Snippet | 

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

Parameters

Name	Type	Description	Notes
id	int	ID of snippet to update
data	\Squiggle\Model\Snippet

Return type

\Squiggle\Model\Snippet

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editTemplate

\Squiggle\Model\Template editTemplate($id, $data)

Updates an existing template with the specified ID

Example

<?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();
$id = 789; // int | ID of template to update
$data = new \Squiggle\Model\Template(); // \Squiggle\Model\Template | 

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

Parameters

Name	Type	Description	Notes
id	int	ID of template to update
data	\Squiggle\Model\Template

Return type

\Squiggle\Model\Template

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editUser

\Squiggle\Model\User editUser($id, $data)

Updates an existing user with the specified ID

Example

<?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();
$id = 789; // int | ID of user to update
$data = new \Squiggle\Model\User(); // \Squiggle\Model\User | 

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

Parameters

Name	Type	Description	Notes
id	int	ID of user to update
data	\Squiggle\Model\User

Return type

\Squiggle\Model\User

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

findAddresses

\Squiggle\Model\Address[] findAddresses($filter, $sort, $offset, $limit)

Gets addresses

Example

<?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();
$filter = "filter_example"; // string | A list of fields and values to filter by, in query string format eg. 'type=order&status=1'
$sort = "sort_example"; // string | A comma-separated list of fields to sort by
$offset = 56; // int | The start offset of the result set
$limit = 56; // int | Max records to return

try {
    $result = $api_instance->findAddresses($filter, $sort, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->findAddresses: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
filter	string	A list of fields and values to filter by, in query string format eg. 'type=order&status=1'	[optional]
sort	string	A comma-separated list of fields to sort by	[optional]
offset	int	The start offset of the result set	[optional]
limit	int	Max records to return	[optional]

Return type

\Squiggle\Model\Address[]

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

findFiles

\Squiggle\Model\FileObject[] findFiles($filter, $sort, $offset, $limit)

Gets files

Example

<?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();
$filter = "filter_example"; // string | A list of fields and values to filter by, in query string format eg. 'type=order&status=1'
$sort = "sort_example"; // string | A comma-separated list of fields to sort by
$offset = 56; // int | The start offset of the result set
$limit = 56; // int | Max records to return

try {
    $result = $api_instance->findFiles($filter, $sort, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->findFiles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
filter	string	A list of fields and values to filter by, in query string format eg. 'type=order&status=1'	[optional]
sort	string	A comma-separated list of fields to sort by	[optional]
offset	int	The start offset of the result set	[optional]
limit	int	Max records to return	[optional]

Return type

\Squiggle\Model\FileObject[]

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

findGlobalTemplates

\Squiggle\Model\GlobalTemplate[] findGlobalTemplates($filter, $sort, $offset, $limit)

Gets global templates

Example

<?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();
$filter = "filter_example"; // string | A list of fields and values to filter by, in query string format eg. 'type=order&status=1'
$sort = "sort_example"; // string | A comma-separated list of fields to sort by
$offset = 56; // int | The start offset of the result set
$limit = 56; // int | Max records to return

try {
    $result = $api_instance->findGlobalTemplates($filter, $sort, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->findGlobalTemplates: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
filter	string	A list of fields and values to filter by, in query string format eg. 'type=order&status=1'	[optional]
sort	string	A comma-separated list of fields to sort by	[optional]
offset	int	The start offset of the result set	[optional]
limit	int	Max records to return	[optional]

Return type

\Squiggle\Model\GlobalTemplate[]

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

findSignatures

\Squiggle\Model\Signature[] findSignatures($filter, $sort, $offset, $limit)

Gets signatures

Example

<?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();
$filter = "filter_example"; // string | A list of fields and values to filter by, in query string format eg. 'type=order&status=1'
$sort = "sort_example"; // string | A comma-separated list of fields to sort by
$offset = 56; // int | The start offset of the result set
$limit = 56; // int | Max records to return

try {
    $result = $api_instance->findSignatures($filter, $sort, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->findSignatures: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
filter	string	A list of fields and values to filter by, in query string format eg. 'type=order&status=1'	[optional]
sort	string	A comma-separated list of fields to sort by	[optional]
offset	int	The start offset of the result set	[optional]
limit	int	Max records to return	[optional]

Return type

\Squiggle\Model\Signature[]

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

findSnippets

\Squiggle\Model\Snippet[] findSnippets($filter, $sort, $offset, $limit)

Gets snippets

Example

<?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();
$filter = "filter_example"; // string | A list of fields and values to filter by, in query string format eg. 'type=order&status=1'
$sort = "sort_example"; // string | A comma-separated list of fields to sort by
$offset = 56; // int | The start offset of the result set
$limit = 56; // int | Max records to return

try {
    $result = $api_instance->findSnippets($filter, $sort, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->findSnippets: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
filter	string	A list of fields and values to filter by, in query string format eg. 'type=order&status=1'	[optional]
sort	string	A comma-separated list of fields to sort by	[optional]
offset	int	The start offset of the result set	[optional]
limit	int	Max records to return	[optional]

Return type

\Squiggle\Model\Snippet[]

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

findTemplates

\Squiggle\Model\Template[] findTemplates($filter, $sort, $offset, $limit)

Gets templates

Example

<?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();
$filter = "filter_example"; // string | A list of fields and values to filter by, in query string format eg. 'type=order&status=1'
$sort = "sort_example"; // string | A comma-separated list of fields to sort by
$offset = 56; // int | The start offset of the result set
$limit = 56; // int | Max records to return

try {
    $result = $api_instance->findTemplates($filter, $sort, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->findTemplates: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
filter	string	A list of fields and values to filter by, in query string format eg. 'type=order&status=1'	[optional]
sort	string	A comma-separated list of fields to sort by	[optional]
offset	int	The start offset of the result set	[optional]
limit	int	Max records to return	[optional]

Return type

\Squiggle\Model\Template[]

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

findUsers

\Squiggle\Model\User[] findUsers($filter, $sort, $offset, $limit)

Gets users

Example

<?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();
$filter = "filter_example"; // string | A list of fields and values to filter by, in query string format eg. 'type=order&status=1'
$sort = "sort_example"; // string | A comma-separated list of fields to sort by
$offset = 56; // int | The start offset of the result set
$limit = 56; // int | Max records to return

try {
    $result = $api_instance->findUsers($filter, $sort, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->findUsers: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
filter	string	A list of fields and values to filter by, in query string format eg. 'type=order&status=1'	[optional]
sort	string	A comma-separated list of fields to sort by	[optional]
offset	int	The start offset of the result set	[optional]
limit	int	Max records to return	[optional]

Return type

\Squiggle\Model\User[]

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

generateAddressAuthCode

generateAddressAuthCode($data)

Generates a one-time auth code for an address

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

try {
    $api_instance->generateAddressAuthCode($data);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->generateAddressAuthCode: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
data	\Squiggle\Model\AuthCodeRequest

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

generateAddressAuthCodeById

\Squiggle\Model\AuthCode generateAddressAuthCodeById($id)

Generates a one-time auth code for an address

Example

<?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();
$id = 789; // int | ID of address

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

Parameters

Name	Type	Description	Notes
id	int	ID of address

Return type

\Squiggle\Model\AuthCode

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAddress

\Squiggle\Model\Address getAddress($id)

Gets an address with the specified ID

Example

<?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();
$id = 789; // int | ID of address to get

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

Parameters

Name	Type	Description	Notes
id	int	ID of address to get

Return type

\Squiggle\Model\Address

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAddressToken

\Squiggle\Model\JSONWebToken getAddressToken($data)

Request JWT for Address

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

Parameters

Name	Type	Description	Notes
data	\Squiggle\Model\LoginDetails

Return type

\Squiggle\Model\JSONWebToken

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFile

\Squiggle\Model\FileObject getFile($id)

Gets a file with the specified ID

Example

<?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();
$id = 789; // int | ID of file to get

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

Parameters

Name	Type	Description	Notes
id	int	ID of file to get

Return type

\Squiggle\Model\FileObject

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGlobalTemplate

\Squiggle\Model\GlobalTemplate getGlobalTemplate($id)

Gets a global template with the specified ID

Example

<?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();
$id = 789; // int | ID of global template to get

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

Parameters

Name	Type	Description	Notes
id	int	ID of global template to get

Return type

\Squiggle\Model\GlobalTemplate

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getImage

\Squiggle\Model\ImageInfo getImage($id, $width, $height, $mode)

Gets an image, resizes if necessary and returns the resulting url and dimensions

Example

<?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();
$id = 789; // int | ID of file to get
$width = 56; // int | Image resize width
$height = 56; // int | Image resize height
$mode = "fit"; // string | Image resize mode ('fit', 'fill' or 'contain'). Default is 'fit'. Only relevant when width or height is specified

try {
    $result = $api_instance->getImage($id, $width, $height, $mode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getImage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	ID of file to get
width	int	Image resize width	[optional]
height	int	Image resize height	[optional]
mode	string	Image resize mode ('fit', 'fill' or 'contain'). Default is 'fit'. Only relevant when width or height is specified	[optional] [default to fit]

Return type

\Squiggle\Model\ImageInfo

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSignature

\Squiggle\Model\Signature getSignature($id)

Gets a signature with the specified ID

Example

<?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();
$id = 789; // int | ID of signature to get

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

Parameters

Name	Type	Description	Notes
id	int	ID of signature to get

Return type

\Squiggle\Model\Signature

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSnippet

\Squiggle\Model\Snippet getSnippet($id)

Gets a snippet with the specified ID

Example

<?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();
$id = 789; // int | ID of snippet to get

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

Parameters

Name	Type	Description	Notes
id	int	ID of snippet to get

Return type

\Squiggle\Model\Snippet

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTemplate

\Squiggle\Model\Template getTemplate($id)

Gets a template with the specified ID

Example

<?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();
$id = 789; // int | ID of template to get

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

Parameters

Name	Type	Description	Notes
id	int	ID of template to get

Return type

\Squiggle\Model\Template

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUser

\Squiggle\Model\User getUser($id)

Gets a user with the specified ID

Example

<?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();
$id = 789; // int | ID of user to get

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

Parameters

Name	Type	Description	Notes
id	int	ID of user to get

Return type

\Squiggle\Model\User

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUserToken

\Squiggle\Model\JSONWebToken getUserToken($data)

Request JWT for User

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

Parameters

Name	Type	Description	Notes
data	\Squiggle\Model\LoginDetails

Return type

\Squiggle\Model\JSONWebToken

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

render

string render($opts)

Renders a template

Example

<?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();
$opts = new \Squiggle\Model\RenderOptions(); // \Squiggle\Model\RenderOptions | 

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

Parameters

Name	Type	Description	Notes
opts	\Squiggle\Model\RenderOptions

Return type

string

Authorization

jwt

HTTP request headers

Content-Type: application/json
Accept: text/html, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

DefaultApi.md

Latest commit

History

DefaultApi.md

File metadata and controls

Squiggle\DefaultApi

addAddress

Example

Parameters

Return type

Authorization

HTTP request headers

addAddressBatch

Example

Parameters

Return type

Authorization

HTTP request headers

addClient

Example

Parameters

Return type

Authorization

HTTP request headers

addFile

Example

Parameters

Return type

Authorization

HTTP request headers

addGlobalTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

addSnippet

Example

Parameters

Return type

Authorization

HTTP request headers

addTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

addUser

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAddress

Example

Parameters

Return type

Authorization

HTTP request headers

deleteFile

Example

Parameters

Return type

Authorization

HTTP request headers

deleteGlobalTemplate

Example

Parameters

Return type

Authorization

HTTP request headers

deleteSnippet

Example

Parameters

Return type

Authorization

HTTP request headers

deleteTemplate