yousign_client 1.0.0

data/docs/FileInput.md

@@ -0,0 +1,15 @@
+# YousignClient::FileInput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the file | [optional] 
+**type** | **String** | Type of the file | [optional] 
+**password** | **String** | Password for protected PDF file | [optional] 
+**description** | **String** | Description of the file | [optional] 
+**metadata** | [**FileInputMetadata**](FileInputMetadata.md) |  | [optional] 
+**content** | **String** | Content in base 64 of the file | [optional] 
+**procedure** | **String** | Id of the procedure | [optional] 
+**position** | **Integer** |  | [optional] [default to 0]
+
+

data/docs/FileInputMetadata.md

@@ -0,0 +1,9 @@
+# YousignClient::FileInputMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key1** | **String** |  | [optional] 
+**key2** | **Integer** |  | [optional] 
+
+

data/docs/FileObjectInput.md

@@ -0,0 +1,21 @@
+# YousignClient::FileObjectInput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file** | **String** | File id reference | 
+**page** | **Integer** | Page of the visible signature. This property is ignored if fieldName is set.  If you want a visible signature, you must set page, position and fieldName. | [optional] 
+**position** | **String** | Coordinates of the signature image to set. Format is : \"llx,lly,urx,ury\". llx=left lower x coordinate, lly=left lower y coordinate, urx=upper right x coordinate, ury = upper right y coordinate. To get easily coordinates, you could use this tool : http://placeit.yousign.fr | [optional] 
+**field_name** | **String** | [type=signature] Name of the signature field existing in the document, it will be not used on the signature image. | [optional] 
+**mention** | **String** | [type=signature] Text associated above the signature image.  You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional] 
+**mention2** | **String** | [type=signature] Text associated below the signature image. (internal usage only, should not be used).  You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional] 
+**member** | **String** | Member id reference | [optional] 
+**reason** | **String** | [type=signature] The reason they are signing the agreement | [optional] [default to 'Signed by Yousign']
+**type** | **String** | The type of the file object | [optional] [default to 'signature']
+**content_required** | **BOOLEAN** | [type=text] Indicate if the member must fill or not the field | [optional] [default to false]
+**content** | **String** | [type=text] The content of the field. Could be used for placeholder | [optional] 
+**font_family** | **String** | [type=text] The font familly used to render the TextField. Currently only the default value will be used. | [optional] [default to 'raleway']
+**font_size** | **Integer** | [type=text] The font size used to render the field. Currently only the default value will be used. | [optional] [default to 12]
+**font_color** | **String** | [type=text] The font color used to render the field. | [optional] 
+
+

data/docs/FileObjectInputWithoutFileReference.md

@@ -0,0 +1,13 @@
+# YousignClient::FileObjectInputWithoutFileReference
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | **Integer** | Page of the visible signature. This property is ignored if fieldName is set.  If you want a visible signature, you must set page, position and fieldName. | [optional] 
+**position** | **String** | Coordinates of the signature image to set. Format is : \"llx,lly,urx,ury\". llx=left lower x coordinate, lly=left lower y coordinate, urx=upper right x coordinate, ury = upper right y coordinate. To get easily coordinates, you could use this tool : http://placeit.yousign.fr | [optional] 
+**field_name** | **String** | Name of the signature field existing in the document, it will be not used on the signature image. | [optional] 
+**mention** | **String** | Text associated above the signature image.  You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional] 
+**mention2** | **String** | Text associated below the signature image.  You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional] 
+**reason** | **String** | The reason they are signing the agreement | [optional] [default to 'Signed by Yousign']
+
+

data/docs/FileObjectOutput.md

