YousignClient::ProceduresApi

All URIs are relative to https://api.yousign.com

Method	HTTP request	Description
export_procedures_get	GET /export/procedures	Export Procedure list
procedures_get	GET /procedures	Get Procedure list
procedures_id_delete	DELETE /procedures/{id}	Delete a Procedure
procedures_id_duplicate_post	POST /procedures/{id}/duplicate	Duplicate a Procedure
procedures_id_get	GET /procedures/{id}	Find a Procedure by ID
procedures_id_proof_get	GET /procedures/{id}/proof	Get a Procedure proof file
procedures_id_put	PUT /procedures/{id}	Update a Procedure
procedures_id_remind_post	POST /procedures/{id}/remind	Remind a Procedure
procedures_post	POST /procedures	Create a new Procedure

export_procedures_get

String export_procedures_get(opts)

Export Procedure list

Example

# load the gem
require 'yousign_client'
# setup authorization
YousignClient.configure do |config|
  # Configure API key authorization: api_key
  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 = YousignClient::ProceduresApi.new

opts = { 
  status: 'status_example', # String | Return Procedure list based on the status for each Procedure
  name: 'test', # String | Filter by name (contains)
  members_firstname: 'test', # String | Filter by member firstname (contains)
  members_lastname: 'test', # String | Filter by member lastname (contains)
  members_phone: '+33102030405', # String | Filter by member phone (contains)
  members_email: 'test@test.fr', # String | Filter by member email (contains)
  files_name: 'test', # String | Filter by file name (contains)
  created_at: [Date.parse('2013-10-20')], # Array<Date> | Filter by creation date  createdAt[after]=2017-09-18 createdAt[before]=2017-09-18 createdAt[strictly_after]=2017-09-18 createdAt[strictly_before]=2017-09-18
  updated_at: [Date.parse('2013-10-20')], # Array<Date> | Filter by update date  updatedAt[after]=2017-09-18 updatedAt[before]=2017-09-18 updatedAt[strictly_after]=2017-09-18 updatedAt[strictly_before]=2017-09-18
  expires_at: [Date.parse('2013-10-20')], # Array<Date> | Filter by expire date  expiresAt[after]=2017-09-18 expiresAt[before]=2017-09-18 expiresAt[strictly_after]=2017-09-18 expiresAt[strictly_before]=2017-09-18
  deleted_at: [Date.parse('2013-10-20')], # Array<Date> | Filter by delete date  deletedAt[after]=2017-09-18 deletedAt[before]=2017-09-18 deletedAt[strictly_after]=2017-09-18 deletedAt[strictly_before]=2017-09-18
  order_created_at: 'order_created_at_example' # String | Order by attribut
}

