Skip to content

Latest commit

 

History

History
346 lines (233 loc) · 10.5 KB

TeamsApi.md

File metadata and controls

346 lines (233 loc) · 10.5 KB
Raw

SignRequestClient::TeamsApi

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

Method HTTP request Description
teams_create POST /teams/ Create a Team
teams_delete DELETE /teams/{subdomain}/ Delete a Team
teams_invite_member POST /teams/{subdomain}/invite_member/ Invite a Team Member
teams_list GET /teams/ Retrieve a list of Teams
teams_partial_update PATCH /teams/{subdomain}/ Update a Team
teams_read GET /teams/{subdomain}/ Retrieve a Team

teams_create

Team teams_create(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

# load the gem
require 'signrequest_client'
# setup authorization
SignRequestClient.configure do |config|
  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SignRequestClient::TeamsApi.new

data = SignRequestClient::Team.new # Team | 


begin
  #Create a Team
  result = api_instance.teams_create(data)
  p result
rescue SignRequestClient::ApiError => e
  puts "Exception when calling TeamsApi->teams_create: #{e}"
end

Parameters

Name Type Description Notes
data Team

Return type

Team

Authorization

Token

HTTP request headers

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

teams_delete

teams_delete(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

# load the gem
require 'signrequest_client'
# setup authorization
SignRequestClient.configure do |config|
  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SignRequestClient::TeamsApi.new

subdomain = 'subdomain_example' # String | 


begin
  #Delete a Team
  api_instance.teams_delete(subdomain, )
rescue SignRequestClient::ApiError => e
  puts "Exception when calling TeamsApi->teams_delete: #{e}"
end

Parameters

Name Type Description Notes
subdomain String

Return type

nil (empty response body)

Authorization

Token

HTTP request headers

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

teams_invite_member

InviteMember teams_invite_member(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

# load the gem
require 'signrequest_client'
# setup authorization
SignRequestClient.configure do |config|
  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SignRequestClient::TeamsApi.new

subdomain = 'subdomain_example' # String | 

data = SignRequestClient::InviteMember.new # InviteMember | 


begin
  #Invite a Team Member
  result = api_instance.teams_invite_member(subdomain, data)
  p result
rescue SignRequestClient::ApiError => e
  puts "Exception when calling TeamsApi->teams_invite_member: #{e}"
end

Parameters

Name Type Description Notes
subdomain String
data InviteMember

Return type

InviteMember

Authorization

Token

HTTP request headers

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

teams_list

InlineResponse2007 teams_list(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 protected]","is_admin":false,"is_owner":false} to: https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/

Example

# load the gem
require 'signrequest_client'
# setup authorization
SignRequestClient.configure do |config|
  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SignRequestClient::TeamsApi.new

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

begin
  #Retrieve a list of Teams
  result = api_instance.teams_list(opts)
  p result
rescue SignRequestClient::ApiError => e
  puts "Exception when calling TeamsApi->teams_list: #{e}"
end

Parameters

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

Return type

InlineResponse2007

Authorization

Token

HTTP request headers

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

teams_partial_update

Team teams_partial_update(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

# load the gem
require 'signrequest_client'
# setup authorization
SignRequestClient.configure do |config|
  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SignRequestClient::TeamsApi.new

subdomain = 'subdomain_example' # String | 

data = SignRequestClient::Team.new # Team | 


begin
  #Update a Team
  result = api_instance.teams_partial_update(subdomain, data)
  p result
rescue SignRequestClient::ApiError => e
  puts "Exception when calling TeamsApi->teams_partial_update: #{e}"
end

Parameters

Name Type Description Notes
subdomain String
data Team

Return type

Team

Authorization

Token

HTTP request headers

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

teams_read

Team teams_read(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

# load the gem
require 'signrequest_client'
# setup authorization
SignRequestClient.configure do |config|
  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SignRequestClient::TeamsApi.new

subdomain = 'subdomain_example' # String | 


begin
  #Retrieve a Team
  result = api_instance.teams_read(subdomain, )
  p result
rescue SignRequestClient::ApiError => e
  puts "Exception when calling TeamsApi->teams_read: #{e}"
end

Parameters

Name Type Description Notes
subdomain String

Return type

Team

Authorization

Token

HTTP request headers

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