Class: Formable::SignatureRequests

Inherits:
Object
  • Object
show all
Defined in:
lib/formable/resources/signature_requests.rb

Instance Method Summary collapse

Constructor Details

#initialize(http) ⇒ SignatureRequests

Returns a new instance of SignatureRequests.



5
6
7
 
# File 'lib/formable/resources/signature_requests.rb', line 5

def initialize(http)
  @http = http
end

Instance Method Details

#create(template_id:, signers:, sender: nil, test_mode: nil, fields: nil) ⇒ Object 



9
10
11
12
13
14
15
16
17
 
# File 'lib/formable/resources/signature_requests.rb', line 9

def create(template_id:, signers:, sender: nil, test_mode: nil, fields: nil)
  @http.post("/signature-requests", create_body(
    template_id: template_id,
    signers: signers,
    sender: sender,
    test_mode: test_mode,
    fields: fields
  ))
end

#create_embedded(template_id:, signers:, sender: nil, test_mode: nil, fields: nil) ⇒ Object 



19
20
21
22
23
24
25
26
27
 
# File 'lib/formable/resources/signature_requests.rb', line 19

def create_embedded(template_id:, signers:, sender: nil, test_mode: nil, fields: nil)
  @http.post("/signature-requests/embedded", create_body(
    template_id: template_id,
    signers: signers,
    sender: sender,
    test_mode: test_mode,
    fields: fields
  ))
end

#create_signing_url(recipient_signature_id) ⇒ Object 



45
46
47
 
# File 'lib/formable/resources/signature_requests.rb', line 45

def create_signing_url(recipient_signature_id)
  @http.post("/recipient-signatures/#{Params.encode_path(recipient_signature_id)}/url")
end

#get(signature_request_id) ⇒ Object 



33
34
35
 
# File 'lib/formable/resources/signature_requests.rb', line 33

def get(signature_request_id)
  @http.get(path(signature_request_id))
end

#get_events(signature_request_id) ⇒ Object 



37
38
39
 
# File 'lib/formable/resources/signature_requests.rb', line 37

def get_events(signature_request_id)
  @http.get(path(signature_request_id, "/events"))
end

#get_signed_envelope(signature_request_id) ⇒ Object 



41
42
43
 
# File 'lib/formable/resources/signature_requests.rb', line 41

def get_signed_envelope(signature_request_id)
  @http.get(path(signature_request_id, "/signed-envelope"))
end

#list(updated_since: nil) ⇒ Object 



29
30
31
 
# File 'lib/formable/resources/signature_requests.rb', line 29

def list(updated_since: nil)
  @http.get("/signature-requests", "updatedSince" => Params.iso8601(updated_since))
end