begin
  #Export Procedure list
  result = api_instance.export_procedures_get(opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ProceduresApi->export_procedures_get: #{e}"
end

Parameters

Name	Type	Description	Notes
status	String	Return Procedure list based on the status for each Procedure	[optional]
name	String	Filter by name (contains)	[optional]
members_firstname	String	Filter by member firstname (contains)	[optional]
members_lastname	String	Filter by member lastname (contains)	[optional]
members_phone	String	Filter by member phone (contains)	[optional]
members_email	String	Filter by member email (contains)	[optional]
files_name	String	Filter by file name (contains)	[optional]
created_at	Array<Date>	Filter by creation date createdAt[after]=2017-09-18 createdAt[before]=2017-09-18 createdAt[strictly_after]=2017-09-18 createdAt[strictly_before]=2017-09-18	[optional]
updated_at	Array<Date>	Filter by update date updatedAt[after]=2017-09-18 updatedAt[before]=2017-09-18 updatedAt[strictly_after]=2017-09-18 updatedAt[strictly_before]=2017-09-18	[optional]
expires_at	Array<Date>	Filter by expire date expiresAt[after]=2017-09-18 expiresAt[before]=2017-09-18 expiresAt[strictly_after]=2017-09-18 expiresAt[strictly_before]=2017-09-18	[optional]
deleted_at	Array<Date>	Filter by delete date deletedAt[after]=2017-09-18 deletedAt[before]=2017-09-18 deletedAt[strictly_after]=2017-09-18 deletedAt[strictly_before]=2017-09-18	[optional]
order_created_at	String	Order by attribut	[optional]

Return type

String

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: text/csv

procedures_get

Array<ProcedureOutput> procedures_get(opts)

Get Procedure list

Example

# load the gem
require 'yousign_client'
# setup authorization
YousignClient.configure do |config|
  # Configure API key authorization: api_key
  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 = YousignClient::ProceduresApi.new

opts = { 
  status: 'status_example', # String | Return Procedure list based on the status for each Procedure
  template: false, # BOOLEAN | Used to get Procedure template list
  members: ['/members/f8311c9b-7b37-46d4-b28e-0c40d44b2f95'], # Array<String> | Get Procedure list for given members (paraph mode)
  items_per_page: '20', # String | Number of items per page for the pagination
  pagination: true, # BOOLEAN | Enable the pagination
  page: 2, # Integer | Page of the pagination
  name: 'test', # String | Filter by name (contains)
  members_firstname: 'test', # String | Filter by member firstname (contains)
  members_lastname: 'test', # String | Filter by member lastname (contains)
  members_phone: '+33102030405', # String | Filter by member phone (contains)
  members_email: 'test@test.fr', # String | Filter by member email (contains)
  files_name: 'test', # String | Filter by file name (contains)
  created_at: [Date.parse('2013-10-20')], # Array<Date> | Filter by creation date  createdAt[after]=2017-09-18 createdAt[before]=2017-09-18 createdAt[strictly_after]=2017-09-18 createdAt[strictly_before]=2017-09-18
  updated_at: [Date.parse('2013-10-20')], # Array<Date> | Filter by update date  updatedAt[after]=2017-09-18 updatedAt[before]=2017-09-18 updatedAt[strictly_after]=2017-09-18 updatedAt[strictly_before]=2017-09-18
  expires_at: [Date.parse('2013-10-20')], # Array<Date> | Filter by expire date  expiresAt[after]=2017-09-18 expiresAt[before]=2017-09-18 expiresAt[strictly_after]=2017-09-18 expiresAt[strictly_before]=2017-09-18
  deleted_at: [Date.parse('2013-10-20')], # Array<Date> | Filter by delete date  deletedAt[after]=2017-09-18 deletedAt[before]=2017-09-18 deletedAt[strictly_after]=2017-09-18 deletedAt[strictly_before]=2017-09-18
  order_created_at: 'order_created_at_example' # String | Order by createdAt  order[createdAt]=asc order[createdAt]=desc
}

begin
  #Get Procedure list
  result = api_instance.procedures_get(opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ProceduresApi->procedures_get: #{e}"
end

Parameters

Name	Type	Description	Notes
status	String	Return Procedure list based on the status for each Procedure	[optional]
template	BOOLEAN	Used to get Procedure template list	[optional] [default to false]
members	Array<String>	Get Procedure list for given members (paraph mode)	[optional]
items_per_page	String	Number of items per page for the pagination	[optional]
pagination	BOOLEAN	Enable the pagination	[optional]
page	Integer	Page of the pagination	[optional]
name	String	Filter by name (contains)	[optional]
members_firstname	String	Filter by member firstname (contains)	[optional]
members_lastname	String	Filter by member lastname (contains)	[optional]
members_phone	String	Filter by member phone (contains)	[optional]
members_email	String	Filter by member email (contains)	[optional]
files_name	String	Filter by file name (contains)	[optional]
created_at	Array<Date>	Filter by creation date createdAt[after]=2017-09-18 createdAt[before]=2017-09-18 createdAt[strictly_after]=2017-09-18 createdAt[strictly_before]=2017-09-18	[optional]
updated_at	Array<Date>	Filter by update date updatedAt[after]=2017-09-18 updatedAt[before]=2017-09-18 updatedAt[strictly_after]=2017-09-18 updatedAt[strictly_before]=2017-09-18	[optional]
expires_at	Array<Date>	Filter by expire date expiresAt[after]=2017-09-18 expiresAt[before]=2017-09-18 expiresAt[strictly_after]=2017-09-18 expiresAt[strictly_before]=2017-09-18	[optional]
deleted_at	Array<Date>	Filter by delete date deletedAt[after]=2017-09-18 deletedAt[before]=2017-09-18 deletedAt[strictly_after]=2017-09-18 deletedAt[strictly_before]=2017-09-18	[optional]
order_created_at	String	Order by createdAt order[createdAt]=asc order[createdAt]=desc	[optional]

Return type

Array<ProcedureOutput>

Authorization

api_key

HTTP request headers

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

procedures_id_delete

procedures_id_delete(id)

Delete a Procedure

Example

# load the gem
require 'yousign_client'
# setup authorization
YousignClient.configure do |config|
  # Configure API key authorization: api_key
  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 = YousignClient::ProceduresApi.new

id = 'id_example' # String | 


begin
  #Delete a Procedure
  api_instance.procedures_id_delete(id)
rescue YousignClient::ApiError => e
  puts "Exception when calling ProceduresApi->procedures_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String

Return type

nil (empty response body)

Authorization

api_key

HTTP request headers

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

procedures_id_duplicate_post

ProcedureOutput procedures_id_duplicate_post(id, body)

Duplicate a Procedure

Example

# load the gem
require 'yousign_client'
# setup authorization
YousignClient.configure do |config|
  # Configure API key authorization: api_key
  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 = YousignClient::ProceduresApi.new

id = 'id_example' # String | 

body = YousignClient::ProcedureDuplicateInput.new # ProcedureDuplicateInput | 


begin
  #Duplicate a Procedure
  result = api_instance.procedures_id_duplicate_post(id, body)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ProceduresApi->procedures_id_duplicate_post: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String
body	ProcedureDuplicateInput

Return type

ProcedureOutput

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

procedures_id_get

ProcedureOutput procedures_id_get(id)

Find a Procedure by ID

Example

# load the gem
require 'yousign_client'
# setup authorization
YousignClient.configure do |config|
  # Configure API key authorization: api_key
  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 = YousignClient::ProceduresApi.new

id = 'id_example' # String | 


begin
  #Find a Procedure by ID
  result = api_instance.procedures_id_get(id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ProceduresApi->procedures_id_get: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String

Return type

ProcedureOutput

Authorization

api_key

HTTP request headers

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

procedures_id_proof_get

String procedures_id_proof_get(id)

Get a Procedure proof file

Example

# load the gem
require 'yousign_client'
# setup authorization
YousignClient.configure do |config|
  # Configure API key authorization: api_key
  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 = YousignClient::ProceduresApi.new

id = 'id_example' # String | 


begin
  #Get a Procedure proof file
  result = api_instance.procedures_id_proof_get(id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ProceduresApi->procedures_id_proof_get: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String

Return type

String

Authorization

api_key

HTTP request headers

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

procedures_id_put

ProcedureOutput procedures_id_put(idbody)

Update a Procedure

Example

# load the gem
require 'yousign_client'
# setup authorization
YousignClient.configure do |config|
  # Configure API key authorization: api_key
  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 = YousignClient::ProceduresApi.new

id = 'id_example' # String | 

body = YousignClient::ProcedureInput.new # ProcedureInput | 


begin
  #Update a Procedure
  result = api_instance.procedures_id_put(idbody)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ProceduresApi->procedures_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String
body	ProcedureInput

Return type

ProcedureOutput

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

procedures_id_remind_post

ProcedureOutput procedures_id_remind_post(id, body)

Remind a Procedure

Example

# load the gem
require 'yousign_client'
# setup authorization
YousignClient.configure do |config|
  # Configure API key authorization: api_key
  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 = YousignClient::ProceduresApi.new

id = 'id_example' # String | 

body = YousignClient::ProcedureRemindInput.new # ProcedureRemindInput | 


begin
  #Remind a Procedure
  result = api_instance.procedures_id_remind_post(id, body)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ProceduresApi->procedures_id_remind_post: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String
body	ProcedureRemindInput

Return type

ProcedureOutput

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

procedures_post

ProcedureOutput procedures_post(body)

Create a new Procedure

Example

# load the gem
require 'yousign_client'
# setup authorization
YousignClient.configure do |config|
  # Configure API key authorization: api_key
  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 = YousignClient::ProceduresApi.new

body = YousignClient::ProcedureInput.new # ProcedureInput | 


begin
  #Create a new Procedure
  result = api_instance.procedures_post(body)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ProceduresApi->procedures_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	ProcedureInput

Return type

ProcedureOutput

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

Files

ProceduresApi.md

Latest commit

History

ProceduresApi.md

File metadata and controls

YousignClient::ProceduresApi

export_procedures_get

Example

Parameters

Return type

Authorization

HTTP request headers

procedures_get

Example

Parameters

Return type

Authorization

HTTP request headers

procedures_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

procedures_id_duplicate_post

Example

Parameters

Return type

Authorization

HTTP request headers

procedures_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

procedures_id_proof_get

Example

Parameters

Return type

Authorization

HTTP request headers

procedures_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

procedures_id_remind_post

Example

Parameters

Return type

Authorization

HTTP request headers

procedures_post

Example

Parameters

Return type

Authorization

HTTP request headers