Skip to content

Latest commit

 

History

History
290 lines (192 loc) · 6.94 KB

SignrequestsApi.md

File metadata and controls

290 lines (192 loc) · 6.94 KB
Raw

SignRequestClient::SignrequestsApi

All URIs are relative to https://signrequest.com/api/v1

Method HTTP request Description
signrequests_cancel_signrequest POST /signrequests/{uuid}/cancel_signrequest/ Cancel a SignRequest
signrequests_create POST /signrequests/ Create a SignRequest
signrequests_list GET /signrequests/ Retrieve a list of SignRequests
signrequests_read GET /signrequests/{uuid}/ Retrieve a SignRequest
signrequests_resend_signrequest_email POST /signrequests/{uuid}/resend_signrequest_email/ Resend a SignRequest

signrequests_cancel_signrequest

InlineResponse201 signrequests_cancel_signrequest(uuid)

Cancel a SignRequest

Example

# load the gem
require 'signrequest_client'
# setup authorization
SignRequestClient.configure do |config|
  # Configure API key authorization: Token
  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 = SignRequestClient::SignrequestsApi.new

uuid = 'uuid_example' # String | 


begin
  #Cancel a SignRequest
  result = api_instance.signrequests_cancel_signrequest(uuid)
  p result
rescue SignRequestClient::ApiError => e
  puts "Exception when calling SignrequestsApi->signrequests_cancel_signrequest: #{e}"
end

Parameters

Name Type Description Notes
uuid String

Return type

InlineResponse201

Authorization

Token

HTTP request headers

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

signrequests_create

SignRequest signrequests_create(data)

Create a SignRequest

Example

# load the gem
require 'signrequest_client'
# setup authorization
SignRequestClient.configure do |config|
  # Configure API key authorization: Token
  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 = SignRequestClient::SignrequestsApi.new

data = SignRequestClient::SignRequest.new # SignRequest | 


begin
  #Create a SignRequest
  result = api_instance.signrequests_create(data)
  p result
rescue SignRequestClient::ApiError => e
  puts "Exception when calling SignrequestsApi->signrequests_create: #{e}"
end

Parameters

Name Type Description Notes
data SignRequest

Return type

SignRequest

Authorization

Token

HTTP request headers

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

signrequests_list

InlineResponse2005 signrequests_list(opts)

Retrieve a list of SignRequests

Example

# load the gem
require 'signrequest_client'
# setup authorization
SignRequestClient.configure do |config|
  # Configure API key authorization: Token
  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 = SignRequestClient::SignrequestsApi.new

opts = { 
  who: 'who_example', # String | 
  from_email: 'from_email_example', # String | 
  page: 56, # Integer | A page number within the paginated result set.
  limit: 56 # Integer | Number of results to return per page.
}

begin
  #Retrieve a list of SignRequests
  result = api_instance.signrequests_list(opts)
  p result
rescue SignRequestClient::ApiError => e
  puts "Exception when calling SignrequestsApi->signrequests_list: #{e}"
end

Parameters

Name Type Description Notes
who String [optional]
from_email String [optional]
page Integer A page number within the paginated result set. [optional]
limit Integer Number of results to return per page. [optional]

Return type

InlineResponse2005

Authorization

Token

HTTP request headers

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

signrequests_read

SignRequest signrequests_read(uuid)

Retrieve a SignRequest

Example

# load the gem
require 'signrequest_client'
# setup authorization
SignRequestClient.configure do |config|
  # Configure API key authorization: Token
  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 = SignRequestClient::SignrequestsApi.new

uuid = 'uuid_example' # String | 


begin
  #Retrieve a SignRequest
  result = api_instance.signrequests_read(uuid)
  p result
rescue SignRequestClient::ApiError => e
  puts "Exception when calling SignrequestsApi->signrequests_read: #{e}"
end

Parameters

Name Type Description Notes
uuid String

Return type

SignRequest

Authorization

Token

HTTP request headers

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

signrequests_resend_signrequest_email

InlineResponse2011 signrequests_resend_signrequest_email(uuid)

Resend a SignRequest

Example

# load the gem
require 'signrequest_client'
# setup authorization
SignRequestClient.configure do |config|
  # Configure API key authorization: Token
  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 = SignRequestClient::SignrequestsApi.new

uuid = 'uuid_example' # String | 


begin
  #Resend a SignRequest
  result = api_instance.signrequests_resend_signrequest_email(uuid)
  p result
rescue SignRequestClient::ApiError => e
  puts "Exception when calling SignrequestsApi->signrequests_resend_signrequest_email: #{e}"
end

Parameters

Name Type Description Notes
uuid String

Return type

InlineResponse2011

Authorization

Token

HTTP request headers

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