YousignClient::SignatureUIsApi

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

Method	HTTP request	Description
signature_ui_labels_get	GET /signature_ui_labels	Get Signature UI Labels
signature_ui_labels_id_delete	DELETE /signature_ui_labels/{id}	Delete a Signature UI Label
signature_ui_labels_id_get	GET /signature_ui_labels/{id}	Find a Signature UI Label by ID
signature_ui_labels_id_put	PUT /signature_ui_labels/{id}	Update a Signature UI Label
signature_ui_labels_post	POST /signature_ui_labels	Create a new Signature UI Label
signature_uis_get	GET /signature_uis	Get Signature UI list
signature_uis_id_delete	DELETE /signature_uis/{id}	Delete a Signature UI
signature_uis_id_get	GET /signature_uis/{id}	Find a Signature UI by ID
signature_uis_id_put	PUT /signature_uis/{id}	Update a Signature UI
signature_uis_post	POST /signature_uis	Create a new Signature UI

signature_ui_labels_get

Array<SignatureUiLabelOutput> signature_ui_labels_get(opts)

Get Signature UI Labels

Only usefull if you use a filter with name or signatureUI

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::SignatureUIsApi.new

opts = { 
  name: 'name_example', # String | Filtering on name of signature ui labels
  signature_ui: 'signature_ui_example' # String | Filtering on id of signature ui resource
}

begin
  #Get Signature UI Labels
  result = api_instance.signature_ui_labels_get(opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureUIsApi->signature_ui_labels_get: #{e}"
end

Parameters

Name	Type	Description	Notes
name	String	Filtering on name of signature ui labels	[optional]
signature_ui	String	Filtering on id of signature ui resource	[optional]

Return type

Array<SignatureUiLabelOutput>

Authorization

api_key

HTTP request headers

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

signature_ui_labels_id_delete

signature_ui_labels_id_delete(id, opts)

Delete a Signature UI Label

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::SignatureUIsApi.new

id = 'id_example' # String | 

opts = { 
  id2: '/signature_ui_labels/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' # String | Id of signature ui label
}

begin
  #Delete a Signature UI Label
  api_instance.signature_ui_labels_id_delete(id, opts)
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureUIsApi->signature_ui_labels_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String
id2	String	Id of signature ui label	[optional]

Return type

nil (empty response body)

Authorization

api_key

HTTP request headers

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

signature_ui_labels_id_get

SignatureUiLabelOutput signature_ui_labels_id_get(id, opts)

Find a Signature UI Label 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::SignatureUIsApi.new

id = 'id_example' # String | 

opts = { 
  id2: '/signature_ui_labels/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' # String | id of signature ui label
}

begin
  #Find a Signature UI Label by ID
  result = api_instance.signature_ui_labels_id_get(id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureUIsApi->signature_ui_labels_id_get: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String
id2	String	id of signature ui label	[optional]

Return type

SignatureUiLabelOutput

Authorization

api_key

HTTP request headers

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

signature_ui_labels_id_put

SignatureUiLabelOutput signature_ui_labels_id_put(idbody, opts)

Update a Signature UI Label

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::SignatureUIsApi.new

id = 'id_example' # String | 

body = YousignClient::SignatureUiLabelInput.new # SignatureUiLabelInput | 

opts = { 
  id2: '/signature_ui_labels/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' # String | Id of signature ui labels
}

begin
  #Update a Signature UI Label
  result = api_instance.signature_ui_labels_id_put(idbody, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureUIsApi->signature_ui_labels_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String
body	SignatureUiLabelInput
id2	String	Id of signature ui labels	[optional]

Return type

SignatureUiLabelOutput

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

signature_ui_labels_post

SignatureUiLabelOutput signature_ui_labels_post(body)

Create a new Signature UI Label

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::SignatureUIsApi.new

body = YousignClient::SignatureUiLabelInput.new # SignatureUiLabelInput | 


begin
  #Create a new Signature UI Label
  result = api_instance.signature_ui_labels_post(body)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureUIsApi->signature_ui_labels_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	SignatureUiLabelInput

Return type

SignatureUiLabelOutput

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

signature_uis_get

Array<SignatureUiOutput> signature_uis_get

Get Signature UI 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::SignatureUIsApi.new

begin
  #Get Signature UI list
  result = api_instance.signature_uis_get
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureUIsApi->signature_uis_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Array<SignatureUiOutput>

Authorization

api_key

HTTP request headers

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

signature_uis_id_delete

signature_uis_id_delete(id, opts)

Delete a Signature UI

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::SignatureUIsApi.new

id = 'id_example' # String | 

opts = { 
  id2: '/signature_uis/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' # String | Id of the signature ui
}

begin
  #Delete a Signature UI
  api_instance.signature_uis_id_delete(id, opts)
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureUIsApi->signature_uis_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String
id2	String	Id of the signature ui	[optional]

Return type

nil (empty response body)

Authorization

api_key

HTTP request headers

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

signature_uis_id_get

SignatureUiOutput signature_uis_id_get(id, opts)

Find a Signature UI 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::SignatureUIsApi.new

id = 'id_example' # String | 

opts = { 
  id2: '/signature_uis/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' # String | id of a signature ui
}

begin
  #Find a Signature UI by ID
  result = api_instance.signature_uis_id_get(id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureUIsApi->signature_uis_id_get: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String
id2	String	id of a signature ui	[optional]

Return type

SignatureUiOutput

Authorization

api_key

HTTP request headers

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

signature_uis_id_put

SignatureUiInputUpdate signature_uis_id_put(id, opts)

Update a Signature UI

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::SignatureUIsApi.new

id = 'id_example' # String | 

opts = { 
  id2: '/signature_uis/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' # String | id of signature ui to update
}

begin
  #Update a Signature UI
  result = api_instance.signature_uis_id_put(id, opts)
  p result
rescue YousignClient::ApiError => e
  puts "Exception when calling SignatureUIsApi->signature_uis_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String
id2	String	id of signature ui to update	[optional]

Return type

SignatureUiInputUpdate

Authorization

api_key

HTTP request headers

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

signature_uis_post

SignatureUiOutput signature_uis_post(body)

Create a new Signature UI

Here is the url format to build on your side to get a custom signature interface with your settings : https://webapp.yousign.com/procedure/sign?members=~2Fmembers~2F__MEMBER_ID__&signatureUi=~2Fsignature_uis~2F__SIGNATURE_UI_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::SignatureUIsApi.new

body = YousignClient::SignatureUiInput.new # SignatureUiInput | 


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

Parameters

Name	Type	Description	Notes
body	SignatureUiInput

Return type

SignatureUiOutput

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

Files

SignatureUIsApi.md

Latest commit

History

SignatureUIsApi.md

File metadata and controls

YousignClient::SignatureUIsApi

signature_ui_labels_get

Example

Parameters

Return type

Authorization

HTTP request headers

signature_ui_labels_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

signature_ui_labels_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

signature_ui_labels_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

signature_ui_labels_post

Example

Parameters

Return type

Authorization

HTTP request headers

signature_uis_get

Example

Parameters

Return type

Authorization

HTTP request headers

signature_uis_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

signature_uis_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

signature_uis_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

signature_uis_post

Example

Parameters

Return type

Authorization

HTTP request headers