TeamsApi.md in signrequest_client-1.0.0

- old
+ new

@@ -2,25 +2,24 @@
 
 All URIs are relative to *https://signrequest.com/api/v1*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**teams_create**](TeamsApi.md#teams_create) | **POST** /teams/ | 
-[**teams_invite_member**](TeamsApi.md#teams_invite_member) | **POST** /teams/{subdomain}/invite_member/ | 
-[**teams_list**](TeamsApi.md#teams_list) | **GET** /teams/ | 
-[**teams_partial_update**](TeamsApi.md#teams_partial_update) | **PATCH** /teams/{subdomain}/ | 
-[**teams_read**](TeamsApi.md#teams_read) | **GET** /teams/{subdomain}/ | 
-[**teams_update**](TeamsApi.md#teams_update) | **PUT** /teams/{subdomain}/ | 
+[**teams_create**](TeamsApi.md#teams_create) | **POST** /teams/ | Create 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
 
 
 # **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-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
 
-If your application requires to create Teams and act on behalf of them you need to become an integration partner.  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
@@ -35,10 +34,11 @@
 
 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
@@ -66,14 +66,14 @@
 
 
 # **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-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
 
-If your application requires to create Teams and act on behalf of them you need to become an integration partner.  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
@@ -90,10 +90,11 @@
 
 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
@@ -122,14 +123,14 @@
 
 
 # **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-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
 
-If your application requires to create Teams and act on behalf of them you need to become an integration partner.  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
@@ -146,10 +147,11 @@
   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
@@ -178,14 +180,14 @@
 
 
 # **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-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
 
-If your application requires to create Teams and act on behalf of them you need to become an integration partner.  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
@@ -202,10 +204,11 @@
 
 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
@@ -234,14 +237,14 @@
 
 
 # **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-of-member-to-invite@example.com**\",\"is_admin\":false,\"is_owner\":false} to: *https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*
 
-If your application requires to create Teams and act on behalf of them you need to become an integration partner.  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
@@ -256,10 +259,11 @@
 
 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
@@ -268,65 +272,9 @@
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **subdomain** | **String**|  | 
-
-### Return type
-
-[**Team**](Team.md)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **teams_update**
-> Team teams_update(subdomain, data)
-
-
-
-If your application requires to create Teams and act on behalf of them you need to become an integration partner.  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 | 
-
-data = SignRequestClient::Team.new # Team | 
-
-
-begin
-  result = api_instance.teams_update(subdomain, data)
-  p result
-rescue SignRequestClient::ApiError => e
-  puts "Exception when calling TeamsApi->teams_update: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **subdomain** | **String**|  | 
- **data** | [**Team**](Team.md)|  | 
 
 ### Return type
 
 [**Team**](Team.md)
 