docs/TeamsApi.md in signrequest_client-1.0.0 vs docs/TeamsApi.md in signrequest_client-1.1.0

- old
+ new

@@ -3,10 +3,11 @@ All URIs are relative to *https://signrequest.com/api/v1* Method | HTTP request | Description ------------- | ------------- | ------------- [**teams_create**](TeamsApi.md#teams_create) | **POST** /teams/ | Create a Team +[**teams_delete**](TeamsApi.md#teams_delete) | **DELETE** /teams/{subdomain}/ | Delete a Team [**teams_invite_member**](TeamsApi.md#teams_invite_member) | **POST** /teams/{subdomain}/invite_member/ | Invite a Team Member [**teams_list**](TeamsApi.md#teams_list) | **GET** /teams/ | Retrieve a list of Teams [**teams_partial_update**](TeamsApi.md#teams_partial_update) | **PATCH** /teams/{subdomain}/ | Update a Team [**teams_read**](TeamsApi.md#teams_read) | **GET** /teams/{subdomain}/ | Retrieve a Team @@ -63,10 +64,63 @@ - **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-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/* + +### Example +```ruby +# 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](../README.md#Token) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + # **teams_invite_member** > InviteMember teams_invite_member(subdomain, data) Invite a Team Member @@ -84,11 +138,11 @@ #config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = SignRequestClient::TeamsApi.new -subdomain = "subdomain_example" # String | +subdomain = 'subdomain_example' # String | data = SignRequestClient::InviteMember.new # InviteMember | begin @@ -198,11 +252,11 @@ #config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = SignRequestClient::TeamsApi.new -subdomain = "subdomain_example" # String | +subdomain = 'subdomain_example' # String | data = SignRequestClient::Team.new # Team | begin @@ -255,10 +309,10 @@ #config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = SignRequestClient::TeamsApi.new -subdomain = "subdomain_example" # String | +subdomain = 'subdomain_example' # String | begin #Retrieve a Team result = api_instance.teams_read(subdomain, )