yousign_client

YousignClient - the Ruby gem for the Public Api v3

Build the best experience of digital signature through your own platform. Increase your conversion rates, leverage your data and reduce your costs with Yousign API.

This SDK is automatically generated by the Swagger Codegen project:

• API version: 3.0
• Package version: 1.1.0
• Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build yousign_client.gemspec

Then either install the gem locally:

gem install ./yousign_client-1.1.0.gem

(for development, run gem install --dev ./yousign_client-1.1.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'yousign_client', '~> 1.1.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'yousign_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'yousign_client'
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::ApproverApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id
approver_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Approver Id


begin
  #Get an approver
  result = api_instance.get_signature_requests_signature_request_id_approvers_approver_id(signature_request_id, approver_id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ApproverApi->get_signature_requests_signature_request_id_approvers_approver_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::ApproverApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id
approver_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Approver Id
opts = {
  body: YousignClient::ApproversApproverIdBody.new # ApproversApproverIdBody |
}

begin
  result = api_instance.patch_signature_requests_signature_request_id_approvers_approver_id(signature_request_id, approver_id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ApproverApi->patch_signature_requests_signature_request_id_approvers_approver_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::ApproverApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id
opts = {
  body: YousignClient::SignatureRequestIdApproversBody.new # SignatureRequestIdApproversBody | An Approver object to be added to the signature request.
}

begin
  #Create a new approver
  result = api_instance.post_signature_requests_signature_request_id_approvers(signature_request_id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ApproverApi->post_signature_requests_signature_request_id_approvers: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::ConsumptionApi.new
from = Date.parse('2013-10-20') # Date | \"from\" date must be inferior or equal to \"to\"
to = Date.parse('2013-10-20') # Date |
opts = {
  authentication_key: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
}

begin
  #Get consumptions
  result = api_instance.get_consumptions(from, to, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ConsumptionApi->get_consumptions: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::ConsumptionApi.new
from = Date.parse('2013-10-20') # Date | \"from\" date must be inferior or equal to \"to\"
to = Date.parse('2013-10-20') # Date |
opts = {
  authentication_key: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
}

begin
  #Export consumption data
  result = api_instance.get_consumptions_export(from, to, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ConsumptionApi->get_consumptions_export: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::ContactApi.new
contact_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |


begin
  #Delete a contact
  api_instance.delete_contacts_contact_id(contact_id)
rescue YousignClient::ApiError => e
  puts "Exception when calling ContactApi->delete_contacts_contact_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::ContactApi.new
contact_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |


begin
  #Get a contact
  result = api_instance.get_contact_contact_id(contact_id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ContactApi->get_contact_contact_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::ContactApi.new
opts = {
  after: 'after_example' # String | After cursor (pagination)
}

begin
  #List all contacts
  result = api_instance.get_contacts(opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ContactApi->get_contacts: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::ContactApi.new
opts = {
  body: YousignClient::ContactsBody.new # ContactsBody |
}

begin
  #Create a contact
  result = api_instance.post_contacts(opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ContactApi->post_contacts: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::CustomExperienceApi.new
custom_experience_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |


begin
  #Delete a Custom Experience
  api_instance.delete_custom_experience(custom_experience_id)
rescue YousignClient::ApiError => e
  puts "Exception when calling CustomExperienceApi->delete_custom_experience: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::CustomExperienceApi.new
custom_experience_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |


begin
  #Delete a Custom Experience Logo
  api_instance.delete_custom_experience_logo(custom_experience_id)
rescue YousignClient::ApiError => e
  puts "Exception when calling CustomExperienceApi->delete_custom_experience_logo: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::CustomExperienceApi.new
opts = {
  after: 'after_example' # String | After cursor (pagination)
}

begin
  #List Custom Experiences
  result = api_instance.get_custom_experiences(opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling CustomExperienceApi->get_custom_experiences: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::CustomExperienceApi.new
custom_experience_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |


begin
  #Get a given Custom Experience
  result = api_instance.get_custom_experiences_custom_experience_id(custom_experience_id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling CustomExperienceApi->get_custom_experiences_custom_experience_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::CustomExperienceApi.new
custom_experience_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
opts = {
  file: 'file_example' # String |
}

begin
  #Update a Custom Experience Logo
  result = api_instance.patch_custom_experience_logo(custom_experience_id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling CustomExperienceApi->patch_custom_experience_logo: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::CustomExperienceApi.new
custom_experience_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
opts = {
  body: YousignClient::CustomExperienceInput.new # CustomExperienceInput |
}

begin
  #Update a Custom Experience
  result = api_instance.patch_custom_experiences_custom_experience_id(custom_experience_id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling CustomExperienceApi->patch_custom_experiences_custom_experience_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::CustomExperienceApi.new
opts = {
  body: YousignClient::CustomExperienceInput.new # CustomExperienceInput |
}

begin
  #Create a Custom Experience
  result = api_instance.post_custom_experience(opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling CustomExperienceApi->post_custom_experience: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::DocumentApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature request Id
document_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Document Id


begin
  #Delete a document
  api_instance.delete_signature_requests_signature_request_id_documents_document_id(signature_request_id, document_id)
rescue YousignClient::ApiError => e
  puts "Exception when calling DocumentApi->delete_signature_requests_signature_request_id_documents_document_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::DocumentApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id
opts = {
  nature: 'nature_example' # String | filter by nature
}

begin
  #List signature request documents
  result = api_instance.get_signature_requests_signature_request_id_documents(signature_request_id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling DocumentApi->get_signature_requests_signature_request_id_documents: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::DocumentApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature request Id
document_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Document Id


begin
  #Get a document
  result = api_instance.get_signature_requests_signature_request_id_documents_document_id(signature_request_id, document_id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling DocumentApi->get_signature_requests_signature_request_id_documents_document_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::DocumentApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id
document_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Document Id


begin
  #Download a single Signature Request Document
  result = api_instance.get_signature_requests_signature_request_id_documents_documents_id_download(signature_request_id, document_id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling DocumentApi->get_signature_requests_signature_request_id_documents_documents_id_download: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::DocumentApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id
opts = {
  version: 'version_example', # String | Specify documents version to download, \"completed\" is only available when the signature request status is \"done\".
  archive: true # BOOLEAN | Force zip archive download
}

begin
  #Download signature request documents
  result = api_instance.get_signature_requests_signature_request_id_documents_download(signature_request_id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling DocumentApi->get_signature_requests_signature_request_id_documents_download: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::DocumentApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature request Id
document_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Document Id
opts = {
  body: YousignClient::DocumentsDocumentIdBody.new # DocumentsDocumentIdBody |
}

begin
  #Update a document
  result = api_instance.patch_signature_requests_signature_request_id_documents_document_id(signature_request_id, document_id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling DocumentApi->patch_signature_requests_signature_request_id_documents_document_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::DocumentApi.new
opts = {
  file: 'file_example', # String |
  nature: 'nature_example', # String |
  password: 'password_example', # String |
  parse_anchors: true, # BOOLEAN |
  initials: YousignClient::InitialsArea.new # InitialsArea |
}

begin
  #Upload a document
  result = api_instance.post_documents(opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling DocumentApi->post_documents: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::DocumentApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id
opts = {
  file: 'file_example', # String |
  nature: 'nature_example', # String |
  password: 'password_example', # String |
  initials: YousignClient::null.new, #  |
  parse_anchors: true # BOOLEAN |
}

begin
  #Add document to a signature request
  result = api_instance.post_signature_requests_signature_request_id_documents(signature_request_id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling DocumentApi->post_signature_requests_signature_request_id_documents: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::DocumentApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id
document_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Document Id
opts = {
  file: 'file_example' # String |
}

begin
  #Replace a document
  result = api_instance.post_signature_requests_signature_request_id_documents_document_id_replace(signature_request_id, document_id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling DocumentApi->post_signature_requests_signature_request_id_documents_document_id_replace: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::ElectronicSealApi.new
electronic_seal_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |


begin
  #Download electronic seal audit trail
  result = api_instance.download_electronic_seal_audit_trail(electronic_seal_id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ElectronicSealApi->download_electronic_seal_audit_trail: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::ElectronicSealApi.new
id = 'id_example' # String |


begin
  #Download electronic seal document
  result = api_instance.download_electronic_seal_document(id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ElectronicSealApi->download_electronic_seal_document: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::ElectronicSealApi.new
electronic_seal_id = 'electronic_seal_id_example' # String |


begin
  #Get electronic seal
  result = api_instance.get_electronic_seal(electronic_seal_id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ElectronicSealApi->get_electronic_seal: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::ElectronicSealApi.new
electronic_seal_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |


begin
  #Get electronic seal audit trail
  result = api_instance.get_electronic_seal_audit_trail(electronic_seal_id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ElectronicSealApi->get_electronic_seal_audit_trail: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::ElectronicSealApi.new
opts = {
  body: YousignClient::CreateElectronicSealPayload.new # CreateElectronicSealPayload |
}

begin
  #Create Electronic Seal
  result = api_instance.post_electronic_seals(opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ElectronicSealApi->post_electronic_seals: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::ElectronicSealApi.new
opts = {
  file: 'file_example', # String |
  password: 'password_example' # String |
}

begin
  #Upload electronic seal document
  result = api_instance.upload_electronic_seal_document(opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ElectronicSealApi->upload_electronic_seal_document: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::ElectronicSealApi.new
opts = {
  file: 'file_example', # String |
  name: 'name_example' # String |
}

begin
  #Upload electronic seal image
  result = api_instance.upload_electronic_seal_image(opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling ElectronicSealApi->upload_electronic_seal_image: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::FollowerApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id
opts = {
  body: [YousignClient::SignatureRequestIdFollowersBody.new] # Array<SignatureRequestIdFollowersBody> | A list of Follower objects to be added to the signature request.
}

begin
  #Create new followers
  result = api_instance.post_signature_requests_signature_request_id_followers(signature_request_id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling FollowerApi->post_signature_requests_signature_request_id_followers: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::SignatureRequestApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id


begin
  #Delete a signature request
  api_instance.delete_signature_requests_signature_request_id(signature_request_id)
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureRequestApi->delete_signature_requests_signature_request_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::SignatureRequestApi.new
opts = {
  status: 'status_example', # String | Filter by status
  after: 'after_example', # String | After cursor (pagination)
  external_id: 'external_id_example', # String | Filter by external_id
  source: ['source_example'] # Array<String> | Filter by source
}

begin
  #List signature requests
  result = api_instance.get_signature_requests(opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureRequestApi->get_signature_requests: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::SignatureRequestApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id


begin
  #Fetch a signature request
  result = api_instance.get_signature_requests_signature_request_id(signature_request_id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureRequestApi->get_signature_requests_signature_request_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::SignatureRequestApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id


begin
  #Download signature request audit trails
  result = api_instance.get_signature_requests_signature_request_id_audit_trails_download(signature_request_id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureRequestApi->get_signature_requests_signature_request_id_audit_trails_download: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::SignatureRequestApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id
opts = {
  body: YousignClient::SignatureRequestsSignatureRequestIdBody.new # SignatureRequestsSignatureRequestIdBody |
}

begin
  #Update a Signature Request
  result = api_instance.patch_signature_requests_signature_request_id(signature_request_id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureRequestApi->patch_signature_requests_signature_request_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::SignatureRequestApi.new
opts = {
  body: YousignClient::SignatureRequestsBody.new # SignatureRequestsBody |
}

begin
  #Initiate a new signature request
  result = api_instance.post_signature_requests(opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureRequestApi->post_signature_requests: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::SignatureRequestApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id
opts = {
  body: YousignClient::SignatureRequestIdCancelBody.new # SignatureRequestIdCancelBody |
}

begin
  #Cancel a signature request
  result = api_instance.post_signature_requests_signature_request_id_cancel(signature_request_id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureRequestApi->post_signature_requests_signature_request_id_cancel: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::SignatureRequestApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id
opts = {
  body: YousignClient::SignatureRequestIdReactivateBody.new # SignatureRequestIdReactivateBody |
}

begin
  #Reactivate an expired signature request
  result = api_instance.post_signature_requests_signature_request_id_reactivate(signature_request_id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureRequestApi->post_signature_requests_signature_request_id_reactivate: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::SignatureRequestApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id


begin
  #Activate a signature request
  result = api_instance.post_signature_requests_signature_request_id_signatures(signature_request_id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureRequestApi->post_signature_requests_signature_request_id_signatures: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::SignatureRequestApi.new
signer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signer id
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature request id


begin
  #Send manual reminder to signer
  api_instance.post_signature_requests_signature_request_id_signers_signer_id_send_reminder(signer_id, signature_request_id)
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureRequestApi->post_signature_requests_signature_request_id_signers_signer_id_send_reminder: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::SignerApi.new
signer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signer id
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature request id


begin
  #Delete a signer
  api_instance.delete_signature_requests_signature_request_id_signers_signer_id(signer_id, signature_request_id)
rescue YousignClient::ApiError => e
  puts "Exception when calling SignerApi->delete_signature_requests_signature_request_id_signers_signer_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::SignerApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id


begin
  #List signature request signers
  result = api_instance.get_signature_requests_signature_request_id_signers(signature_request_id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignerApi->get_signature_requests_signature_request_id_signers: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::SignerApi.new
signer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signer id
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature request id


begin
  #Get signer audit trail
  result = api_instance.get_signature_requests_signature_request_id_signers_signer_id_audit_trails(signer_id, signature_request_id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignerApi->get_signature_requests_signature_request_id_signers_signer_id_audit_trails: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::SignerApi.new
signer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signer Id
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature request Id


begin
  #Download audit trail PDF
  result = api_instance.get_signers_signer_id_audit_trails_download(signer_id, signature_request_id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignerApi->get_signers_signer_id_audit_trails_download: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::SignerApi.new
signer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signer id
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature request id


begin
  #Get a signer
  result = api_instance.get_signers_signers_id(signer_id, signature_request_id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignerApi->get_signers_signers_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::SignerApi.new
signer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signer id
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature request id
opts = {
  body: YousignClient::SignersSignerIdBody.new # SignersSignerIdBody |
}

begin
  #Update a signer
  result = api_instance.patch_signature_requests_signature_request_id_signers_signer_id(signer_id, signature_request_id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignerApi->patch_signature_requests_signature_request_id_signers_signer_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::SignerApi.new
signature_request_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Signature Request Id
opts = {
  body: YousignClient::SignatureRequestIdSignersBody.new # SignatureRequestIdSignersBody |
}

begin
  #Create a new signer
  result = api_instance.post_signature_requests_signature_request_id_signers(signature_request_id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignerApi->post_signature_requests_signature_request_id_signers: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::UserApi.new
opts = {
  after: 'after_example' # String | After cursor (pagination)
}

begin
  #List all users
  result = api_instance.get_users(opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling UserApi->get_users: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::WebhookApi.new
webhook_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Webhook Id


begin
  #Unsubscribe a webhook
  api_instance.delete_webhooks_webhook_id(webhook_id)
rescue YousignClient::ApiError => e
  puts "Exception when calling WebhookApi->delete_webhooks_webhook_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::WebhookApi.new

begin
  #List webhooks
  result = api_instance.get_webhooks
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling WebhookApi->get_webhooks: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::WebhookApi.new
webhook_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Webhook Id


begin
  #Get a webhook
  result = api_instance.get_webhooks_webhook_id(webhook_id)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling WebhookApi->get_webhooks_webhook_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::WebhookApi.new
webhook_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Webhook Id
opts = {
  body: YousignClient::WebhooksWebhookIdBody.new # WebhooksWebhookIdBody |
}

begin
  #Update a webhook
  result = api_instance.patch_webhooks_webhook_id(webhook_id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling WebhookApi->patch_webhooks_webhook_id: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::WebhookApi.new
opts = {
  body: YousignClient::WebhooksBody.new # WebhooksBody |
}

begin
  #Configure a new webhook
  result = api_instance.post_webhooks_subscriptions(opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling WebhookApi->post_webhooks_subscriptions: #{e}"
end
# Setup authorization
YousignClient.configure do |config|
end

api_instance = YousignClient::WorkspaceApi.new
opts = {
  after: 'after_example' # String | After cursor (pagination)
}

begin
  #List workspaces
  result = api_instance.get_workspaces(opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling WorkspaceApi->get_workspaces: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api-sandbox.yousign.app/v3

Class	Method	HTTP request	Description
YousignClient::ApproverApi	get_signature_requests_signature_request_id_approvers_approver_id	GET /signature_requests/{signatureRequestId}/approvers/{approverId}	Get an approver
YousignClient::ApproverApi	patch_signature_requests_signature_request_id_approvers_approver_id	PATCH /signature_requests/{signatureRequestId}/approvers/{approverId}
YousignClient::ApproverApi	post_signature_requests_signature_request_id_approvers	POST /signature_requests/{signatureRequestId}/approvers	Create a new approver
YousignClient::ConsumptionApi	get_consumptions	GET /consumptions	Get consumptions
YousignClient::ConsumptionApi	get_consumptions_export	GET /consumptions/export	Export consumption data
YousignClient::ContactApi	delete_contacts_contact_id	DELETE /contacts/{contactId}	Delete a contact
YousignClient::ContactApi	get_contact_contact_id	GET /contacts/{contactId}	Get a contact
YousignClient::ContactApi	get_contacts	GET /contacts	List all contacts
YousignClient::ContactApi	post_contacts	POST /contacts	Create a contact
YousignClient::CustomExperienceApi	delete_custom_experience	DELETE /custom_experiences/{customExperienceId}	Delete a Custom Experience
YousignClient::CustomExperienceApi	delete_custom_experience_logo	DELETE /custom_experiences/{customExperienceId}/logo	Delete a Custom Experience Logo
YousignClient::CustomExperienceApi	get_custom_experiences	GET /custom_experiences	List Custom Experiences
YousignClient::CustomExperienceApi	get_custom_experiences_custom_experience_id	GET /custom_experiences/{customExperienceId}	Get a given Custom Experience
YousignClient::CustomExperienceApi	patch_custom_experience_logo	POST /custom_experiences/{customExperienceId}/logo	Update a Custom Experience Logo
YousignClient::CustomExperienceApi	patch_custom_experiences_custom_experience_id	PATCH /custom_experiences/{customExperienceId}	Update a Custom Experience
YousignClient::CustomExperienceApi	post_custom_experience	POST /custom_experiences	Create a Custom Experience
YousignClient::DocumentApi	delete_signature_requests_signature_request_id_documents_document_id	DELETE /signature_requests/{signatureRequestId}/documents/{documentId}	Delete a document
YousignClient::DocumentApi	get_signature_requests_signature_request_id_documents	GET /signature_requests/{signatureRequestId}/documents	List signature request documents
YousignClient::DocumentApi	get_signature_requests_signature_request_id_documents_document_id	GET /signature_requests/{signatureRequestId}/documents/{documentId}	Get a document
YousignClient::DocumentApi	get_signature_requests_signature_request_id_documents_documents_id_download	GET /signature_requests/{signatureRequestId}/documents/{documentId}/download	Download a single Signature Request Document
YousignClient::DocumentApi	get_signature_requests_signature_request_id_documents_download	GET /signature_requests/{signatureRequestId}/documents/download	Download signature request documents
YousignClient::DocumentApi	patch_signature_requests_signature_request_id_documents_document_id	PATCH /signature_requests/{signatureRequestId}/documents/{documentId}	Update a document
YousignClient::DocumentApi	post_documents	POST /documents	Upload a document
YousignClient::DocumentApi	post_signature_requests_signature_request_id_documents	POST /signature_requests/{signatureRequestId}/documents	Add document to a signature request
YousignClient::DocumentApi	post_signature_requests_signature_request_id_documents_document_id_replace	POST /signature_requests/{signatureRequestId}/documents/{documentId}/replace	Replace a document
YousignClient::ElectronicSealApi	download_electronic_seal_audit_trail	GET /electronic_seals/{electronicSealId}/audit_trails/download	Download electronic seal audit trail
YousignClient::ElectronicSealApi	download_electronic_seal_document	GET /electronic_seal_documents/{id}/download	Download electronic seal document
YousignClient::ElectronicSealApi	get_electronic_seal	GET /electronic_seals/{electronicSealId}	Get electronic seal
YousignClient::ElectronicSealApi	get_electronic_seal_audit_trail	GET /electronic_seals/{electronicSealId}/audit_trails	Get electronic seal audit trail
YousignClient::ElectronicSealApi	post_electronic_seals	POST /electronic_seals	Create Electronic Seal
YousignClient::ElectronicSealApi	upload_electronic_seal_document	POST /electronic_seal_documents	Upload electronic seal document
YousignClient::ElectronicSealApi	upload_electronic_seal_image	POST /electronic_seal_images	Upload electronic seal image
YousignClient::FollowerApi	post_signature_requests_signature_request_id_followers	POST /signature_requests/{signatureRequestId}/followers	Create new followers
YousignClient::SignatureRequestApi	delete_signature_requests_signature_request_id	DELETE /signature_requests/{signatureRequestId}	Delete a signature request
YousignClient::SignatureRequestApi	get_signature_requests	GET /signature_requests	List signature requests
YousignClient::SignatureRequestApi	get_signature_requests_signature_request_id	GET /signature_requests/{signatureRequestId}	Fetch a signature request
YousignClient::SignatureRequestApi	get_signature_requests_signature_request_id_audit_trails_download	GET /signature_requests/{signatureRequestId}/audit_trails/download	Download signature request audit trails
YousignClient::SignatureRequestApi	patch_signature_requests_signature_request_id	PATCH /signature_requests/{signatureRequestId}	Update a Signature Request
YousignClient::SignatureRequestApi	post_signature_requests	POST /signature_requests	Initiate a new signature request
YousignClient::SignatureRequestApi	post_signature_requests_signature_request_id_cancel	POST /signature_requests/{signatureRequestId}/cancel	Cancel a signature request
YousignClient::SignatureRequestApi	post_signature_requests_signature_request_id_reactivate	POST /signature_requests/{signatureRequestId}/reactivate	Reactivate an expired signature request
YousignClient::SignatureRequestApi	post_signature_requests_signature_request_id_signatures	POST /signature_requests/{signatureRequestId}/activate	Activate a signature request
YousignClient::SignatureRequestApi	post_signature_requests_signature_request_id_signers_signer_id_send_reminder	POST /signature_requests/{signatureRequestId}/signers/{signerId}/send_reminder	Send manual reminder to signer
YousignClient::SignerApi	delete_signature_requests_signature_request_id_signers_signer_id	DELETE /signature_requests/{signatureRequestId}/signers/{signerId}	Delete a signer
YousignClient::SignerApi	get_signature_requests_signature_request_id_signers	GET /signature_requests/{signatureRequestId}/signers	List signature request signers
YousignClient::SignerApi	get_signature_requests_signature_request_id_signers_signer_id_audit_trails	GET /signature_requests/{signatureRequestId}/signers/{signerId}/audit_trails	Get signer audit trail
YousignClient::SignerApi	get_signers_signer_id_audit_trails_download	GET /signature_requests/{signatureRequestId}/signers/{signerId}/audit_trails/download	Download audit trail PDF
YousignClient::SignerApi	get_signers_signers_id	GET /signature_requests/{signatureRequestId}/signers/{signerId}	Get a signer
YousignClient::SignerApi	patch_signature_requests_signature_request_id_signers_signer_id	PATCH /signature_requests/{signatureRequestId}/signers/{signerId}	Update a signer
YousignClient::SignerApi	post_signature_requests_signature_request_id_signers	POST /signature_requests/{signatureRequestId}/signers	Create a new signer
YousignClient::UserApi	get_users	GET /users	List all users
YousignClient::WebhookApi	delete_webhooks_webhook_id	DELETE /webhooks/{webhookId}	Unsubscribe a webhook
YousignClient::WebhookApi	get_webhooks	GET /webhooks	List webhooks
YousignClient::WebhookApi	get_webhooks_webhook_id	GET /webhooks/{webhookId}	Get a webhook
YousignClient::WebhookApi	patch_webhooks_webhook_id	PATCH /webhooks/{webhookId}	Update a webhook
YousignClient::WebhookApi	post_webhooks_subscriptions	POST /webhooks	Configure a new webhook
YousignClient::WorkspaceApi	get_workspaces	GET /workspaces	List workspaces

Documentation for Models

• YousignClient::AnyOfCreateElectronicSealPayloadFieldsItems
• YousignClient::AnyOfdocumentsDocumentIdBodyInitials
• YousignClient::AnyOfsignatureRequestIdDocumentsBodyInitials
• YousignClient::AnyOfsignatureRequestsBodySignersItems
• YousignClient::Approver
• YousignClient::ApproverInfo
• YousignClient::ApproversApproverIdBody
• YousignClient::Contact
• YousignClient::ContactsBody
• YousignClient::CreateElectronicSealPayload
• YousignClient::CustomExperience
• YousignClient::CustomExperienceDisabledNotificationsType
• YousignClient::CustomExperienceInput
• YousignClient::CustomExperienceInputRedirectUrls
• YousignClient::CustomExperienceRedirectUrls
• YousignClient::CustomExperienceSource
• YousignClient::Document
• YousignClient::DocumentIdReplaceBody
• YousignClient::DocumentInitials
• YousignClient::DocumentsDocumentIdBody
• YousignClient::ElectronicSeal
• YousignClient::ElectronicSealDocumentsBody
• YousignClient::ElectronicSealImagesBody
• YousignClient::EmbeddedSignerWithSignatureLink
• YousignClient::FieldCheckbox
• YousignClient::FieldMention
• YousignClient::FieldSignature
• YousignClient::FieldText
• YousignClient::FieldsInput
• YousignClient::FieldsInputRadios
• YousignClient::InitialsArea
• YousignClient::InlineResponse200
• YousignClient::InlineResponse2001
• YousignClient::InlineResponse2002
• YousignClient::InlineResponse2003
• YousignClient::InlineResponse2004
• YousignClient::InlineResponse2004Api
• YousignClient::InlineResponse2004App
• YousignClient::InlineResponse2005
• YousignClient::InlineResponse2006
• YousignClient::InlineResponse2007
• YousignClient::InlineResponse201
• YousignClient::InlineResponse2011
• YousignClient::InlineResponse401
• YousignClient::Locale
• YousignClient::OneOfSignerFieldsItems
• YousignClient::OneOfSignerWithSignatureLinkFieldsItems
• YousignClient::OneOfWebhookSubscriptionScopes
• YousignClient::OneOfWebhookSubscriptionSubscribedEvents
• YousignClient::OneOfwebhooksBodyScopes
• YousignClient::OneOfwebhooksBodySubscribedEvents
• YousignClient::OneOfwebhooksWebhookIdBodyScopes
• YousignClient::OneOfwebhooksWebhookIdBodySubscribedEvents
• YousignClient::Pagination
• YousignClient::SignatureRequest
• YousignClient::SignatureRequestActivated
• YousignClient::SignatureRequestActivatedApprovers
• YousignClient::SignatureRequestActivatedDocuments
• YousignClient::SignatureRequestApprovers
• YousignClient::SignatureRequestDocuments
• YousignClient::SignatureRequestIdApproversBody
• YousignClient::SignatureRequestIdCancelBody
• YousignClient::SignatureRequestIdDocumentsBody
• YousignClient::SignatureRequestIdFollowersBody
• YousignClient::SignatureRequestIdReactivateBody
• YousignClient::SignatureRequestIdSignersBody
• YousignClient::SignatureRequestReminderSettings
• YousignClient::SignatureRequestSender
• YousignClient::SignatureRequestSignerFromContactIdInput
• YousignClient::SignatureRequestSignerFromInfoInput
• YousignClient::SignatureRequestSignerFromInfoInputInfo
• YousignClient::SignatureRequestSignerFromUserIdInput
• YousignClient::SignatureRequestSigners
• YousignClient::SignatureRequestsBody
• YousignClient::SignatureRequestsReminderSettings
• YousignClient::SignatureRequestsSignatureRequestIdBody
• YousignClient::SignatureRequestssignatureRequestIdReminderSettings
• YousignClient::SignatureRequestssignatureRequestIdapproversInfo
• YousignClient::SignatureRequestssignatureRequestIdapproversapproverIdInfo
• YousignClient::SignatureRequestssignatureRequestIdsignersCustomText
• YousignClient::SignatureRequestssignatureRequestIdsignersCustomText1
• YousignClient::SignatureRequestssignatureRequestIdsignersInfo
• YousignClient::SignatureRequestssignatureRequestIdsignersRedirectUrls
• YousignClient::Signer
• YousignClient::SignerCustomText
• YousignClient::SignerInfo
• YousignClient::SignerRedirectUrls
• YousignClient::SignerWithSignatureLink
• YousignClient::SignersSignerIdBody
• YousignClient::UploadDocumentInput
• YousignClient::UploadFileInput
• YousignClient::User
• YousignClient::UserWorkspaces
• YousignClient::ViolationResponse
• YousignClient::WebhookSubscription
• YousignClient::WebhooksBody
• YousignClient::WebhooksWebhookIdBody
• YousignClient::Workspace

Documentation for Authorization

bearerAuth