Class: Boldsign::Resources::Template

Inherits:
Boldsign::Resource show all
Defined in:
lib/boldsign/resources/template.rb

Overview

Template endpoints (‘/v1/template/*`) — create, send, edit, and embed reusable signing templates.

See Also:

Instance Method Summary collapse

Methods inherited from Boldsign::Resource

#initialize

Constructor Details

This class inherits a constructor from Boldsign::Resource

Instance Method Details

#add_tags(body) ⇒ Object 



33
 
# File 'lib/boldsign/resources/template.rb', line 33

def add_tags(body);    @client.patch("/v1/template/addTags", body: body); end

#create(body) ⇒ Object 



12
 
# File 'lib/boldsign/resources/template.rb', line 12

def create(body);            @client.post("/v1/template/create", body: body); end

#create_embedded_preview_url(body) ⇒ Object 



29
30
31
 
# File 'lib/boldsign/resources/template.rb', line 29

def create_embedded_preview_url(body)
  @client.post("/v1/template/createEmbeddedPreviewUrl", body: body)
end

#create_embedded_request_url(template_id, body) ⇒ Object 



23
24
25
 
# File 'lib/boldsign/resources/template.rb', line 23

def create_embedded_request_url(template_id, body)
  @client.post("/v1/template/createEmbeddedRequestUrl", body: body, params: { templateId: template_id })
end

#create_embedded_template_url(body) ⇒ Object 



21
 
# File 'lib/boldsign/resources/template.rb', line 21

def create_embedded_template_url(body); @client.post("/v1/template/createEmbeddedTemplateUrl", body: body); end

#delete(template_id) ⇒ Object 



14
 
# File 'lib/boldsign/resources/template.rb', line 14

def delete(template_id);     @client.delete("/v1/template/delete", templateId: template_id); end

#delete_tags(body) ⇒ Object 



34
 
# File 'lib/boldsign/resources/template.rb', line 34

def delete_tags(body); @client.delete("/v1/template/deleteTags", body: body); end

#download(template_id) ⇒ Object 



10
 
# File 'lib/boldsign/resources/template.rb', line 10

def download(template_id);   @client.download("/v1/template/download", templateId: template_id); end

#edit(template_id, body) ⇒ Object 



13
 
# File 'lib/boldsign/resources/template.rb', line 13

def edit(template_id, body); @client.put("/v1/template/edit", body: body, params: { templateId: template_id }); end

#get_embedded_template_edit_url(body) ⇒ Object 



22
 
# File 'lib/boldsign/resources/template.rb', line 22

def get_embedded_template_edit_url(body); @client.post("/v1/template/getEmbeddedTemplateEditUrl", body: body); end

#list(**params) ⇒ Object 



8
 
# File 'lib/boldsign/resources/template.rb', line 8

def list(**params);          @client.get("/v1/template/list", params); end

#merge_and_send(body) ⇒ Object 



19
 
# File 'lib/boldsign/resources/template.rb', line 19

def merge_and_send(body); @client.post("/v1/template/mergeAndSend", body: body); end

#merge_create_embedded_request_url(body) ⇒ Object 



26
27
28
 
# File 'lib/boldsign/resources/template.rb', line 26

def merge_create_embedded_request_url(body)
  @client.post("/v1/template/mergeCreateEmbeddedRequestUrl", body: body)
end

#properties(template_id) ⇒ Object 



9
 
# File 'lib/boldsign/resources/template.rb', line 9

def properties(template_id); @client.get("/v1/template/properties", templateId: template_id); end

#send_template(template_id, body) ⇒ Object 



16
17
18
 
# File 'lib/boldsign/resources/template.rb', line 16

def send_template(template_id, body)
  @client.post("/v1/template/send", body: body, params: { templateId: template_id })
end