@@ -0,0 +1,24 @@
+# YousignClient::FileObjectOutput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Id of the object | [optional] 
+**file** | [**FileOutput**](FileOutput.md) |  | 
+**page** | **Integer** | Page of the visible signature. This property is ignored if fieldName is set. If you want a visible signature, you must set page, position and fieldName. | [optional] 
+**position** | **String** | Coordinates of the signature image to set. Format is : “llx,lly,urx,ury”. llx=left lower x coordinate, lly=left lower y coordinate, urx=upper right x coordinate, ury = upper right y coordinate. To get easily coordinates, you could use this tool : http://placeit.yousign.fr | [optional] 
+**field_name** | **String** | [type=signature] Name of the signature field existing in the document | [optional] 
+**mention** | **String** | [type=signature] Text associated above the signature image.  You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional] 
+**mention2__internal** | **String** | [type=signature] Text associated below the signature image. (internal usage only, should not be used).  You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional] 
+**created_at** | **DateTime** | Created date of the object | [optional] 
+**updated_at** | **DateTime** | Updated date of the object | [optional] 
+**executed_at** | **DateTime** | Date of signature or validation | [optional] 
+**reason** | **String** | [type=signature] The reason they are signing the agreement | [optional] [default to 'Signed by Firstname Lastname']
+**type** | **String** | The type of the file object | [optional] [default to 'signature']
+**content_required** | **BOOLEAN** | [type=text] Indicate if the member must fill or not the field | [optional] [default to false]
+**content** | **String** | [type=text] The content of the field. Could be used for placeholder | [optional] 
+**font_family** | **String** | [type=text] The font familly used to render the TextField. Currently only the default value will be used. | [optional] [default to 'raleway']
+**font_size** | **Integer** | [type=text] The font size used to render the field. Currently only the default value will be used. | [optional] [default to 12]
+**font_color** | **String** | [type=text] The font color used to render the field. | [optional] 
+
+

data/docs/FileObjectOutputWithoutFileReference.md

@@ -0,0 +1,17 @@
+# YousignClient::FileObjectOutputWithoutFileReference
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Id of the object | [optional] 
+**page** | **Integer** | Page of the visible signature. This property is ignored if fieldName is set. If you want a visible signature, you must set page, position and fieldName. | [optional] 
+**position** | **String** | Coordinates of the signature image to set. Format is : “llx,lly,urx,ury”. llx=left lower x coordinate, lly=left lower y coordinate, urx=upper right x coordinate, ury = upper right y coordinate. To get easily coordinates, you could use this tool : http://placeit.yousign.fr | [optional] 
+**field_name** | **String** | Name of the signature field existing in the document | [optional] 
+**mention** | **String** | Text associated above the signature image.  You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional] 
+**mention2__internal** | **String** | Text associated below the signature image.  You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional] 
+**created_at** | **DateTime** | Created date of the object | [optional] 
+**updated_at** | **DateTime** | Updated date of the object | [optional] 
+**executed_at** | **DateTime** | Date of signature or validation | [optional] 
+**reason** | **String** | The reason they are signing the agreement | [optional] [default to 'Signed by Yousign']
+
+

data/docs/FileObjectsApi.md

