├── .swagger-codegen └── VERSION ├── .travis.yml ├── docs ├── Model │ ├── InlineResponse2011.md │ ├── InlineResponse201.md │ ├── RequiredAttachment.md │ ├── FileFromSf.md │ ├── InlineIntegrationData.md │ ├── DocumentTeam.md │ ├── InlineTeam.md │ ├── InlineDocumentSignerIntegrationData.md │ ├── InviteMember.md │ ├── User.md │ ├── SigningLog.md │ ├── DocumentSigningLog.md │ ├── InlineResponse2007.md │ ├── InlineResponse2004.md │ ├── InlineResponse200.md │ ├── InlineResponse2003.md │ ├── InlineResponse2008.md │ ├── InlineResponse2005.md │ ├── InlineResponse2006.md │ ├── InlineResponse2002.md │ ├── InlinePrefillTags.md │ ├── InlineResponse2001.md │ ├── InlineResponse2009.md │ ├── AuthToken.md │ ├── SignerAttachment.md │ ├── InlineTeamMember.md │ ├── SignerInputs.md │ ├── Placeholder.md │ ├── TeamMember.md │ ├── WebhookSubscription.md │ ├── Template.md │ ├── Team.md │ ├── Event.md │ ├── DocumentAttachment.md │ ├── DocumentSearch.md │ ├── DocumentSignerTemplateConf.md │ ├── InlineSignRequest.md │ ├── DocumentSignrequest.md │ ├── SignRequest.md │ ├── Signer.md │ ├── Document.md │ └── SignRequestQuickCreate.md └── Api │ ├── ApiTokensApi.md │ ├── SignrequestQuickCreateApi.md │ ├── TemplatesApi.md │ ├── TeamMembersApi.md │ └── DocumentsSearchApi.md ├── .php_cs ├── phpunit.xml.dist ├── composer.json ├── .swagger-codegen-ignore ├── LICENSE ├── git_push.sh ├── test ├── Api │ ├── ApiTokensApiTest.php │ ├── DocumentsSearchApiTest.php │ ├── SignrequestQuickCreateApiTest.php │ ├── EventsApiTest.php │ ├── TemplatesApiTest.php │ ├── TeamMembersApiTest.php │ ├── DocumentAttachmentsApiTest.php │ ├── DocumentsApiTest.php │ ├── SignrequestsApiTest.php │ ├── TeamsApiTest.php │ └── WebhooksApiTest.php └── Model │ ├── InlineResponse2011Test.php │ ├── SigningLogTest.php │ ├── RequiredAttachmentTest.php │ ├── InlineResponse201Test.php │ ├── DocumentSigningLogTest.php │ ├── InlineIntegrationDataTest.php │ ├── InlineTeamTest.php │ ├── DocumentTeamTest.php │ ├── FileFromSfTest.php │ ├── InviteMemberTest.php │ ├── InlineDocumentSignerIntegrationDataTest.php │ ├── UserTest.php │ ├── SignerAttachmentTest.php │ ├── InlineResponse200Test.php │ ├── InlineResponse2001Test.php │ ├── InlineResponse2002Test.php │ ├── InlineResponse2003Test.php │ ├── InlineResponse2004Test.php │ ├── InlineResponse2005Test.php │ ├── InlineResponse2006Test.php │ ├── InlineResponse2007Test.php │ ├── InlineResponse2008Test.php │ ├── InlineResponse2009Test.php │ ├── InlinePrefillTagsTest.php │ ├── AuthTokenTest.php │ ├── InlineTeamMemberTest.php │ ├── TemplateTest.php │ ├── TeamMemberTest.php │ ├── SignerInputsTest.php │ ├── DocumentSignerTemplateConfTest.php │ ├── PlaceholderTest.php │ ├── WebhookSubscriptionTest.php │ ├── DocumentAttachmentTest.php │ ├── TeamTest.php │ ├── EventTest.php │ ├── DocumentSearchTest.php │ ├── InlineSignRequestTest.php │ ├── DocumentSignrequestTest.php │ ├── SignRequestTest.php │ └── DocumentTest.php └── src ├── Model └── ModelInterface.php ├── HeaderSelector.php └── ApiException.php /.swagger-codegen/VERSION: -------------------------------------------------------------------------------- 1 | 2.4.11 -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: php 2 | sudo: false 3 | php: 4 | - 5.4 5 | - 5.5 6 | - 5.6 7 | - 7.0 8 | - hhvm 9 | before_install: "composer install" 10 | script: "vendor/bin/phpunit" 11 | -------------------------------------------------------------------------------- /docs/Model/InlineResponse2011.md: -------------------------------------------------------------------------------- 1 | # InlineResponse2011 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **detail** | **string** | | 7 | 8 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Model/InlineResponse201.md: -------------------------------------------------------------------------------- 1 | # InlineResponse201 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **detail** | **string** | | 7 | **cancelled** | **bool** | | 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Model/RequiredAttachment.md: -------------------------------------------------------------------------------- 1 | # RequiredAttachment 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **string** | | 7 | **uuid** | **string** | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Model/FileFromSf.md: -------------------------------------------------------------------------------- 1 | # FileFromSf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **object_type** | **string** | | 7 | **object_id** | **string** | | 8 | **uid** | **string** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Model/InlineIntegrationData.md: -------------------------------------------------------------------------------- 1 | # InlineIntegrationData 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **integration** | **string** | | [optional] 7 | **integration_data** | **object** | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Model/DocumentTeam.md: -------------------------------------------------------------------------------- 1 | # DocumentTeam 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **string** | | [optional] 7 | **subdomain** | **string** | | [optional] 8 | **url** | **string** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Model/InlineTeam.md: -------------------------------------------------------------------------------- 1 | # InlineTeam 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **string** | | [optional] 7 | **subdomain** | **string** | | [optional] 8 | **url** | **string** | | [optional] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Model/InlineDocumentSignerIntegrationData.md: -------------------------------------------------------------------------------- 1 | # InlineDocumentSignerIntegrationData 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **integration** | **string** | | [optional] 7 | **integration_data** | **object** | | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Model/InviteMember.md: -------------------------------------------------------------------------------- 1 | # InviteMember 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **string** | | 7 | **is_admin** | **bool** | | [optional] [default to false] 8 | **is_owner** | **bool** | | [optional] [default to false] 9 | 10 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Model/User.md: -------------------------------------------------------------------------------- 1 | # User 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **string** | | 7 | **first_name** | **string** | | [optional] 8 | **last_name** | **string** | | [optional] 9 | **display_name** | **string** | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Model/SigningLog.md: -------------------------------------------------------------------------------- 1 | # SigningLog 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **pdf** | **string** | Temporary URL to signing log, expires in five minutes | [optional] 7 | **security_hash** | **string** | SHA256 hash of PDF contents | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Model/DocumentSigningLog.md: -------------------------------------------------------------------------------- 1 | # DocumentSigningLog 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **pdf** | **string** | Temporary URL to signing log, expires in five minutes | [optional] 7 | **security_hash** | **string** | SHA256 hash of PDF contents | [optional] 8 | 9 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Model/InlineResponse2007.md: -------------------------------------------------------------------------------- 1 | # InlineResponse2007 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **int** | | 7 | **next** | **string** | | [optional] 8 | **previous** | **string** | | [optional] 9 | **results** | [**\SignRequest\Model\Team[]**](Team.md) | | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Model/InlineResponse2004.md: -------------------------------------------------------------------------------- 1 | # InlineResponse2004 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **int** | | 7 | **next** | **string** | | [optional] 8 | **previous** | **string** | | [optional] 9 | **results** | [**\SignRequest\Model\Event[]**](Event.md) | | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Model/InlineResponse200.md: -------------------------------------------------------------------------------- 1 | # InlineResponse200 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **int** | | 7 | **next** | **string** | | [optional] 8 | **previous** | **string** | | [optional] 9 | **results** | [**\SignRequest\Model\AuthToken[]**](AuthToken.md) | | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Model/InlineResponse2003.md: -------------------------------------------------------------------------------- 1 | # InlineResponse2003 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **int** | | 7 | **next** | **string** | | [optional] 8 | **previous** | **string** | | [optional] 9 | **results** | [**\SignRequest\Model\Document[]**](Document.md) | | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Model/InlineResponse2008.md: -------------------------------------------------------------------------------- 1 | # InlineResponse2008 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **int** | | 7 | **next** | **string** | | [optional] 8 | **previous** | **string** | | [optional] 9 | **results** | [**\SignRequest\Model\Template[]**](Template.md) | | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Model/InlineResponse2005.md: -------------------------------------------------------------------------------- 1 | # InlineResponse2005 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **int** | | 7 | **next** | **string** | | [optional] 8 | **previous** | **string** | | [optional] 9 | **results** | [**\SignRequest\Model\SignRequest[]**](SignRequest.md) | | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Model/InlineResponse2006.md: -------------------------------------------------------------------------------- 1 | # InlineResponse2006 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **int** | | 7 | **next** | **string** | | [optional] 8 | **previous** | **string** | | [optional] 9 | **results** | [**\SignRequest\Model\TeamMember[]**](TeamMember.md) | | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Model/InlineResponse2002.md: -------------------------------------------------------------------------------- 1 | # InlineResponse2002 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **int** | | 7 | **next** | **string** | | [optional] 8 | **previous** | **string** | | [optional] 9 | **results** | [**\SignRequest\Model\DocumentSearch[]**](DocumentSearch.md) | | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Model/InlinePrefillTags.md: -------------------------------------------------------------------------------- 1 | # InlinePrefillTags 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **external_id** | **string** | | [optional] 7 | **text** | **string** | | [optional] 8 | **checkbox_value** | **bool** | | [optional] 9 | **date_value** | [**\DateTime**](\DateTime.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Model/InlineResponse2001.md: -------------------------------------------------------------------------------- 1 | # InlineResponse2001 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **int** | | 7 | **next** | **string** | | [optional] 8 | **previous** | **string** | | [optional] 9 | **results** | [**\SignRequest\Model\DocumentAttachment[]**](DocumentAttachment.md) | | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Model/InlineResponse2009.md: -------------------------------------------------------------------------------- 1 | # InlineResponse2009 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **count** | **int** | | 7 | **next** | **string** | | [optional] 8 | **previous** | **string** | | [optional] 9 | **results** | [**\SignRequest\Model\WebhookSubscription[]**](WebhookSubscription.md) | | 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Model/AuthToken.md: -------------------------------------------------------------------------------- 1 | # AuthToken 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **email** | **string** | | [optional] 7 | **password** | **string** | | [optional] 8 | **subdomain** | **string** | | 9 | **name** | **string** | | [optional] 10 | **key** | **string** | | [optional] 11 | **url** | **string** | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/Model/SignerAttachment.md: -------------------------------------------------------------------------------- 1 | # SignerAttachment 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **uuid** | **string** | | [optional] 7 | **name** | **string** | Defaults to filename | [optional] 8 | **file** | **string** | | [optional] 9 | **for_attachment** | [**\SignRequest\Model\RequiredAttachment**](RequiredAttachment.md) | | [optional] 10 | 11 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Model/InlineTeamMember.md: -------------------------------------------------------------------------------- 1 | # InlineTeamMember 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **uuid** | **string** | | [optional] 7 | **url** | **string** | | [optional] 8 | **user** | [**\SignRequest\Model\User**](User.md) | | [optional] 9 | **is_admin** | **bool** | | [optional] 10 | **is_active** | **bool** | | [optional] 11 | **is_owner** | **bool** | | [optional] 12 | 13 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/Model/SignerInputs.md: -------------------------------------------------------------------------------- 1 | # SignerInputs 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **string** | | [optional] 7 | **page_index** | **int** | | 8 | **text** | **string** | | [optional] 9 | **checkbox_value** | **bool** | | [optional] 10 | **date_value** | [**\DateTime**](\DateTime.md) | | [optional] 11 | **external_id** | **string** | | [optional] 12 | **placeholder_uuid** | **string** | | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/Model/Placeholder.md: -------------------------------------------------------------------------------- 1 | # Placeholder 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **uuid** | **string** | | [optional] 7 | **type** | **string** | | [optional] 8 | **page_index** | **int** | | 9 | **prefill** | **bool** | | 10 | **text** | **string** | | [optional] 11 | **checkbox_value** | **bool** | | [optional] 12 | **date_value** | [**\DateTime**](\DateTime.md) | | [optional] 13 | **external_id** | **string** | | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/Model/TeamMember.md: -------------------------------------------------------------------------------- 1 | # TeamMember 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **uuid** | **string** | | [optional] 7 | **url** | **string** | | [optional] 8 | **user** | [**\SignRequest\Model\User**](User.md) | | [optional] 9 | **team** | [**\SignRequest\Model\DocumentTeam**](DocumentTeam.md) | | [optional] 10 | **is_admin** | **bool** | | [optional] 11 | **is_active** | **bool** | | [optional] 12 | **is_owner** | **bool** | | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /.php_cs: -------------------------------------------------------------------------------- 1 | setUsingCache(true) 5 | ->setRules([ 6 | '@PSR2' => true, 7 | 'ordered_imports' => true, 8 | 'phpdoc_order' => true, 9 | 'array_syntax' => [ 'syntax' => 'short' ], 10 | 'strict_comparison' => true, 11 | 'strict_param' => true, 12 | 'no_trailing_whitespace' => false, 13 | 'no_trailing_whitespace_in_comment' => false, 14 | 'braces' => false, 15 | 'single_blank_line_at_eof' => false, 16 | 'blank_line_after_namespace' => false, 17 | ]) 18 | ->setFinder( 19 | PhpCsFixer\Finder::create() 20 | ->exclude('test') 21 | ->exclude('tests') 22 | ->in(__DIR__) 23 | ); 24 | -------------------------------------------------------------------------------- /phpunit.xml.dist: -------------------------------------------------------------------------------- 1 | 2 | 8 | 9 | 10 | ./test/Api 11 | ./test/Model 12 | 13 | 14 | 15 | 16 | 17 | ./src/Api 18 | ./src/Model 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/Model/WebhookSubscription.md: -------------------------------------------------------------------------------- 1 | # WebhookSubscription 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **url** | **string** | | [optional] 7 | **uuid** | **string** | | [optional] 8 | **name** | **string** | Optional name to easily identify what webhook is used for | [optional] 9 | **event_type** | **string** | | 10 | **callback_url** | **string** | | 11 | **integration** | **string** | | [optional] 12 | **team** | [**\SignRequest\Model\DocumentTeam**](DocumentTeam.md) | | [optional] 13 | **created** | [**\DateTime**](\DateTime.md) | | [optional] 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/Model/Template.md: -------------------------------------------------------------------------------- 1 | # Template 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **url** | **string** | | [optional] 7 | **name** | **string** | Defaults to filename | [optional] 8 | **uuid** | **string** | | [optional] 9 | **user** | [**\SignRequest\Model\User**](User.md) | | [optional] 10 | **team** | [**\SignRequest\Model\DocumentTeam**](DocumentTeam.md) | | [optional] 11 | **who** | **string** | `m`: only me, `mo`: me and others, `o`: only others | [optional] 12 | **signers** | [**\SignRequest\Model\DocumentSignerTemplateConf[]**](DocumentSignerTemplateConf.md) | | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/Model/Team.md: -------------------------------------------------------------------------------- 1 | # Team 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **name** | **string** | | 7 | **subdomain** | **string** | | 8 | **url** | **string** | | [optional] 9 | **logo** | **string** | | [optional] 10 | **phone** | **string** | | [optional] 11 | **primary_color** | **string** | | [optional] 12 | **events_callback_url** | **string** | | [optional] 13 | **members** | [**\SignRequest\Model\InlineTeamMember[]**](InlineTeamMember.md) | | [optional] 14 | **delete_after** | [**\DateTime**](\DateTime.md) | When filled this team will be deleted after this date | [optional] 15 | **sandbox** | **bool** | Indicates whether team is in Sandbox mode | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/Model/Event.md: -------------------------------------------------------------------------------- 1 | # Event 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **uuid** | **string** | | [optional] 7 | **status** | **string** | | [optional] 8 | **event_type** | **string** | | [optional] 9 | **delivered** | **bool** | | [optional] 10 | **delivered_on** | [**\DateTime**](\DateTime.md) | | [optional] 11 | **callback_status_code** | **int** | | [optional] 12 | **timestamp** | [**\DateTime**](\DateTime.md) | | [optional] 13 | **team** | [**\SignRequest\Model\DocumentTeam**](DocumentTeam.md) | | [optional] 14 | **document** | [**\SignRequest\Model\Document**](Document.md) | | [optional] 15 | **signer** | [**\SignRequest\Model\Signer**](Signer.md) | | [optional] 16 | 17 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/Model/DocumentAttachment.md: -------------------------------------------------------------------------------- 1 | # DocumentAttachment 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **url** | **string** | | [optional] 7 | **uuid** | **string** | | [optional] 8 | **name** | **string** | Defaults to filename, including extension | [optional] 9 | **file** | **string** | Temporary URL to document attachment, expires in five minutes | [optional] 10 | **file_from_content** | **string** | Base64 encoded document content | [optional] 11 | **file_from_content_name** | **string** | Filename, including extension. Required when using `file_from_content`. | [optional] 12 | **file_from_url** | **string** | Publicly accessible URL of document to be downloaded by SignRequest | [optional] 13 | **document** | **string** | | 14 | 15 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "signrequest/signrequest-client", 3 | "version": "1.3.0", 4 | "description": "Official PHP client for SignRequest.com (https://signrequest.com)", 5 | "keywords": [ 6 | "signrequest", 7 | "php", 8 | "sdk", 9 | "api" 10 | ], 11 | "homepage": "https://signrequest.com/", 12 | "license": "MIT", 13 | "authors": [ 14 | { 15 | "name": "SignRequest", 16 | "homepage": "https://signrequest.com/" 17 | } 18 | ], 19 | "require": { 20 | "php": ">=5.5", 21 | "ext-curl": "*", 22 | "ext-json": "*", 23 | "ext-mbstring": "*", 24 | "guzzlehttp/guzzle": "^6.2" 25 | }, 26 | "require-dev": { 27 | "phpunit/phpunit": "^4.8", 28 | "squizlabs/php_codesniffer": "~2.6", 29 | "friendsofphp/php-cs-fixer": "~2.12" 30 | }, 31 | "autoload": { 32 | "psr-4": { "SignRequest\\" : "src/" } 33 | }, 34 | "autoload-dev": { 35 | "psr-4": { "SignRequest\\" : "test/" } 36 | } 37 | } -------------------------------------------------------------------------------- /.swagger-codegen-ignore: -------------------------------------------------------------------------------- 1 | # Swagger Codegen Ignore 2 | # Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen 3 | 4 | # Use this file to prevent files from being overwritten by the generator. 5 | # The patterns follow closely to .gitignore or .dockerignore. 6 | 7 | # As an example, the C# client generator defines ApiClient.cs. 8 | # You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line: 9 | #ApiClient.cs 10 | 11 | # You can match any string of characters against a directory, file or extension with a single asterisk (*): 12 | #foo/*/qux 13 | # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux 14 | 15 | # You can recursively match patterns against a directory, file or extension with a double asterisk (**): 16 | #foo/**/qux 17 | # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux 18 | 19 | # You can also negate patterns with an exclamation (!). 20 | # For example, you can ignore all files in a docs folder with the file extension .md: 21 | #docs/*.md 22 | # Then explicitly reverse the ignore rule for a single file: 23 | #!docs/README.md 24 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2015 SignRequest 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | 23 | -------------------------------------------------------------------------------- /docs/Model/DocumentSearch.md: -------------------------------------------------------------------------------- 1 | # DocumentSearch 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **uuid** | **string** | | [optional] 7 | **created** | [**\DateTime**](\DateTime.md) | | [optional] 8 | **status** | **string** | `co`: converting, `ne`: new, `se`: sent, `vi`: viewed, `si`: signed, `do`: downloaded, `sd`: signed and downloaded, `ca`: cancelled, `de`: declined, `ec`: error converting, `es`: error sending, `xp`: expired | [optional] 9 | **who** | **string** | | 10 | **name** | **string** | Defaults to filename | [optional] 11 | **autocomplete** | **string** | | 12 | **from_email** | **string** | | 13 | **nr_extra_docs** | **int** | | 14 | **signer_emails** | **string[]** | | [optional] 15 | **status_display** | **string** | | [optional] 16 | **created_timestamp** | **int** | | [optional] 17 | **finished_on_timestamp** | **int** | | [optional] 18 | **parent_doc** | **string** | | [optional] 19 | **finished_on** | [**\DateTime**](\DateTime.md) | | [optional] 20 | **subdomain** | **string** | | [optional] 21 | 22 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/Model/DocumentSignerTemplateConf.md: -------------------------------------------------------------------------------- 1 | # DocumentSignerTemplateConf 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **signer_index** | **int** | | [optional] 7 | **needs_to_sign** | **bool** | When `false` user does not need to sign, but will receive a copy of the signed document and signing log, see: [Copy only](#section/Additional-signing-methods/Copy-only) | [optional] 8 | **approve_only** | **bool** | Require user to approve the document (without adding a signature), see: [Approve only](#section/Additional-signing-methods/Approve-only) | [optional] 9 | **notify_only** | **bool** | Send notifications about the document and a copy of the signed document and signing log, but don't require them to take any action, see: [Notify only](#section/Additional-signing-methods/Notify-only) | [optional] 10 | **in_person** | **bool** | When used in combination with an embed url on the sender, after sender has signed, they will be redirected to the next `in_person` signer, see: [In person signing](#section/Additional-signing-methods/In-person-signing) | [optional] 11 | **order** | **int** | | [optional] 12 | **placeholders** | [**\SignRequest\Model\Placeholder[]**](Placeholder.md) | | [optional] 13 | 14 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /git_push.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ 3 | # 4 | # Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update" 5 | 6 | git_user_id=$1 7 | git_repo_id=$2 8 | release_note=$3 9 | 10 | if [ "$git_user_id" = "" ]; then 11 | git_user_id="SignRequest" 12 | echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" 13 | fi 14 | 15 | if [ "$git_repo_id" = "" ]; then 16 | git_repo_id="signrequest-php-client" 17 | echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" 18 | fi 19 | 20 | if [ "$release_note" = "" ]; then 21 | release_note="Minor update" 22 | echo "[INFO] No command line input provided. Set \$release_note to $release_note" 23 | fi 24 | 25 | # Initialize the local directory as a Git repository 26 | git init 27 | 28 | # Adds the files in the local repository and stages them for commit. 29 | git add . 30 | 31 | # Commits the tracked changes and prepares them to be pushed to a remote repository. 32 | git commit -m "$release_note" 33 | 34 | # Sets the new remote 35 | git_remote=`git remote` 36 | if [ "$git_remote" = "" ]; then # git remote not defined 37 | 38 | if [ "$GIT_TOKEN" = "" ]; then 39 | echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." 40 | git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git 41 | else 42 | git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git 43 | fi 44 | 45 | fi 46 | 47 | git pull origin master 48 | 49 | # Pushes (Forces) the changes in the local repository up to the remote repository 50 | echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git" 51 | git push origin master 2>&1 | grep -v 'To https' 52 | 53 | -------------------------------------------------------------------------------- /test/Api/ApiTokensApiTest.php: -------------------------------------------------------------------------------- 1 | \SignRequest\Model\InlineResponse200 apiTokensList($page, $limit) 12 | 13 | Retrieve a list of API tokens 14 | 15 | 16 | 17 | ### Example 18 | ```php 19 | setApiKey('Authorization', 'YOUR_API_KEY'); 24 | $config = SignRequest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Token'); 25 | 26 | $apiInstance = new SignRequest\Api\ApiTokensApi( 27 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 28 | // This is optional, `GuzzleHttp\Client` will be used as default. 29 | new GuzzleHttp\Client(), 30 | $config 31 | ); 32 | $page = 56; // int | A page number within the paginated result set. 33 | $limit = 56; // int | Number of results to return per page. 34 | 35 | try { 36 | $result = $apiInstance->apiTokensList($page, $limit); 37 | print_r($result); 38 | } catch (Exception $e) { 39 | echo 'Exception when calling ApiTokensApi->apiTokensList: ', $e->getMessage(), PHP_EOL; 40 | } 41 | ?> 42 | ``` 43 | 44 | ### Parameters 45 | 46 | Name | Type | Description | Notes 47 | ------------- | ------------- | ------------- | ------------- 48 | **page** | **int**| A page number within the paginated result set. | [optional] 49 | **limit** | **int**| Number of results to return per page. | [optional] 50 | 51 | ### Return type 52 | 53 | [**\SignRequest\Model\InlineResponse200**](../Model/InlineResponse200.md) 54 | 55 | ### Authorization 56 | 57 | [Token](../../README.md#Token) 58 | 59 | ### HTTP request headers 60 | 61 | - **Content-Type**: application/json 62 | - **Accept**: application/json 63 | 64 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) 65 | 66 | -------------------------------------------------------------------------------- /docs/Api/SignrequestQuickCreateApi.md: -------------------------------------------------------------------------------- 1 | # SignRequest\SignrequestQuickCreateApi 2 | 3 | All URIs are relative to *https://signrequest.com/api/v1* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**signrequestQuickCreateCreate**](SignrequestQuickCreateApi.md#signrequestQuickCreateCreate) | **POST** /signrequest-quick-create/ | Quick create a SignRequest 8 | 9 | 10 | # **signrequestQuickCreateCreate** 11 | > \SignRequest\Model\SignRequestQuickCreate signrequestQuickCreateCreate($data) 12 | 13 | Quick create a SignRequest 14 | 15 | 16 | 17 | ### Example 18 | ```php 19 | setApiKey('Authorization', 'YOUR_API_KEY'); 24 | $config = SignRequest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Token'); 25 | 26 | $apiInstance = new SignRequest\Api\SignrequestQuickCreateApi( 27 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 28 | // This is optional, `GuzzleHttp\Client` will be used as default. 29 | new GuzzleHttp\Client(), 30 | $config 31 | ); 32 | $data = new \SignRequest\Model\SignRequestQuickCreate(); // \SignRequest\Model\SignRequestQuickCreate | 33 | 34 | try { 35 | $result = $apiInstance->signrequestQuickCreateCreate($data); 36 | print_r($result); 37 | } catch (Exception $e) { 38 | echo 'Exception when calling SignrequestQuickCreateApi->signrequestQuickCreateCreate: ', $e->getMessage(), PHP_EOL; 39 | } 40 | ?> 41 | ``` 42 | 43 | ### Parameters 44 | 45 | Name | Type | Description | Notes 46 | ------------- | ------------- | ------------- | ------------- 47 | **data** | [**\SignRequest\Model\SignRequestQuickCreate**](../Model/SignRequestQuickCreate.md)| | 48 | 49 | ### Return type 50 | 51 | [**\SignRequest\Model\SignRequestQuickCreate**](../Model/SignRequestQuickCreate.md) 52 | 53 | ### Authorization 54 | 55 | [Token](../../README.md#Token) 56 | 57 | ### HTTP request headers 58 | 59 | - **Content-Type**: application/json 60 | - **Accept**: application/json 61 | 62 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) 63 | 64 | -------------------------------------------------------------------------------- /test/Model/UserTest.php: -------------------------------------------------------------------------------- 1 | selectAcceptHeader($accept); 52 | if ($accept !== null) { 53 | $headers['Accept'] = $accept; 54 | } 55 | 56 | $headers['Content-Type'] = $this->selectContentTypeHeader($contentTypes); 57 | return $headers; 58 | } 59 | 60 | /** 61 | * @param string[] $accept 62 | * @return array 63 | */ 64 | public function selectHeadersForMultipart($accept) 65 | { 66 | $headers = $this->selectHeaders($accept, []); 67 | 68 | unset($headers['Content-Type']); 69 | return $headers; 70 | } 71 | 72 | /** 73 | * Return the header 'Accept' based on an array of Accept provided 74 | * 75 | * @param string[] $accept Array of header 76 | * 77 | * @return string Accept (e.g. application/json) 78 | */ 79 | private function selectAcceptHeader($accept) 80 | { 81 | if (count($accept) === 0 || (count($accept) === 1 && $accept[0] === '')) { 82 | return null; 83 | } elseif (preg_grep("/application\/json/i", $accept)) { 84 | return 'application/json'; 85 | } else { 86 | return implode(',', $accept); 87 | } 88 | } 89 | 90 | /** 91 | * Return the content type based on an array of content-type provided 92 | * 93 | * @param string[] $contentType Array fo content-type 94 | * 95 | * @return string Content-Type (e.g. application/json) 96 | */ 97 | private function selectContentTypeHeader($contentType) 98 | { 99 | if (count($contentType) === 0 || (count($contentType) === 1 && $contentType[0] === '')) { 100 | return 'application/json'; 101 | } elseif (preg_grep("/application\/json/i", $contentType)) { 102 | return 'application/json'; 103 | } else { 104 | return implode(',', $contentType); 105 | } 106 | } 107 | } 108 | -------------------------------------------------------------------------------- /test/Model/TeamTest.php: -------------------------------------------------------------------------------- 1 | responseHeaders = $responseHeaders; 75 | $this->responseBody = $responseBody; 76 | } 77 | 78 | /** 79 | * Gets the HTTP response header 80 | * 81 | * @return string[]|null HTTP response header 82 | */ 83 | public function getResponseHeaders() 84 | { 85 | return $this->responseHeaders; 86 | } 87 | 88 | /** 89 | * Gets the HTTP body of the server response either as Json or string 90 | * 91 | * @return mixed HTTP body of the server response either as \stdClass or string 92 | */ 93 | public function getResponseBody() 94 | { 95 | return $this->responseBody; 96 | } 97 | 98 | /** 99 | * Sets the deseralized response object (during deserialization) 100 | * 101 | * @param mixed $obj Deserialized response object 102 | * 103 | * @return void 104 | */ 105 | public function setResponseObject($obj) 106 | { 107 | $this->responseObject = $obj; 108 | } 109 | 110 | /** 111 | * Gets the deseralized response object (during deserialization) 112 | * 113 | * @return mixed the deserialized response object 114 | */ 115 | public function getResponseObject() 116 | { 117 | return $this->responseObject; 118 | } 119 | } 120 | -------------------------------------------------------------------------------- /test/Model/DocumentSearchTest.php: -------------------------------------------------------------------------------- 1 | \SignRequest\Model\InlineResponse2008 templatesList($page, $limit) 13 | 14 | Retrieve a list of Templates 15 | 16 | 17 | 18 | ### Example 19 | ```php 20 | setApiKey('Authorization', 'YOUR_API_KEY'); 25 | $config = SignRequest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Token'); 26 | 27 | $apiInstance = new SignRequest\Api\TemplatesApi( 28 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 29 | // This is optional, `GuzzleHttp\Client` will be used as default. 30 | new GuzzleHttp\Client(), 31 | $config 32 | ); 33 | $page = 56; // int | A page number within the paginated result set. 34 | $limit = 56; // int | Number of results to return per page. 35 | 36 | try { 37 | $result = $apiInstance->templatesList($page, $limit); 38 | print_r($result); 39 | } catch (Exception $e) { 40 | echo 'Exception when calling TemplatesApi->templatesList: ', $e->getMessage(), PHP_EOL; 41 | } 42 | ?> 43 | ``` 44 | 45 | ### Parameters 46 | 47 | Name | Type | Description | Notes 48 | ------------- | ------------- | ------------- | ------------- 49 | **page** | **int**| A page number within the paginated result set. | [optional] 50 | **limit** | **int**| Number of results to return per page. | [optional] 51 | 52 | ### Return type 53 | 54 | [**\SignRequest\Model\InlineResponse2008**](../Model/InlineResponse2008.md) 55 | 56 | ### Authorization 57 | 58 | [Token](../../README.md#Token) 59 | 60 | ### HTTP request headers 61 | 62 | - **Content-Type**: application/json 63 | - **Accept**: application/json 64 | 65 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) 66 | 67 | # **templatesRead** 68 | > \SignRequest\Model\Template templatesRead($uuid) 69 | 70 | Retrieve a Template 71 | 72 | 73 | 74 | ### Example 75 | ```php 76 | setApiKey('Authorization', 'YOUR_API_KEY'); 81 | $config = SignRequest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Token'); 82 | 83 | $apiInstance = new SignRequest\Api\TemplatesApi( 84 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 85 | // This is optional, `GuzzleHttp\Client` will be used as default. 86 | new GuzzleHttp\Client(), 87 | $config 88 | ); 89 | $uuid = "uuid_example"; // string | 90 | 91 | try { 92 | $result = $apiInstance->templatesRead($uuid); 93 | print_r($result); 94 | } catch (Exception $e) { 95 | echo 'Exception when calling TemplatesApi->templatesRead: ', $e->getMessage(), PHP_EOL; 96 | } 97 | ?> 98 | ``` 99 | 100 | ### Parameters 101 | 102 | Name | Type | Description | Notes 103 | ------------- | ------------- | ------------- | ------------- 104 | **uuid** | **string**| | 105 | 106 | ### Return type 107 | 108 | [**\SignRequest\Model\Template**](../Model/Template.md) 109 | 110 | ### Authorization 111 | 112 | [Token](../../README.md#Token) 113 | 114 | ### HTTP request headers 115 | 116 | - **Content-Type**: application/json 117 | - **Accept**: application/json 118 | 119 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) 120 | 121 | -------------------------------------------------------------------------------- /docs/Model/SignRequestQuickCreate.md: -------------------------------------------------------------------------------- 1 | # SignRequestQuickCreate 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **from_email** | **string** | Email of user sending the SignRequest (must be a validated email) | [optional] 7 | **from_email_name** | **string** | Name to be used in the `From` email header, e.g. `{from_email_name} <no-reply@signrequest.com>` | [optional] 8 | **is_being_prepared** | **bool** | Have the sender of a SignRequest prepare the document before sending the request out, see: [prepare using the web interface](#section/Preparing-a-document/Prepare-using-the-web-interface) | [optional] 9 | **prepare_url** | **string** | | [optional] 10 | **redirect_url** | **string** | URL at which SignRequest will redirect to when a document is signed | [optional] 11 | **redirect_url_declined** | **string** | URL at which SignRequest will redirect to when a document is declined | [optional] 12 | **required_attachments** | [**\SignRequest\Model\RequiredAttachment[]**](RequiredAttachment.md) | Attachments that signers are required to upload | [optional] 13 | **disable_attachments** | **bool** | Disable uploading/adding of attachments | [optional] 14 | **disable_text_signatures** | **bool** | Disable usage of signatures generated by typing (text) | [optional] 15 | **disable_text** | **bool** | Disable adding of text | [optional] 16 | **disable_date** | **bool** | Disable adding of dates | [optional] 17 | **disable_emails** | **bool** | Disable all SignRequest status emails as well as the email that contains the signed documents | [optional] 18 | **disable_upload_signatures** | **bool** | Disable usage of uploaded signatures (images) | [optional] 19 | **disable_blockchain_proof** | **bool** | Disables storing timestamp proof hashes in blockchain integrations. | [optional] 20 | **text_message_verification_locked** | **bool** | When true a text message verification is needed before the signer can see the document | [optional] 21 | **subject** | **string** | Subject of SignRequest email | [optional] 22 | **message** | **string** | Message to include in SignRequest email, may contain the following html tags: `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong` | [optional] 23 | **who** | **string** | `m`: only me, `mo`: me and others, `o`: only others | [optional] [default to 'o'] 24 | **send_reminders** | **bool** | Automatically remind signers to sign a document, see: [automatic reminders](#section/Working-with-a-SignRequest/Automatic-reminders) | [optional] 25 | **signers** | [**\SignRequest\Model\Signer[]**](Signer.md) | | 26 | **uuid** | **string** | | [optional] 27 | **url** | **string** | | [optional] 28 | **document** | **string** | | [optional] 29 | **integration** | **string** | | [optional] 30 | **integration_data** | **object** | | [optional] 31 | **name** | **string** | Defaults to filename, including extension | [optional] 32 | **external_id** | **string** | ID used to reference document in external system | [optional] 33 | **frontend_id** | **string** | Shared secret used in conjunction with <a href=\"#section/Frontend-API/SignRequest-js-client-(beta)\">SignRequest-js client</a> to grant user access to a document that's not a member of the document's team | [optional] 34 | **file** | **string** | Temporary URL to original file, expires in five minutes | [optional] 35 | **file_from_url** | **string** | Publicly accessible URL of document to be downloaded by SignRequest | [optional] 36 | **events_callback_url** | **string** | URL at which to receive [event callbacks](#section/Events/Events-callback) for this document | [optional] 37 | **file_from_content** | **string** | Base64 encoded document content | [optional] 38 | **file_from_content_name** | **string** | Filename, including extension. Required when using `file_from_content`. | [optional] 39 | **template** | **string** | | [optional] 40 | **prefill_tags** | [**\SignRequest\Model\InlinePrefillTags[]**](InlinePrefillTags.md) | Prefill signer input data, see [prefill tags](#section/Preparing-a-document/Prefill-tags-templates) | [optional] 41 | **integrations** | [**\SignRequest\Model\InlineIntegrationData[]**](InlineIntegrationData.md) | | [optional] 42 | **file_from_sf** | [**\SignRequest\Model\FileFromSf**](FileFromSf.md) | | [optional] 43 | **auto_delete_days** | **int** | Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted | [optional] 44 | **auto_expire_days** | **int** | Number of days after which a non finished document will be automatically expired | [optional] 45 | 46 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) 47 | 48 | 49 | -------------------------------------------------------------------------------- /docs/Api/TeamMembersApi.md: -------------------------------------------------------------------------------- 1 | # SignRequest\TeamMembersApi 2 | 3 | All URIs are relative to *https://signrequest.com/api/v1* 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**teamMembersList**](TeamMembersApi.md#teamMembersList) | **GET** /team-members/ | Retrieve a list of Team Members 8 | [**teamMembersRead**](TeamMembersApi.md#teamMembersRead) | **GET** /team-members/{uuid}/ | Retrieve a Team Member 9 | 10 | 11 | # **teamMembersList** 12 | > \SignRequest\Model\InlineResponse2006 teamMembersList($is_active, $is_owner, $is_admin, $user__email, $user__first_name, $user__last_name, $page, $limit) 13 | 14 | Retrieve a list of Team Members 15 | 16 | 17 | 18 | ### Example 19 | ```php 20 | setApiKey('Authorization', 'YOUR_API_KEY'); 25 | $config = SignRequest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Token'); 26 | 27 | $apiInstance = new SignRequest\Api\TeamMembersApi( 28 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 29 | // This is optional, `GuzzleHttp\Client` will be used as default. 30 | new GuzzleHttp\Client(), 31 | $config 32 | ); 33 | $is_active = "is_active_example"; // string | 34 | $is_owner = "is_owner_example"; // string | 35 | $is_admin = "is_admin_example"; // string | 36 | $user__email = "user__email_example"; // string | 37 | $user__first_name = "user__first_name_example"; // string | 38 | $user__last_name = "user__last_name_example"; // string | 39 | $page = 56; // int | A page number within the paginated result set. 40 | $limit = 56; // int | Number of results to return per page. 41 | 42 | try { 43 | $result = $apiInstance->teamMembersList($is_active, $is_owner, $is_admin, $user__email, $user__first_name, $user__last_name, $page, $limit); 44 | print_r($result); 45 | } catch (Exception $e) { 46 | echo 'Exception when calling TeamMembersApi->teamMembersList: ', $e->getMessage(), PHP_EOL; 47 | } 48 | ?> 49 | ``` 50 | 51 | ### Parameters 52 | 53 | Name | Type | Description | Notes 54 | ------------- | ------------- | ------------- | ------------- 55 | **is_active** | **string**| | [optional] 56 | **is_owner** | **string**| | [optional] 57 | **is_admin** | **string**| | [optional] 58 | **user__email** | **string**| | [optional] 59 | **user__first_name** | **string**| | [optional] 60 | **user__last_name** | **string**| | [optional] 61 | **page** | **int**| A page number within the paginated result set. | [optional] 62 | **limit** | **int**| Number of results to return per page. | [optional] 63 | 64 | ### Return type 65 | 66 | [**\SignRequest\Model\InlineResponse2006**](../Model/InlineResponse2006.md) 67 | 68 | ### Authorization 69 | 70 | [Token](../../README.md#Token) 71 | 72 | ### HTTP request headers 73 | 74 | - **Content-Type**: application/json 75 | - **Accept**: application/json 76 | 77 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) 78 | 79 | # **teamMembersRead** 80 | > \SignRequest\Model\TeamMember teamMembersRead($uuid) 81 | 82 | Retrieve a Team Member 83 | 84 | 85 | 86 | ### Example 87 | ```php 88 | setApiKey('Authorization', 'YOUR_API_KEY'); 93 | $config = SignRequest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Token'); 94 | 95 | $apiInstance = new SignRequest\Api\TeamMembersApi( 96 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 97 | // This is optional, `GuzzleHttp\Client` will be used as default. 98 | new GuzzleHttp\Client(), 99 | $config 100 | ); 101 | $uuid = "uuid_example"; // string | 102 | 103 | try { 104 | $result = $apiInstance->teamMembersRead($uuid); 105 | print_r($result); 106 | } catch (Exception $e) { 107 | echo 'Exception when calling TeamMembersApi->teamMembersRead: ', $e->getMessage(), PHP_EOL; 108 | } 109 | ?> 110 | ``` 111 | 112 | ### Parameters 113 | 114 | Name | Type | Description | Notes 115 | ------------- | ------------- | ------------- | ------------- 116 | **uuid** | **string**| | 117 | 118 | ### Return type 119 | 120 | [**\SignRequest\Model\TeamMember**](../Model/TeamMember.md) 121 | 122 | ### Authorization 123 | 124 | [Token](../../README.md#Token) 125 | 126 | ### HTTP request headers 127 | 128 | - **Content-Type**: application/json 129 | - **Accept**: application/json 130 | 131 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) 132 | 133 | -------------------------------------------------------------------------------- /test/Model/InlineSignRequestTest.php: -------------------------------------------------------------------------------- 1 | \SignRequest\Model\InlineResponse2002 documentsSearchList($page, $limit, $q, $autocomplete, $name, $subdomain, $signer_emails, $status, $who, $format, $signer_data) 12 | 13 | Search documents 14 | 15 | Search interface for fast (autocomplete) searching of documents. This can be useful to have your users search for a document in your interface. Document names are tokenized on whitespace, hyphens and underscores to also match partial document names. *Normal search:* - ?**q**={{query}} *Autocomplete search:* - ?**autocomplete**={{partial query}} *Search in document name:* - ?**name**={{query}} *Available (extra) filters:* - ?**subdomain**={{ team_subdomain }} or use this endpoint with team_subdomain.signrequest.com (when not provided only personal documents are shown) - ?**signer_emails**={{ signer@email.com }} (will filter documents that an email needed to sign/approve) - ?**status**={{ si }} - ?**who**={{ mo }} To include multiple values for a filter field separate the values with a pipe (|). For example to only search for completed documents use **status=se|vi** (sent and viewed). *Pagination:* - ?**page**={{ page_number: default 1 }} - ?**limit**={{ limit results: default 10, max 100 }} *Format:* By default json is returned, to export data as csv or xls use the format parameter. - ?**format**=csv - ?**format**=xls For csv and xls the data can also be exported with each signer on a separate row. In this mode also the signer inputs that have an *external_id* specified on a tag will be exported. All external_id's found will be exported as columns. To use this mode add the **signer_data** parameter. - ?**format**=csv&**signer_data**=1 - ?**format**=xls&**signer_data**=1 Note that all documents are only ordered by **created** (newest first) when **q**, **autocomplete** or **name** are not used, else they are ordered by the strenght of the match. 16 | 17 | ### Example 18 | ```php 19 | setApiKey('Authorization', 'YOUR_API_KEY'); 24 | $config = SignRequest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Token'); 25 | 26 | $apiInstance = new SignRequest\Api\DocumentsSearchApi( 27 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 28 | // This is optional, `GuzzleHttp\Client` will be used as default. 29 | new GuzzleHttp\Client(), 30 | $config 31 | ); 32 | $page = 56; // int | A page number within the paginated result set. 33 | $limit = 56; // int | Number of results to return per page. 34 | $q = "q_example"; // string | Normal search query 35 | $autocomplete = "autocomplete_example"; // string | Partial search query 36 | $name = "name_example"; // string | Document name 37 | $subdomain = "subdomain_example"; // string | 38 | $signer_emails = "signer_emails_example"; // string | Email needed to sign/approve 39 | $status = "status_example"; // string | `co`: converting, `ne`: new, `se`: sent, `vi`: viewed, `si`: signed, `do`: downloaded, `sd`: signed and downloaded, `ca`: cancelled, `de`: declined, `ec`: error converting, `es`: error sending, `xp`: expired 40 | $who = "who_example"; // string | `m`: only me, `mo`: me and others, `o`: only others 41 | $format = "format_example"; // string | Export format, can be `json` (default), `csv`, or `xls` 42 | $signer_data = 8.14; // float | Set to `1` to export with each signer on a separate row 43 | 44 | try { 45 | $result = $apiInstance->documentsSearchList($page, $limit, $q, $autocomplete, $name, $subdomain, $signer_emails, $status, $who, $format, $signer_data); 46 | print_r($result); 47 | } catch (Exception $e) { 48 | echo 'Exception when calling DocumentsSearchApi->documentsSearchList: ', $e->getMessage(), PHP_EOL; 49 | } 50 | ?> 51 | ``` 52 | 53 | ### Parameters 54 | 55 | Name | Type | Description | Notes 56 | ------------- | ------------- | ------------- | ------------- 57 | **page** | **int**| A page number within the paginated result set. | [optional] 58 | **limit** | **int**| Number of results to return per page. | [optional] 59 | **q** | **string**| Normal search query | [optional] 60 | **autocomplete** | **string**| Partial search query | [optional] 61 | **name** | **string**| Document name | [optional] 62 | **subdomain** | **string**| | [optional] 63 | **signer_emails** | **string**| Email needed to sign/approve | [optional] 64 | **status** | **string**| `co`: converting, `ne`: new, `se`: sent, `vi`: viewed, `si`: signed, `do`: downloaded, `sd`: signed and downloaded, `ca`: cancelled, `de`: declined, `ec`: error converting, `es`: error sending, `xp`: expired | [optional] 65 | **who** | **string**| `m`: only me, `mo`: me and others, `o`: only others | [optional] 66 | **format** | **string**| Export format, can be `json` (default), `csv`, or `xls` | [optional] 67 | **signer_data** | **float**| Set to `1` to export with each signer on a separate row | [optional] 68 | 69 | ### Return type 70 | 71 | [**\SignRequest\Model\InlineResponse2002**](../Model/InlineResponse2002.md) 72 | 73 | ### Authorization 74 | 75 | [Token](../../README.md#Token) 76 | 77 | ### HTTP request headers 78 | 79 | - **Content-Type**: application/json 80 | - **Accept**: application/json, text/csv, application/vnd.ms-excel 81 | 82 | [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) 83 | 84 | -------------------------------------------------------------------------------- /test/Model/DocumentTest.php: -------------------------------------------------------------------------------- 1 |