class YousignClient::SignatureUIsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/yousign_client/api/signature_u_is_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

signature_ui_labels_get(opts = {}) click to toggle source

Get Signature UI Labels Only usefull if you use a filter with name or signatureUI @param [Hash] opts the optional parameters @option opts [String] :name Filtering on name of signature ui labels @option opts [String] :signature_ui Filtering on id of signature ui resource @return [Array<SignatureUiLabelOutput>]

# File lib/yousign_client/api/signature_u_is_api.rb, line 28
def signature_ui_labels_get(opts = {})
  data, _status_code, _headers = signature_ui_labels_get_with_http_info(opts)
  data
end
signature_ui_labels_get_with_http_info(opts = {}) click to toggle source

Get Signature UI Labels Only usefull if you use a filter with name or signatureUI @param [Hash] opts the optional parameters @option opts [String] :name Filtering on name of signature ui labels @option opts [String] :signature_ui Filtering on id of signature ui resource @return [Array<(Array<SignatureUiLabelOutput>, Fixnum, Hash)>] Array<SignatureUiLabelOutput> data, response status code and response headers

# File lib/yousign_client/api/signature_u_is_api.rb, line 39
def signature_ui_labels_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_ui_labels_get ...'
  end
  # resource path
  local_var_path = '/signature_ui_labels'

  # query parameters
  query_params = {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'signatureUi'] = opts[:'signature_ui'] if !opts[:'signature_ui'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<SignatureUiLabelOutput>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureUIsApi#signature_ui_labels_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
signature_ui_labels_id_delete(id, opts = {}) click to toggle source

Delete a Signature UI Label @param id @param [Hash] opts the optional parameters @option opts [String] :id2 Id of signature ui label @return [nil]

# File lib/yousign_client/api/signature_u_is_api.rb, line 81
def signature_ui_labels_id_delete(id, opts = {})
  signature_ui_labels_id_delete_with_http_info(id, opts)
  nil
end
signature_ui_labels_id_delete_with_http_info(id, opts = {}) click to toggle source

Delete a Signature UI Label @param id @param [Hash] opts the optional parameters @option opts [String] :id2 Id of signature ui label @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/yousign_client/api/signature_u_is_api.rb, line 91
def signature_ui_labels_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_ui_labels_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SignatureUIsApi.signature_ui_labels_id_delete"
  end
  # resource path
  local_var_path = '/signature_ui_labels/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id2'] if !opts[:'id2'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureUIsApi#signature_ui_labels_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
signature_ui_labels_id_get(id, opts = {}) click to toggle source

Find a Signature UI Label by ID @param id @param [Hash] opts the optional parameters @option opts [String] :id2 id of signature ui label @return [SignatureUiLabelOutput]

# File lib/yousign_client/api/signature_u_is_api.rb, line 135
def signature_ui_labels_id_get(id, opts = {})
  data, _status_code, _headers = signature_ui_labels_id_get_with_http_info(id, opts)
  data
end
signature_ui_labels_id_get_with_http_info(id, opts = {}) click to toggle source

Find a Signature UI Label by ID @param id @param [Hash] opts the optional parameters @option opts [String] :id2 id of signature ui label @return [Array<(SignatureUiLabelOutput, Fixnum, Hash)>] SignatureUiLabelOutput data, response status code and response headers

# File lib/yousign_client/api/signature_u_is_api.rb, line 145
def signature_ui_labels_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_ui_labels_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SignatureUIsApi.signature_ui_labels_id_get"
  end
  # resource path
  local_var_path = '/signature_ui_labels/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id2'] if !opts[:'id2'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SignatureUiLabelOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureUIsApi#signature_ui_labels_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
signature_ui_labels_id_put(id, body, opts = {}) click to toggle source

Update a Signature UI Label @param id @param body @param [Hash] opts the optional parameters @option opts [String] :id2 Id of signature ui labels @return [SignatureUiLabelOutput]

# File lib/yousign_client/api/signature_u_is_api.rb, line 191
def signature_ui_labels_id_put(id, body, opts = {})
  data, _status_code, _headers = signature_ui_labels_id_put_with_http_info(id, body, opts)
  data
end
signature_ui_labels_id_put_with_http_info(id, body, opts = {}) click to toggle source

Update a Signature UI Label @param id @param body @param [Hash] opts the optional parameters @option opts [String] :id2 Id of signature ui labels @return [Array<(SignatureUiLabelOutput, Fixnum, Hash)>] SignatureUiLabelOutput data, response status code and response headers

# File lib/yousign_client/api/signature_u_is_api.rb, line 202
def signature_ui_labels_id_put_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_ui_labels_id_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SignatureUIsApi.signature_ui_labels_id_put"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling SignatureUIsApi.signature_ui_labels_id_put"
  end
  # resource path
  local_var_path = '/signature_ui_labels/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id2'] if !opts[:'id2'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SignatureUiLabelOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureUIsApi#signature_ui_labels_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
signature_ui_labels_post(body, opts = {}) click to toggle source

Create a new Signature UI Label @param body @param [Hash] opts the optional parameters @return [SignatureUiLabelOutput]

# File lib/yousign_client/api/signature_u_is_api.rb, line 248
def signature_ui_labels_post(body, opts = {})
  data, _status_code, _headers = signature_ui_labels_post_with_http_info(body, opts)
  data
end
signature_ui_labels_post_with_http_info(body, opts = {}) click to toggle source

Create a new Signature UI Label @param body @param [Hash] opts the optional parameters @return [Array<(SignatureUiLabelOutput, Fixnum, Hash)>] SignatureUiLabelOutput data, response status code and response headers

# File lib/yousign_client/api/signature_u_is_api.rb, line 257
def signature_ui_labels_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_ui_labels_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling SignatureUIsApi.signature_ui_labels_post"
  end
  # resource path
  local_var_path = '/signature_ui_labels'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SignatureUiLabelOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureUIsApi#signature_ui_labels_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
signature_uis_get(opts = {}) click to toggle source

Get Signature UI list @param [Hash] opts the optional parameters @return [Array<SignatureUiOutput>]

# File lib/yousign_client/api/signature_u_is_api.rb, line 297
def signature_uis_get(opts = {})
  data, _status_code, _headers = signature_uis_get_with_http_info(opts)
  data
end
signature_uis_get_with_http_info(opts = {}) click to toggle source

Get Signature UI list @param [Hash] opts the optional parameters @return [Array<(Array<SignatureUiOutput>, Fixnum, Hash)>] Array<SignatureUiOutput> data, response status code and response headers

# File lib/yousign_client/api/signature_u_is_api.rb, line 305
def signature_uis_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_uis_get ...'
  end
  # resource path
  local_var_path = '/signature_uis'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<SignatureUiOutput>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureUIsApi#signature_uis_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
signature_uis_id_delete(id, opts = {}) click to toggle source

Delete a Signature UI @param id @param [Hash] opts the optional parameters @option opts [String] :id2 Id of the signature ui @return [nil]

# File lib/yousign_client/api/signature_u_is_api.rb, line 345
def signature_uis_id_delete(id, opts = {})
  signature_uis_id_delete_with_http_info(id, opts)
  nil
end
signature_uis_id_delete_with_http_info(id, opts = {}) click to toggle source

Delete a Signature UI @param id @param [Hash] opts the optional parameters @option opts [String] :id2 Id of the signature ui @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/yousign_client/api/signature_u_is_api.rb, line 355
def signature_uis_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_uis_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SignatureUIsApi.signature_uis_id_delete"
  end
  # resource path
  local_var_path = '/signature_uis/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id2'] if !opts[:'id2'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureUIsApi#signature_uis_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
signature_uis_id_get(id, opts = {}) click to toggle source

Find a Signature UI by ID @param id @param [Hash] opts the optional parameters @option opts [String] :id2 id of a signature ui @return [SignatureUiOutput]

# File lib/yousign_client/api/signature_u_is_api.rb, line 399
def signature_uis_id_get(id, opts = {})
  data, _status_code, _headers = signature_uis_id_get_with_http_info(id, opts)
  data
end
signature_uis_id_get_with_http_info(id, opts = {}) click to toggle source

Find a Signature UI by ID @param id @param [Hash] opts the optional parameters @option opts [String] :id2 id of a signature ui @return [Array<(SignatureUiOutput, Fixnum, Hash)>] SignatureUiOutput data, response status code and response headers

# File lib/yousign_client/api/signature_u_is_api.rb, line 409
def signature_uis_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_uis_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SignatureUIsApi.signature_uis_id_get"
  end
  # resource path
  local_var_path = '/signature_uis/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id2'] if !opts[:'id2'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SignatureUiOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureUIsApi#signature_uis_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
signature_uis_id_put(id, opts = {}) click to toggle source

Update a Signature UI @param id @param [Hash] opts the optional parameters @option opts [String] :id2 id of signature ui to update @return [SignatureUiInputUpdate]

# File lib/yousign_client/api/signature_u_is_api.rb, line 454
def signature_uis_id_put(id, opts = {})
  data, _status_code, _headers = signature_uis_id_put_with_http_info(id, opts)
  data
end
signature_uis_id_put_with_http_info(id, opts = {}) click to toggle source

Update a Signature UI @param id @param [Hash] opts the optional parameters @option opts [String] :id2 id of signature ui to update @return [Array<(SignatureUiInputUpdate, Fixnum, Hash)>] SignatureUiInputUpdate data, response status code and response headers

# File lib/yousign_client/api/signature_u_is_api.rb, line 464
def signature_uis_id_put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_uis_id_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SignatureUIsApi.signature_uis_id_put"
  end
  # resource path
  local_var_path = '/signature_uis/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id2'] if !opts[:'id2'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SignatureUiInputUpdate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureUIsApi#signature_uis_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
signature_uis_post(body, opts = {}) click to toggle source

Create a new Signature UI Here is the url format to build on your side to get a custom signature interface with your settings : webapp.yousign.com/procedure/sign?members=~2Fmembers~2F_MEMBER_ID_&signatureUi=~2Fsignature_uis~2F_SIGNATURE_UI_ID_ @param body @param [Hash] opts the optional parameters @return [SignatureUiOutput]

# File lib/yousign_client/api/signature_u_is_api.rb, line 509
def signature_uis_post(body, opts = {})
  data, _status_code, _headers = signature_uis_post_with_http_info(body, opts)
  data
end
signature_uis_post_with_http_info(body, opts = {}) click to toggle source

Create a new Signature UI Here is the url format to build on your side to get a custom signature interface with your settings : webapp.yousign.com/procedure/sign?members=~2Fmembers~2F_MEMBER_ID_&signatureUi=~2Fsignature_uis~2F_SIGNATURE_UI_ID_ @param body @param [Hash] opts the optional parameters @return [Array<(SignatureUiOutput, Fixnum, Hash)>] SignatureUiOutput data, response status code and response headers

# File lib/yousign_client/api/signature_u_is_api.rb, line 519
def signature_uis_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignatureUIsApi.signature_uis_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling SignatureUIsApi.signature_uis_post"
  end
  # resource path
  local_var_path = '/signature_uis'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SignatureUiOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignatureUIsApi#signature_uis_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end