Class: HelloSign::Proxy::SignatureRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/hello_sign/proxy/signature_request.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client, request_id) ⇒ SignatureRequest

Returns a new instance of SignatureRequest.



9
10
11
12
# File 'lib/hello_sign/proxy/signature_request.rb', line 9

def initialize(client, request_id)
  @client     = client
  @request_id = request_id
end

Instance Attribute Details

#clientObject (readonly)

Returns the value of attribute client.



7
8
9
# File 'lib/hello_sign/proxy/signature_request.rb', line 7

def client
  @client
end

#request_idObject (readonly)

Returns the value of attribute request_id.



7
8
9
# File 'lib/hello_sign/proxy/signature_request.rb', line 7

def request_id
  @request_id
end

Instance Method Details

#cancelObject



38
39
40
# File 'lib/hello_sign/proxy/signature_request.rb', line 38

def cancel
  client.post("/signature_request/cancel/#{request_id}")
end

#deliver(params = {}, &block) ⇒ Object



14
15
16
17
18
19
20
# File 'lib/hello_sign/proxy/signature_request.rb', line 14

def deliver(params = {}, &block)
  if form_id = params[:form]
    deliver_request_with_form(form_id, &block)
  else
    deliver_request(&block)
  end
end

#final_copyObject



42
43
44
# File 'lib/hello_sign/proxy/signature_request.rb', line 42

def final_copy
  client.get("/signature_request/final_copy/#{request_id}")
end

#list(params = {}) ⇒ Object



26
27
28
29
# File 'lib/hello_sign/proxy/signature_request.rb', line 26

def list(params = {})
  client.get('/signature_request/list', params: {page: 1}.merge(params))

end

#remind(params = {}) ⇒ Object



31
32
33
34
35
36
# File 'lib/hello_sign/proxy/signature_request.rb', line 31

def remind(params = {})
  client.post(
    "/signature_request/remind/#{request_id}",
    body: {email_address: params.delete(:email)}.merge(params)
  )
end

#statusObject



22
23
24
# File 'lib/hello_sign/proxy/signature_request.rb', line 22

def status
  client.get("/signature_request/#{request_id}")
end