Class: Docuseal::Api

Inherits:
Object
  • Object
show all
Defined in:
lib/docuseal/api.rb

Constant Summary collapse

Error = 
Class.new(StandardError)

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ Api

Returns a new instance of Api.



9
10
11
 
# File 'lib/docuseal/api.rb', line 9

def initialize(config)
  @http = Http.new(config)
end

Instance Method Details

#archive_submission(id) ⇒ Object 



93
94
95
 
# File 'lib/docuseal/api.rb', line 93

def archive_submission(id)
  http.delete("/submissions/#{id}")
end

#archive_template(id) ⇒ Object 



49
50
51
 
# File 'lib/docuseal/api.rb', line 49

def archive_template(id)
  http.delete("/templates/#{id}")
end

#clone_template(id, data) ⇒ Object 



37
38
39
 
# File 'lib/docuseal/api.rb', line 37

def clone_template(id, data)
  http.post("/templates/#{id}/clone", data)
end

#create_submission(data) ⇒ Object 



69
70
71
 
# File 'lib/docuseal/api.rb', line 69

def create_submission(data)
  http.post('/submissions/init', data)
end

#create_submission_from_docx(data) ⇒ Object 



85
86
87
 
# File 'lib/docuseal/api.rb', line 85

def create_submission_from_docx(data)
  http.post('/submissions/docx', data)
end

#create_submission_from_emails(data) ⇒ Object 



73
74
75
 
# File 'lib/docuseal/api.rb', line 73

def create_submission_from_emails(data)
  http.post('/submissions/emails', data)
end

#create_submission_from_html(data) ⇒ Object 



81
82
83
 
# File 'lib/docuseal/api.rb', line 81

def create_submission_from_html(data)
  http.post('/submissions/html', data)
end

#create_submission_from_pdf(data) ⇒ Object 



77
78
79
 
# File 'lib/docuseal/api.rb', line 77

def create_submission_from_pdf(data)
  http.post('/submissions/pdf', data)
end

#create_template_from_docx(data) ⇒ Object 



21
22
23
 
# File 'lib/docuseal/api.rb', line 21

def create_template_from_docx(data)
  http.post('/templates/docx', data)
end

#create_template_from_html(data) ⇒ Object 



25
26
27
 
# File 'lib/docuseal/api.rb', line 25

def create_template_from_html(data)
  http.post('/templates/html', data)
end

#create_template_from_pdf(data) ⇒ Object 



29
30
31
 
# File 'lib/docuseal/api.rb', line 29

def create_template_from_pdf(data)
  http.post('/templates/pdf', data)
end

#get_submission(id, params = {}) ⇒ Object 



61
62
63
 
# File 'lib/docuseal/api.rb', line 61

def get_submission(id, params = {})
  http.get("/submissions/#{id}", params)
end

#get_submission_documents(id, params = {}) ⇒ Object 



65
66
67
 
# File 'lib/docuseal/api.rb', line 65

def get_submission_documents(id, params = {})
  http.get("/submissions/#{id}/documents", params)
end

#get_submitter(id, params = {}) ⇒ Object 



105
106
107
 
# File 'lib/docuseal/api.rb', line 105

def get_submitter(id, params = {})
  http.get("/submitters/#{id}", params)
end

#get_template(id, params = {}) ⇒ Object 



17
18
19
 
# File 'lib/docuseal/api.rb', line 17

def get_template(id, params = {})
  http.get("/templates/#{id}", params)
end

#list_submissions(params = {}) ⇒ Object 



57
58
59
 
# File 'lib/docuseal/api.rb', line 57

def list_submissions(params = {})
  http.get('/submissions', params)
end

#list_submitters(params = {}) ⇒ Object 



101
102
103
 
# File 'lib/docuseal/api.rb', line 101

def list_submitters(params = {})
  http.get('/submitters', params)
end

#list_templates(params = {}) ⇒ Object 



13
14
15
 
# File 'lib/docuseal/api.rb', line 13

def list_templates(params = {})
  http.get('/templates', params)
end

#merge_templates(data) ⇒ Object 



33
34
35
 
# File 'lib/docuseal/api.rb', line 33

def merge_templates(data)
  http.post('/templates/merge', data)
end

#permanently_delete_submission(id) ⇒ Object 



97
98
99
 
# File 'lib/docuseal/api.rb', line 97

def permanently_delete_submission(id)
  http.delete("/submissions/#{id}", { permanently: true })
end

#permanently_delete_template(id) ⇒ Object 



53
54
55
 
# File 'lib/docuseal/api.rb', line 53

def permanently_delete_template(id)
  http.delete("/templates/#{id}", { permanently: true })
end

#update_submission(id, data) ⇒ Object 



89
90
91
 
# File 'lib/docuseal/api.rb', line 89

def update_submission(id, data)
  http.put("/submissions/#{id}", data)
end

#update_submitter(id, data) ⇒ Object 



109
110
111
 
# File 'lib/docuseal/api.rb', line 109

def update_submitter(id, data)
  http.put("/submitters/#{id}", data)
end

#update_template(id, data) ⇒ Object 



41
42
43
 
# File 'lib/docuseal/api.rb', line 41

def update_template(id, data)
  http.put("/templates/#{id}", data)
end

#update_template_documents(id, data) ⇒ Object 



45
46
47
 
# File 'lib/docuseal/api.rb', line 45

def update_template_documents(id, data)
  http.put("/templates/#{id}/documents", data)
end