Skip to content

Latest commit

 

History

History
343 lines (243 loc) · 13 KB

TeamsApi.md

File metadata and controls

343 lines (243 loc) · 13 KB
Raw

SignRequest\TeamsApi

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

Method HTTP request Description
teamsCreate POST /teams/ Create a Team
teamsDelete DELETE /teams/{subdomain}/ Delete a Team
teamsInviteMember POST /teams/{subdomain}/invite_member/ Invite a Team Member
teamsList GET /teams/ Retrieve a list of Teams
teamsPartialUpdate PATCH /teams/{subdomain}/ Update a Team
teamsRead GET /teams/{subdomain}/ Retrieve a Team

teamsCreate

\SignRequest\Model\Team teamsCreate($data)

Create a Team

Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://_{{ subdomain }}.signrequest.com/api/v1/... To invite new team members you can use POST {"email":"[email protected]","is_admin":false,"is_owner":false} to: https://signrequest.com/api/v1/teams/_**{{ subdomain }}**/invite_member/

Example

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

// Configure API key authorization: Token
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new SignRequest\Api\TeamsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$data = new \SignRequest\Model\Team(); // \SignRequest\Model\Team | 

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

Parameters

Name Type Description Notes
data \SignRequest\Model\Team

Return type

\SignRequest\Model\Team

Authorization

Token

HTTP request headers

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

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

teamsDelete

teamsDelete($subdomain)

Delete a Team

Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://_{{ subdomain }}.signrequest.com/api/v1/... To invite new team members you can use POST {"email":"[email protected]","is_admin":false,"is_owner":false} to: https://signrequest.com/api/v1/teams/_**{{ subdomain }}**/invite_member/

Example

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

// Configure API key authorization: Token
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new SignRequest\Api\TeamsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subdomain = "subdomain_example"; // string | 

try {
    $apiInstance->teamsDelete($subdomain);
} catch (Exception $e) {
    echo 'Exception when calling TeamsApi->teamsDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
subdomain string

Return type

void (empty response body)

Authorization

Token

HTTP request headers

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

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

teamsInviteMember

\SignRequest\Model\InviteMember teamsInviteMember($subdomain, $data)

Invite a Team Member

Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://_{{ subdomain }}.signrequest.com/api/v1/... To invite new team members you can use POST {"email":"[email protected]","is_admin":false,"is_owner":false} to: https://signrequest.com/api/v1/teams/_**{{ subdomain }}**/invite_member/

Example

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

// Configure API key authorization: Token
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new SignRequest\Api\TeamsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subdomain = "subdomain_example"; // string | 
$data = new \SignRequest\Model\InviteMember(); // \SignRequest\Model\InviteMember | 

try {
    $result = $apiInstance->teamsInviteMember($subdomain, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamsApi->teamsInviteMember: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
subdomain string
data \SignRequest\Model\InviteMember

Return type

\SignRequest\Model\InviteMember

Authorization

Token

HTTP request headers

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

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

teamsList

\SignRequest\Model\InlineResponse2007 teamsList($page, $limit)

Retrieve a list of Teams

Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://_{{ subdomain }}.signrequest.com/api/v1/... To invite new team members you can use POST {"email":"[email protected]","is_admin":false,"is_owner":false} to: https://signrequest.com/api/v1/teams/_**{{ subdomain }}**/invite_member/

Example

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

// Configure API key authorization: Token
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new SignRequest\Api\TeamsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page = 56; // int | A page number within the paginated result set.
$limit = 56; // int | Number of results to return per page.

try {
    $result = $apiInstance->teamsList($page, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamsApi->teamsList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
page int A page number within the paginated result set. [optional]
limit int Number of results to return per page. [optional]

Return type

\SignRequest\Model\InlineResponse2007

Authorization

Token

HTTP request headers

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

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

teamsPartialUpdate

\SignRequest\Model\Team teamsPartialUpdate($subdomain, $data)

Update a Team

Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://_{{ subdomain }}.signrequest.com/api/v1/... To invite new team members you can use POST {"email":"[email protected]","is_admin":false,"is_owner":false} to: https://signrequest.com/api/v1/teams/_**{{ subdomain }}**/invite_member/

Example

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

// Configure API key authorization: Token
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new SignRequest\Api\TeamsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subdomain = "subdomain_example"; // string | 
$data = new \SignRequest\Model\Team(); // \SignRequest\Model\Team | 

try {
    $result = $apiInstance->teamsPartialUpdate($subdomain, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamsApi->teamsPartialUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
subdomain string
data \SignRequest\Model\Team

Return type

\SignRequest\Model\Team

Authorization

Token

HTTP request headers

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

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

teamsRead

\SignRequest\Model\Team teamsRead($subdomain)

Retrieve a Team

Required fields are name and subdomain where the subdomain is globally unique. Use POST to create a Team. To update a field on a Team use PATCH. To use the API on behalf of a particular team change the endpoint to: https://_{{ subdomain }}.signrequest.com/api/v1/... To invite new team members you can use POST {"email":"[email protected]","is_admin":false,"is_owner":false} to: https://signrequest.com/api/v1/teams/_**{{ subdomain }}**/invite_member/

Example

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

// Configure API key authorization: Token
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = SignRequest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new SignRequest\Api\TeamsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subdomain = "subdomain_example"; // string | 

try {
    $result = $apiInstance->teamsRead($subdomain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamsApi->teamsRead: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
subdomain string

Return type

\SignRequest\Model\Team

Authorization

Token

HTTP request headers

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

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