Skip to content

Latest commit

 

History

History
409 lines (309 loc) · 13.3 KB

TeamsApi.md

File metadata and controls

409 lines (309 loc) · 13.3 KB

SignRequest.Api.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 (Team 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

using System;
using System.Diagnostics;
using SignRequest.Api;
using SignRequest.Client;
using SignRequest.Model;

namespace Example
{
    public class TeamsCreateExample
    {
        public void main()
        {
            // Configure API key authorization: Token
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            Configuration.Default.AddApiKeyPrefix("Authorization", "Token");

            var apiInstance = new TeamsApi();
            var data = new Team(); // Team | 

            try
            {
                // Create a Team
                Team result = apiInstance.TeamsCreate(data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.TeamsCreate: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
data Team

Return type

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

void TeamsDelete (string 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

using System;
using System.Diagnostics;
using SignRequest.Api;
using SignRequest.Client;
using SignRequest.Model;

namespace Example
{
    public class TeamsDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: Token
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            Configuration.Default.AddApiKeyPrefix("Authorization", "Token");

            var apiInstance = new TeamsApi();
            var subdomain = subdomain_example;  // string | 

            try
            {
                // Delete a Team
                apiInstance.TeamsDelete(subdomain);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.TeamsDelete: " + e.Message );
            }
        }
    }
}

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

InviteMember TeamsInviteMember (string subdomain, InviteMember 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

using System;
using System.Diagnostics;
using SignRequest.Api;
using SignRequest.Client;
using SignRequest.Model;

namespace Example
{
    public class TeamsInviteMemberExample
    {
        public void main()
        {
            // Configure API key authorization: Token
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            Configuration.Default.AddApiKeyPrefix("Authorization", "Token");

            var apiInstance = new TeamsApi();
            var subdomain = subdomain_example;  // string | 
            var data = new InviteMember(); // InviteMember | 

            try
            {
                // Invite a Team Member
                InviteMember result = apiInstance.TeamsInviteMember(subdomain, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.TeamsInviteMember: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
subdomain string
data InviteMember

Return type

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

InlineResponse2007 TeamsList (int? page = null, int? limit = null)

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

using System;
using System.Diagnostics;
using SignRequest.Api;
using SignRequest.Client;
using SignRequest.Model;

namespace Example
{
    public class TeamsListExample
    {
        public void main()
        {
            // Configure API key authorization: Token
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            Configuration.Default.AddApiKeyPrefix("Authorization", "Token");

            var apiInstance = new TeamsApi();
            var page = 56;  // int? | A page number within the paginated result set. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 

            try
            {
                // Retrieve a list of Teams
                InlineResponse2007 result = apiInstance.TeamsList(page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.TeamsList: " + e.Message );
            }
        }
    }
}

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

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

Team TeamsPartialUpdate (string subdomain, Team 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

using System;
using System.Diagnostics;
using SignRequest.Api;
using SignRequest.Client;
using SignRequest.Model;

namespace Example
{
    public class TeamsPartialUpdateExample
    {
        public void main()
        {
            // Configure API key authorization: Token
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            Configuration.Default.AddApiKeyPrefix("Authorization", "Token");

            var apiInstance = new TeamsApi();
            var subdomain = subdomain_example;  // string | 
            var data = new Team(); // Team | 

            try
            {
                // Update a Team
                Team result = apiInstance.TeamsPartialUpdate(subdomain, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.TeamsPartialUpdate: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
subdomain string
data Team

Return type

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

Team TeamsRead (string 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

using System;
using System.Diagnostics;
using SignRequest.Api;
using SignRequest.Client;
using SignRequest.Model;

namespace Example
{
    public class TeamsReadExample
    {
        public void main()
        {
            // Configure API key authorization: Token
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            Configuration.Default.AddApiKeyPrefix("Authorization", "Token");

            var apiInstance = new TeamsApi();
            var subdomain = subdomain_example;  // string | 

            try
            {
                // Retrieve a Team
                Team result = apiInstance.TeamsRead(subdomain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.TeamsRead: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
subdomain string

Return type

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]