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

#client ⇒ Object (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_id ⇒ Object (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

#cancel ⇒ Object 



46
47
48
 
# File 'lib/hello_sign/proxy/signature_request.rb', line 46

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

#deliver(params = {}) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/hello_sign/proxy/signature_request.rb', line 14

def deliver(params = {})
  if form_id = params[:form]
    reusable_form_request_parameters.reusable_form_id = form_id
    yield reusable_form_request_parameters

    client.post(
      '/signature_request/send_with_reusable_form',
      body: reusable_form_request_parameters.formatted
    )
  else
    yield request_parameters

    client.post('/signature_request/send', body: request_parameters.formatted)
  end
end

#final_copy ⇒ Object 



50
51
52
 
# File 'lib/hello_sign/proxy/signature_request.rb', line 50

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

#list(params = {}) ⇒ Object 



34
35
36
37
38
 
# File 'lib/hello_sign/proxy/signature_request.rb', line 34

def list(params = {})
  params = {page: 1}.merge(params)

  client.get('/signature_request/list', params: params)
end

#remind(params = {}) ⇒ Object 



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

def remind(params = {})
  params = {email_address: params.delete(:email)}.merge(params)

  client.post("/signature_request/remind/#{request_id}", body: params)
end

#status ⇒ Object 



30
31
32
 
# File 'lib/hello_sign/proxy/signature_request.rb', line 30

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