@@ -0,0 +1,220 @@
+# YousignClient::FileObjectsApi
+
+All URIs are relative to *https://api.yousign.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**file_objects_id_delete**](FileObjectsApi.md#file_objects_id_delete) | **DELETE** /file_objects/{id} | Delete a File Object
+[**file_objects_id_get**](FileObjectsApi.md#file_objects_id_get) | **GET** /file_objects/{id} | Find a File Object by ID
+[**file_objects_id_put**](FileObjectsApi.md#file_objects_id_put) | **PUT** /file_objects/{id} | Update a File Object
+[**file_objects_post**](FileObjectsApi.md#file_objects_post) | **POST** /file_objects | Create a new File Object
+
+
+# **file_objects_id_delete**
+> file_objects_id_delete(id, authorization)
+
+Delete a File Object
+
+Delete a File Object
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::FileObjectsApi.new
+
+id = 'id_example' # String | 
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+
+begin
+  #Delete a File Object
+  api_instance.file_objects_id_delete(id, authorization)
+rescue YousignClient::ApiError => e
+  puts "Exception when calling FileObjectsApi->file_objects_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **file_objects_id_get**
+> FileObjectOutput file_objects_id_get(id, authorization)
+
+Find a File Object by ID
+
+Get a File Object
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::FileObjectsApi.new
+
+id = 'id_example' # String | 
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+
+begin
+  #Find a File Object by ID
+  result = api_instance.file_objects_id_get(id, authorization)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling FileObjectsApi->file_objects_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+
+### Return type
+
+[**FileObjectOutput**](FileObjectOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **file_objects_id_put**
+> FileObjectOutput file_objects_id_put(id, authorization, content_type, body)
+
+Update a File Object
+
+Update a File Object
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::FileObjectsApi.new
+
+id = 'id_example' # String | 
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+content_type = 'application/json' # String | The MIME type of the body of the request
+
+body = YousignClient::FileObjectInput.new # FileObjectInput | 
+
+
+begin
+  #Update a File Object
+  result = api_instance.file_objects_id_put(id, authorization, content_type, body)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling FileObjectsApi->file_objects_id_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+ **content_type** | **String**| The MIME type of the body of the request | 
+ **body** | [**FileObjectInput**](FileObjectInput.md)|  | 
+
+### Return type
+
+[**FileObjectOutput**](FileObjectOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **file_objects_post**
+> FileObjectOutput file_objects_post(authorization, content_type, body)
+
+Create a new File Object
+
+Create a new fileObject
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::FileObjectsApi.new
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+content_type = 'application/json' # String | The MIME type of the body of the request
+
+body = YousignClient::FileObjectInput.new # FileObjectInput | 
+
+
+begin
+  #Create a new File Object
+  result = api_instance.file_objects_post(authorization, content_type, body)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling FileObjectsApi->file_objects_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+ **content_type** | **String**| The MIME type of the body of the request | 
+ **body** | [**FileObjectInput**](FileObjectInput.md)|  | 
+
+### Return type
+
+[**FileObjectOutput**](FileObjectOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/FileOutput.md

@@ -0,0 +1,19 @@
+# YousignClient::FileOutput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Id of the object | [optional] 
+**name** | **String** | Name of the file | [optional] 
+**type** | **String** | Type of file | [optional] 
+**content_type** | **String** | Type of content | [optional] 
+**description** | **String** | Description of the file | [optional] 
+**created_at** | **String** | Created date of the object | [optional] 
+**updated_at** | **String** | Updated date of the object | [optional] 
+**metadata** | [**FileInputMetadata**](FileInputMetadata.md) |  | [optional] 
+**workspace** | **String** | Id of workspace | [optional] 
+**creator** | **String** | Id of creator | [optional] 
+**sha256** | **String** | File hash | [optional] 
+**position** | **Integer** |  | [optional] [default to 0]
+
+

data/docs/FilesApi.md

@@ -0,0 +1,218 @@
+# YousignClient::FilesApi
+
+All URIs are relative to *https://api.yousign.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**files_id_download_get**](FilesApi.md#files_id_download_get) | **GET** /files/{id}/download | Download a File
+[**files_id_duplicate_post**](FilesApi.md#files_id_duplicate_post) | **POST** /files/{id}/duplicate | Duplicate a File
+[**files_id_get**](FilesApi.md#files_id_get) | **GET** /files/{id} | Find a File by ID
+[**files_post**](FilesApi.md#files_post) | **POST** /files | Create a new File
+
+
+# **files_id_download_get**
+> String files_id_download_get(id, authorization)
+
+Download a File
+
+Used to get the base64 content of a file
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::FilesApi.new
+
+id = 'id_example' # String | 
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+
+begin
+  #Download a File
+  result = api_instance.files_id_download_get(id, authorization)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling FilesApi->files_id_download_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **files_id_duplicate_post**
+> FileOutput files_id_duplicate_post(id, authorization, content_type)
+
+Duplicate a File
+
+Duplicate a file. It will be create a clone of this file, with a new ID.
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::FilesApi.new
+
+id = 'id_example' # String | 
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+content_type = 'application/json' # String | The MIME type of the body of the request
+
+
+begin
+  #Duplicate a File
+  result = api_instance.files_id_duplicate_post(id, authorization, content_type)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling FilesApi->files_id_duplicate_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+ **content_type** | **String**| The MIME type of the body of the request | 
+
+### Return type
+
+[**FileOutput**](FileOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **files_id_get**
+> FileOutput files_id_get(id, authorization)
+
+Find a File by ID
+
+Returns all the information regarding the File but without its content (for performance issue).
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::FilesApi.new
+
+id = 'id_example' # String | 
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+
+begin
+  #Find a File by ID
+  result = api_instance.files_id_get(id, authorization)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling FilesApi->files_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+
+### Return type
+
+[**FileOutput**](FileOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **files_post**
+> FileOutput files_post(authorization, content_type, body)
+
+Create a new File
+
+Used to upload a file in base64 on our platform
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::FilesApi.new
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+content_type = 'application/json' # String | The MIME type of the body of the request
+
+body = YousignClient::FileInput.new # FileInput | 
+
+
+begin
+  #Create a new File
+  result = api_instance.files_post(authorization, content_type, body)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling FilesApi->files_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+ **content_type** | **String**| The MIME type of the body of the request | 
+ **body** | [**FileInput**](FileInput.md)|  | 
+
+### Return type
+
+[**FileOutput**](FileOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+