class Clicksign::Document

Public Class Methods

all() click to toggle source
# File lib/clicksign/document.rb, line 3
def self.all
  request :get,
    api_url('documents'),
    {}
end
cancel(key) click to toggle source
# File lib/clicksign/document.rb, line 39
def self.cancel(key)
  request :post,
    api_url('documents', key, 'cancel'),
    {}.to_json, content_type: 'json'
end
create(file, params = {}) click to toggle source
# File lib/clicksign/document.rb, line 15
def self.create(file, params = {})
  signers = params.delete(:signers)
  params['signers'] = [signers].flatten(1) if signers

  request :post,
    api_url('documents'),
    { "document[archive][original]" => file }.merge(params),
    {}
end
create_list(key, signers, skip_email = true) click to toggle source
# File lib/clicksign/document.rb, line 25
def self.create_list(key, signers, skip_email = true)
  request :post,
    api_url('documents', key, 'list'),
    { signers: [signers].flatten(1), skip_email: skip_email }.to_json,
    content_type: 'json'
end
download(key) click to toggle source
# File lib/clicksign/document.rb, line 45
def self.download(key)
  RestClient.get(api_url('documents', key, 'download')) do |response, request, result, &block|
    case response.code
    when 200
      response
    when 202
      nil
    else
      response.return!(request, response, &block)
    end
  end
end
find(key) click to toggle source
# File lib/clicksign/document.rb, line 9
def self.find(key)
  request :get,
    api_url('documents', key),
    {}
end
resend(key, email, message) click to toggle source
# File lib/clicksign/document.rb, line 32
def self.resend(key, email, message)
  request :post,
    api_url('documents', key, 'resend'),
    { email: email, message: message }.to_json,
    content_type: 'json'
end