Skip to content

TeamsApi.md

Latest commit

 

History

History
335 lines (228 loc) · 10.7 KB

TeamsApi.md

File metadata and controls

335 lines (228 loc) · 10.7 KB

SignrequestClient.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

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-of-member-to-invite@example.com","is_admin":false,"is_owner":false} to: https://signrequest.com/api/v1/teams/_**{{ subdomain }}**/invite_member/

Example

var SignrequestClient = require('signrequest-client');
var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = 'YOUR API KEY';
Token.apiKeyPrefix = 'Token';

var apiInstance = new SignrequestClient.TeamsApi();

var data = new SignrequestClient.Team(); // Team | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.teamsCreate(data, callback);

Parameters

Name Type Description Notes
data Team

Return type

Team

Authorization

Token

HTTP request headers

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

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-of-member-to-invite@example.com","is_admin":false,"is_owner":false} to: https://signrequest.com/api/v1/teams/_**{{ subdomain }}**/invite_member/

Example

var SignrequestClient = require('signrequest-client');
var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = 'YOUR API KEY';
Token.apiKeyPrefix = 'Token';

var apiInstance = new SignrequestClient.TeamsApi();

var subdomain = "subdomain_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.teamsDelete(subdomain, , callback);

Parameters

Name Type Description Notes
subdomain String

Return type

null (empty response body)

Authorization

Token

HTTP request headers

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

teamsInviteMember

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-of-member-to-invite@example.com","is_admin":false,"is_owner":false} to: https://signrequest.com/api/v1/teams/_**{{ subdomain }}**/invite_member/

Example

var SignrequestClient = require('signrequest-client');
var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = 'YOUR API KEY';
Token.apiKeyPrefix = 'Token';

var apiInstance = new SignrequestClient.TeamsApi();

var subdomain = "subdomain_example"; // String | 

var data = new SignrequestClient.InviteMember(); // InviteMember | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.teamsInviteMember(subdomain, data, callback);

Parameters

Name Type Description Notes
subdomain String
data InviteMember

Return type

InviteMember

Authorization

Token

HTTP request headers

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

teamsList

InlineResponse2007 teamsList(opts)

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-of-member-to-invite@example.com","is_admin":false,"is_owner":false} to: https://signrequest.com/api/v1/teams/_**{{ subdomain }}**/invite_member/

Example

var SignrequestClient = require('signrequest-client');
var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = 'YOUR API KEY';
Token.apiKeyPrefix = 'Token';

var apiInstance = new SignrequestClient.TeamsApi();

var opts = { 
  'page': 56, // Number | A page number within the paginated result set.
  'limit': 56 // Number | Number of results to return per page.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.teamsList(opts, callback);

Parameters

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

Return type

InlineResponse2007

Authorization

Token

HTTP request headers

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

teamsPartialUpdate

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-of-member-to-invite@example.com","is_admin":false,"is_owner":false} to: https://signrequest.com/api/v1/teams/_**{{ subdomain }}**/invite_member/

Example

var SignrequestClient = require('signrequest-client');
var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = 'YOUR API KEY';
Token.apiKeyPrefix = 'Token';

var apiInstance = new SignrequestClient.TeamsApi();

var subdomain = "subdomain_example"; // String | 

var data = new SignrequestClient.Team(); // Team | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.teamsPartialUpdate(subdomain, data, callback);

Parameters

Name Type Description Notes
subdomain String
data Team

Return type

Team

Authorization

Token

HTTP request headers

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

teamsRead

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-of-member-to-invite@example.com","is_admin":false,"is_owner":false} to: https://signrequest.com/api/v1/teams/_**{{ subdomain }}**/invite_member/

Example

var SignrequestClient = require('signrequest-client');
var defaultClient = SignrequestClient.ApiClient.instance;

// Configure API key authorization: Token
var Token = defaultClient.authentications['Token'];
Token.apiKey = 'YOUR API KEY';
Token.apiKeyPrefix = 'Token';

var apiInstance = new SignrequestClient.TeamsApi();

var subdomain = "subdomain_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.teamsRead(subdomain, , callback);

Parameters

Name Type Description Notes
subdomain String

Return type

Team

Authorization

Token

HTTP request headers

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