signrequest_client 0.1.0 → 1.0.0

data/docs/TeamMember.md

@@ -6,7 +6,6 @@ Name | Type | Description | Notes
 **uuid** | **String** |  | [optional] 
 **url** | **String** |  | [optional] 
 **user** | [**User**](User.md) |  | [optional] 
-**team** | [**InlineTeam**](InlineTeam.md) |  | [optional] 
 **is_admin** | **BOOLEAN** |  | [optional] 
 **is_active** | **BOOLEAN** |  | [optional] 
 **is_owner** | **BOOLEAN** |  | [optional] 

data/docs/TeamMembersApi.md

@@ -4,14 +4,14 @@ All URIs are relative to *https://signrequest.com/api/v1*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**team_members_list**](TeamMembersApi.md#team_members_list) | **GET** /team-members/ | 
-[**team_members_read**](TeamMembersApi.md#team_members_read) | **GET** /team-members/{uuid}/ | 
+[**team_members_list**](TeamMembersApi.md#team_members_list) | **GET** /team-members/ | Retrieve a list of Team Members
+[**team_members_read**](TeamMembersApi.md#team_members_read) | **GET** /team-members/{uuid}/ | Retrieve a Team Member
 
 
 # **team_members_list**
 > InlineResponse2006 team_members_list(opts)
 
-
+Retrieve a list of Team Members
 
 
 
@@ -41,6 +41,7 @@ opts = {
 }
 
 begin
+  #Retrieve a list of Team Members
   result = api_instance.team_members_list(opts)
   p result
 rescue SignRequestClient::ApiError => e
@@ -79,7 +80,7 @@ Name | Type | Description  | Notes
 # **team_members_read**
 > TeamMember team_members_read(uuid)
 
-
+Retrieve a Team Member
 
 
 
@@ -101,6 +102,7 @@ uuid = "uuid_example" # String |
 
 
 begin
+  #Retrieve a Team Member
   result = api_instance.team_members_read(uuid)
   p result
 rescue SignRequestClient::ApiError => e

data/docs/TeamsApi.md

@@ -4,20 +4,19 @@ 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
 
-
-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/*
+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
@@ -37,6 +36,7 @@ data = SignRequestClient::Team.new # Team |
 
 
 begin
+  #Create a Team
   result = api_instance.teams_create(data)
   p result
 rescue SignRequestClient::ApiError => e
@@ -68,9 +68,9 @@ Name | Type | Description  | Notes
 # **teams_invite_member**
 > InviteMember teams_invite_member(subdomain, data)
 
+Invite a Team 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/*
+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
@@ -92,6 +92,7 @@ data = SignRequestClient::InviteMember.new # InviteMember |
 
 
 begin
+  #Invite a Team Member
   result = api_instance.teams_invite_member(subdomain, data)
   p result
 rescue SignRequestClient::ApiError => e
@@ -124,9 +125,9 @@ Name | Type | Description  | Notes
 # **teams_list**
 > InlineResponse2007 teams_list(opts)
 
+Retrieve a list of Teams
 
-
-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/*
+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
@@ -148,6 +149,7 @@ opts = {
 }
 
 begin
+  #Retrieve a list of Teams
   result = api_instance.teams_list(opts)
   p result
 rescue SignRequestClient::ApiError => e
@@ -180,9 +182,9 @@ Name | Type | Description  | Notes
 # **teams_partial_update**
 > Team teams_partial_update(subdomain, data)
 
+Update a Team
 
-
-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/*
+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
@@ -204,6 +206,7 @@ data = SignRequestClient::Team.new # Team |
 
 
 begin
+  #Update a Team
   result = api_instance.teams_partial_update(subdomain, data)
   p result
 rescue SignRequestClient::ApiError => e
@@ -236,9 +239,9 @@ Name | Type | Description  | Notes
 # **teams_read**
 > Team teams_read(subdomain, )
 
+Retrieve a Team
 
-
-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/*
+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
@@ -258,6 +261,7 @@ subdomain = "subdomain_example" # String |
 
 
 begin
+  #Retrieve a Team
   result = api_instance.teams_read(subdomain, )
   p result
 rescue SignRequestClient::ApiError => e
@@ -286,59 +290,3 @@ Name | Type | Description  | Notes
 
 
 
-# **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)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-

data/docs/Template.md

@@ -4,11 +4,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **url** | **String** |  | [optional] 
-**name** | **String** |  | [optional] 
+**name** | **String** | Defaults to filename | [optional] 
 **uuid** | **String** |  | [optional] 
 **user** | [**User**](User.md) |  | [optional] 
-**team** | [**InlineTeam**](InlineTeam.md) |  | [optional] 
-**who** | **String** |  | [optional] 
+**who** | **String** | `m`: only me, `mo`: me and others, `o`: only others | [optional] 
 **signers** | [**Array<DocumentSignerTemplateConf>**](DocumentSignerTemplateConf.md) |  | [optional] 
 
 

data/docs/TemplatesApi.md

@@ -4,14 +4,14 @@ All URIs are relative to *https://signrequest.com/api/v1*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**templates_list**](TemplatesApi.md#templates_list) | **GET** /templates/ | 
-[**templates_read**](TemplatesApi.md#templates_read) | **GET** /templates/{uuid}/ | 
+[**templates_list**](TemplatesApi.md#templates_list) | **GET** /templates/ | Retrieve a list of Templates
+[**templates_read**](TemplatesApi.md#templates_read) | **GET** /templates/{uuid}/ | Retrieve a Template
 
 
 # **templates_list**
 > InlineResponse2008 templates_list(opts)
 
-
+Retrieve a list of Templates
 
 
 
@@ -35,6 +35,7 @@ opts = {
 }
 
 begin
+  #Retrieve a list of Templates
   result = api_instance.templates_list(opts)
   p result
 rescue SignRequestClient::ApiError => e
@@ -67,7 +68,7 @@ Name | Type | Description  | Notes
 # **templates_read**
 > Template templates_read(uuid)
 
-
+Retrieve a Template
 
 
 
@@ -89,6 +90,7 @@ uuid = "uuid_example" # String |
 
 
 begin
+  #Retrieve a Template
   result = api_instance.templates_read(uuid)
   p result
 rescue SignRequestClient::ApiError => e

data/docs/WebhookSubscription.md

@@ -5,11 +5,10 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **url** | **String** |  | [optional] 
 **uuid** | **String** |  | [optional] 
-**name** | **String** |  | [optional] 
+**name** | **String** | Optional name to easily identify what webhook is used for | [optional] 
 **event_type** | **String** |  | 
 **callback_url** | **String** |  | 
 **integration** | **String** |  | [optional] 
-**team** | [**InlineTeam**](InlineTeam.md) |  | [optional] 
 **created** | **DateTime** |  | [optional] 
 
 

data/docs/WebhooksApi.md

@@ -4,18 +4,18 @@ All URIs are relative to *https://signrequest.com/api/v1*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**webhooks_create**](WebhooksApi.md#webhooks_create) | **POST** /webhooks/ | 
-[**webhooks_delete**](WebhooksApi.md#webhooks_delete) | **DELETE** /webhooks/{uuid}/ | 
-[**webhooks_list**](WebhooksApi.md#webhooks_list) | **GET** /webhooks/ | 
-[**webhooks_partial_update**](WebhooksApi.md#webhooks_partial_update) | **PATCH** /webhooks/{uuid}/ | 
-[**webhooks_read**](WebhooksApi.md#webhooks_read) | **GET** /webhooks/{uuid}/ | 
-[**webhooks_update**](WebhooksApi.md#webhooks_update) | **PUT** /webhooks/{uuid}/ | 
+[**webhooks_create**](WebhooksApi.md#webhooks_create) | **POST** /webhooks/ | Create a Webhook
+[**webhooks_delete**](WebhooksApi.md#webhooks_delete) | **DELETE** /webhooks/{uuid}/ | Delete a Webhook
+[**webhooks_list**](WebhooksApi.md#webhooks_list) | **GET** /webhooks/ | Retrieve a list of Webhooks
+[**webhooks_partial_update**](WebhooksApi.md#webhooks_partial_update) | **PATCH** /webhooks/{uuid}/ | Partially update a Webhook
+[**webhooks_read**](WebhooksApi.md#webhooks_read) | **GET** /webhooks/{uuid}/ | Retrieve a Webhook
+[**webhooks_update**](WebhooksApi.md#webhooks_update) | **PUT** /webhooks/{uuid}/ | Update a Webhook
 
 
 # **webhooks_create**
 > WebhookSubscription webhooks_create(data)
 
-
+Create a Webhook
 
 
 
@@ -37,6 +37,7 @@ data = SignRequestClient::WebhookSubscription.new # WebhookSubscription |
 
 
 begin
+  #Create a Webhook
   result = api_instance.webhooks_create(data)
   p result
 rescue SignRequestClient::ApiError => e
@@ -68,7 +69,7 @@ Name | Type | Description  | Notes
 # **webhooks_delete**
 > webhooks_delete(uuid, )
 
-
+Delete a Webhook
 
 
 
@@ -90,6 +91,7 @@ uuid = "uuid_example" # String |
 
 
 begin
+  #Delete a Webhook
   api_instance.webhooks_delete(uuid, )
 rescue SignRequestClient::ApiError => e
   puts "Exception when calling WebhooksApi->webhooks_delete: #{e}"
@@ -120,7 +122,7 @@ nil (empty response body)
 # **webhooks_list**
 > InlineResponse2009 webhooks_list(opts)
 
-
+Retrieve a list of Webhooks
 
 
 
@@ -144,6 +146,7 @@ opts = {
 }
 
 begin
+  #Retrieve a list of Webhooks
   result = api_instance.webhooks_list(opts)
   p result
 rescue SignRequestClient::ApiError => e
@@ -176,7 +179,7 @@ Name | Type | Description  | Notes
 # **webhooks_partial_update**
 > WebhookSubscription webhooks_partial_update(uuid, data)
 
-
+Partially update a Webhook
 
 
 
@@ -200,6 +203,7 @@ data = SignRequestClient::WebhookSubscription.new # WebhookSubscription |
 
 
 begin
+  #Partially update a Webhook
   result = api_instance.webhooks_partial_update(uuid, data)
   p result
 rescue SignRequestClient::ApiError => e
@@ -232,7 +236,7 @@ Name | Type | Description  | Notes
 # **webhooks_read**
 > WebhookSubscription webhooks_read(uuid, )
 
-
+Retrieve a Webhook
 
 
 
@@ -254,6 +258,7 @@ uuid = "uuid_example" # String |
 
 
 begin
+  #Retrieve a Webhook
   result = api_instance.webhooks_read(uuid, )
   p result
 rescue SignRequestClient::ApiError => e
@@ -285,7 +290,7 @@ Name | Type | Description  | Notes
 # **webhooks_update**
 > WebhookSubscription webhooks_update(uuid, data)
 
-
+Update a Webhook
 
 
 
@@ -309,6 +314,7 @@ data = SignRequestClient::WebhookSubscription.new # WebhookSubscription |
 
 
 begin
+  #Update a Webhook
   result = api_instance.webhooks_update(uuid, data)
   p result
 rescue SignRequestClient::ApiError => e

data/lib/signrequest_client.rb

@@ -37,6 +37,8 @@ require 'signrequest_client/models/inline_response_200_6'
 require 'signrequest_client/models/inline_response_200_7'
 require 'signrequest_client/models/inline_response_200_8'
 require 'signrequest_client/models/inline_response_200_9'
+require 'signrequest_client/models/inline_response_201'
+require 'signrequest_client/models/inline_response_201_1'
 require 'signrequest_client/models/inline_sign_request'
 require 'signrequest_client/models/inline_team'
 require 'signrequest_client/models/inline_team_member'

data/lib/signrequest_client/api/api_tokens_api.rb

@@ -20,8 +20,8 @@ module SignRequestClient
       @api_client = api_client
     end
 
-    # 
-    # 
+    # Create an API token
+    # You can create an API token in the [team api settings page](/#/teams). It is also possible to get or create a token using the REST api with your login credentials.
     # @param data 
     # @param [Hash] opts the optional parameters
     # @return [AuthToken]
@@ -30,8 +30,8 @@ module SignRequestClient
       return data
     end
 
-    # 
-    # 
+    # Create an API token
+    # You can create an API token in the [team api settings page](/#/teams). It is also possible to get or create a token using the REST api with your login credentials.
     # @param data 
     # @param [Hash] opts the optional parameters
     # @return [Array<(AuthToken, Fixnum, Hash)>] AuthToken data, response status code and response headers
@@ -75,7 +75,7 @@ module SignRequestClient
       return data, status_code, headers
     end
 
-    # 
+    # Delete an API token
     # 
     # @param key A unique value identifying this api token.
     # @param [Hash] opts the optional parameters
@@ -85,7 +85,7 @@ module SignRequestClient
       return nil
     end
 
-    # 
+    # Delete an API token
     # 
     # @param key A unique value identifying this api token.
     # @param [Hash] opts the optional parameters
@@ -129,7 +129,7 @@ module SignRequestClient
       return data, status_code, headers
     end
 
-    # 
+    # Retrieve a list of API tokens
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page A page number within the paginated result set.
@@ -140,7 +140,7 @@ module SignRequestClient
       return data
     end
 
-    # 
+    # Retrieve a list of API tokens
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page A page number within the paginated result set.
@@ -184,7 +184,7 @@ module SignRequestClient
       return data, status_code, headers
     end
 
-    # 
+    # Retrieve an API token
     # 
     # @param key A unique value identifying this api token.
     # @param [Hash] opts the optional parameters
@@ -194,7 +194,7 @@ module SignRequestClient
       return data
     end
 
-    # 
+    # Retrieve an API token
     # 
     # @param key A unique value identifying this api token.
     # @param [Hash] opts the optional parameters