Skip to content

Latest commit

 

History

History
2842 lines (2039 loc) · 73.4 KB

PDFApi.md

File metadata and controls

2842 lines (2039 loc) · 73.4 KB

DocSpring::PDFApi

All URIs are relative to https://api.docspring.com/api/v1

Method HTTP request Description
add_fields_to_template PUT /templates/{template_id}/add_fields Add new fields to a Template
batch_generate_pdf_v1 POST /templates/{template_id}/submissions/batch Generates multiple PDFs
batch_generate_pdfs POST /submissions/batches Generates multiple PDFs
combine_pdfs POST /combined_submissions?v=2 Merge submission PDFs, template PDFs, or custom files
combine_submissions POST /combined_submissions Merge generated PDFs together
copy_template POST /templates/{template_id}/copy Copy a Template
create_custom_file_from_upload POST /custom_files Create a new custom file from a cached presign upload
create_data_request_event POST /data_requests/{data_request_id}/events Creates a new event for emailing a signee a request for signature
create_data_request_token POST /data_requests/{data_request_id}/tokens Creates a new data request token for form authentication
create_folder POST /folders/ Create a folder
create_html_template POST /templates?desc=html Create a new HTML template
create_pdf_template POST /templates Create a new PDF template with a form POST file upload
create_pdf_template_from_upload POST /templates?desc=cached_upload Create a new PDF template from a cached presign upload
delete_folder DELETE /folders/{folder_id} Delete a folder
delete_template DELETE /templates/{template_id} Delete a template
expire_combined_submission DELETE /combined_submissions/{combined_submission_id} Expire a combined submission
expire_submission DELETE /submissions/{submission_id} Expire a PDF submission
generate_pdf POST /templates/{template_id}/submissions Generates a new PDF
generate_preview POST /submissions/{submission_id}/generate_preview Generated a preview PDF for partially completed data requests
get_combined_submission GET /combined_submissions/{combined_submission_id} Check the status of a combined submission (merged PDFs)
get_data_request GET /data_requests/{data_request_id} Look up a submission data request
get_full_template GET /templates/{template_id}?full=true Fetch the full template attributes
get_presign_url GET /uploads/presign Get a presigned URL so that you can upload a file to our AWS S3 bucket
get_submission GET /submissions/{submission_id} Check the status of a PDF
get_submission_batch GET /submissions/batches/{submission_batch_id} Check the status of a submission batch job
get_template GET /templates/{template_id} Check the status of an uploaded template
get_template_schema GET /templates/{template_id}/schema Fetch the JSON schema for a template
list_combined_submissions GET /combined_submissions Get a list of all combined submissions
list_folders GET /folders/ Get a list of all folders
list_submissions GET /submissions List all submissions
list_template_submissions GET /templates/{template_id}/submissions List all submissions for a given template
list_templates GET /templates Get a list of all templates
move_folder_to_folder POST /folders/{folder_id}/move Move a folder
move_template_to_folder POST /templates/{template_id}/move Move Template to folder
publish_template_version POST /templates/{template_id}/publish_version Publish a template version
rename_folder POST /folders/{folder_id}/rename Rename a folder
restore_template_version POST /templates/{template_id}/restore_version Restore a template version
test_authentication GET /authentication Test Authentication
update_data_request PUT /data_requests/{data_request_id} Update a submission data request
update_template PUT /templates/{template_id} Update a Template

add_fields_to_template

add_fields_to_template(template_id, data)

Add new fields to a Template

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
template_id = 'tpl_000000000000000002' # String | 
data = DocSpring::AddFieldsData.new({fields: [3.56]}) # AddFieldsData | 

begin
  # Add new fields to a Template
  result = api_instance.add_fields_to_template(template_id, data)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->add_fields_to_template: #{e}"
end

Using the add_fields_to_template_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> add_fields_to_template_with_http_info(template_id, data)

begin
  # Add new fields to a Template
  data, status_code, headers = api_instance.add_fields_to_template_with_http_info(template_id, data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AddFieldsTemplateResponse>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->add_fields_to_template_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
template_id String
data AddFieldsData

Return type

AddFieldsTemplateResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

batch_generate_pdf_v1

<Array> batch_generate_pdf_v1(template_id, data)

Generates multiple PDFs

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
template_id = 'tpl_000000000000000001' # String | 
data = [DocSpring::SubmissionData.new({data: 3.56})] # Array<SubmissionData> | 

begin
  # Generates multiple PDFs
  result = api_instance.batch_generate_pdf_v1(template_id, data)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->batch_generate_pdf_v1: #{e}"
end

Using the batch_generate_pdf_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> batch_generate_pdf_v1_with_http_info(template_id, data)

begin
  # Generates multiple PDFs
  data, status_code, headers = api_instance.batch_generate_pdf_v1_with_http_info(template_id, data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<CreateSubmissionResponse>>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->batch_generate_pdf_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
template_id String
data Array<SubmissionData>

Return type

Array<CreateSubmissionResponse>

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

batch_generate_pdfs

batch_generate_pdfs(data)

Generates multiple PDFs

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
data = DocSpring::SubmissionBatchData.new({submissions: [DocSpring::SubmissionDataBatchRequest.new({data: 3.56, template_id: 'template_id_example'})]}) # SubmissionBatchData | 

begin
  # Generates multiple PDFs
  result = api_instance.batch_generate_pdfs(data)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->batch_generate_pdfs: #{e}"
end

Using the batch_generate_pdfs_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> batch_generate_pdfs_with_http_info(data)

begin
  # Generates multiple PDFs
  data, status_code, headers = api_instance.batch_generate_pdfs_with_http_info(data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CreateSubmissionBatchResponse>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->batch_generate_pdfs_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
data SubmissionBatchData

Return type

CreateSubmissionBatchResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

combine_pdfs

combine_pdfs(data)

Merge submission PDFs, template PDFs, or custom files

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
data = DocSpring::CombinePdfsData.new({source_pdfs: [3.56]}) # CombinePdfsData | 

begin
  # Merge submission PDFs, template PDFs, or custom files
  result = api_instance.combine_pdfs(data)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->combine_pdfs: #{e}"
end

Using the combine_pdfs_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> combine_pdfs_with_http_info(data)

begin
  # Merge submission PDFs, template PDFs, or custom files
  data, status_code, headers = api_instance.combine_pdfs_with_http_info(data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CreateCombinedSubmissionResponse>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->combine_pdfs_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
data CombinePdfsData

Return type

CreateCombinedSubmissionResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

combine_submissions

combine_submissions(data)

Merge generated PDFs together

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
data = DocSpring::CombinedSubmissionData.new({submission_ids: ['submission_ids_example']}) # CombinedSubmissionData | 

begin
  # Merge generated PDFs together
  result = api_instance.combine_submissions(data)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->combine_submissions: #{e}"
end

Using the combine_submissions_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> combine_submissions_with_http_info(data)

begin
  # Merge generated PDFs together
  data, status_code, headers = api_instance.combine_submissions_with_http_info(data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CreateCombinedSubmissionResponse>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->combine_submissions_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
data CombinedSubmissionData

Return type

CreateCombinedSubmissionResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

copy_template

copy_template(template_id, data)

Copy a Template

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
template_id = 'tpl_000000000000000001' # String | 
data = DocSpring::CopyTemplateData.new({parent_folder_id: 'parent_folder_id_example'}) # CopyTemplateData | 

begin
  # Copy a Template
  result = api_instance.copy_template(template_id, data)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->copy_template: #{e}"
end

Using the copy_template_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> copy_template_with_http_info(template_id, data) 

begin
  # Copy a Template
  data, status_code, headers = api_instance.copy_template_with_http_info(template_id, data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Template>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->copy_template_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
template_id String
data CopyTemplateData

Return type

Template

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

create_custom_file_from_upload

create_custom_file_from_upload(data)

Create a new custom file from a cached presign upload

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
data = DocSpring::CreateCustomFileData.new({cache_id: 'cache_id_example'}) # CreateCustomFileData | 

begin
  # Create a new custom file from a cached presign upload
  result = api_instance.create_custom_file_from_upload(data)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->create_custom_file_from_upload: #{e}"
end

Using the create_custom_file_from_upload_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_custom_file_from_upload_with_http_info(data)

begin
  # Create a new custom file from a cached presign upload
  data, status_code, headers = api_instance.create_custom_file_from_upload_with_http_info(data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CreateCustomFileResponse>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->create_custom_file_from_upload_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
data CreateCustomFileData

Return type

CreateCustomFileResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

create_data_request_event

create_data_request_event(data_request_id, event)

Creates a new event for emailing a signee a request for signature

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
data_request_id = 'drq_000000000000000001' # String | 
event = DocSpring::CreateSubmissionDataRequestEventRequest.new({event_type: 'send_request'}) # CreateSubmissionDataRequestEventRequest | 

begin
  # Creates a new event for emailing a signee a request for signature
  result = api_instance.create_data_request_event(data_request_id, event)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->create_data_request_event: #{e}"
end

Using the create_data_request_event_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_data_request_event_with_http_info(data_request_id, event)

begin
  # Creates a new event for emailing a signee a request for signature
  data, status_code, headers = api_instance.create_data_request_event_with_http_info(data_request_id, event)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CreateSubmissionDataRequestEventResponse>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->create_data_request_event_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
data_request_id String
event CreateSubmissionDataRequestEventRequest

Return type

CreateSubmissionDataRequestEventResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

create_data_request_token

create_data_request_token(data_request_id)

Creates a new data request token for form authentication

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
data_request_id = 'drq_000000000000000001' # String | 

begin
  # Creates a new data request token for form authentication
  result = api_instance.create_data_request_token(data_request_id)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->create_data_request_token: #{e}"
end

Using the create_data_request_token_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_data_request_token_with_http_info(data_request_id)

begin
  # Creates a new data request token for form authentication
  data, status_code, headers = api_instance.create_data_request_token_with_http_info(data_request_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CreateSubmissionDataRequestTokenResponse>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->create_data_request_token_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
data_request_id String

Return type

CreateSubmissionDataRequestTokenResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

create_folder

create_folder(data)

Create a folder

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
data = DocSpring::CreateFolderData.new({folder: DocSpring::CreateFolderAttributes.new({name: 'name_example'})}) # CreateFolderData | 

begin
  # Create a folder
  result = api_instance.create_folder(data)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->create_folder: #{e}"
end

Using the create_folder_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_folder_with_http_info(data)

begin
  # Create a folder
  data, status_code, headers = api_instance.create_folder_with_http_info(data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Folder>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->create_folder_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
data CreateFolderData

Return type

Folder

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

create_html_template

create_html_template(data)

Create a new HTML template

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
data = DocSpring::CreateHtmlTemplateData.new({template: DocSpring::HtmlTemplateData.new({name: 'name_example'})}) # CreateHtmlTemplateData | 

begin
  # Create a new HTML template
  result = api_instance.create_html_template(data)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->create_html_template: #{e}"
end

Using the create_html_template_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_html_template_with_http_info(data)

begin
  # Create a new HTML template
  data, status_code, headers = api_instance.create_html_template_with_http_info(data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PendingTemplate>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->create_html_template_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
data CreateHtmlTemplateData

Return type

PendingTemplate

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

create_pdf_template

create_pdf_template(template_document, template_name, opts)

Create a new PDF template with a form POST file upload

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
template_document = File.new('/path/to/some/file') # File | 
template_name = 'template_name_example' # String | 
opts = {
  template_parent_folder_id: 'template_parent_folder_id_example' # String | 
}

begin
  # Create a new PDF template with a form POST file upload
  result = api_instance.create_pdf_template(template_document, template_name, opts)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->create_pdf_template: #{e}"
end

Using the create_pdf_template_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_pdf_template_with_http_info(template_document, template_name, opts)

begin
  # Create a new PDF template with a form POST file upload
  data, status_code, headers = api_instance.create_pdf_template_with_http_info(template_document, template_name, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PendingTemplate>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->create_pdf_template_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
template_document File
template_name String
template_parent_folder_id String [optional]

Return type

PendingTemplate

Authorization

api_token_basic

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

create_pdf_template_from_upload

create_pdf_template_from_upload(data)

Create a new PDF template from a cached presign upload

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
data = DocSpring::CreateTemplateFromUploadData.new({template: DocSpring::UploadTemplateData.new({name: 'name_example'})}) # CreateTemplateFromUploadData | 

begin
  # Create a new PDF template from a cached presign upload
  result = api_instance.create_pdf_template_from_upload(data)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->create_pdf_template_from_upload: #{e}"
end

Using the create_pdf_template_from_upload_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_pdf_template_from_upload_with_http_info(data)

begin
  # Create a new PDF template from a cached presign upload
  data, status_code, headers = api_instance.create_pdf_template_from_upload_with_http_info(data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PendingTemplate>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->create_pdf_template_from_upload_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
data CreateTemplateFromUploadData

Return type

PendingTemplate

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

delete_folder

delete_folder(folder_id)

Delete a folder

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
folder_id = 'fld_0000000000000000001' # String | 

begin
  # Delete a folder
  result = api_instance.delete_folder(folder_id)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->delete_folder: #{e}"
end

Using the delete_folder_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> delete_folder_with_http_info(folder_id)

begin
  # Delete a folder
  data, status_code, headers = api_instance.delete_folder_with_http_info(folder_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Folder>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->delete_folder_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
folder_id String

Return type

Folder

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

delete_template

delete_template(template_id, opts)

Delete a template

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
template_id = 'tpl_000000000000000001' # String | 
opts = {
  version: '0.1.0' # String | 
}

begin
  # Delete a template
  result = api_instance.delete_template(template_id, opts)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->delete_template: #{e}"
end

Using the delete_template_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> delete_template_with_http_info(template_id, opts)

begin
  # Delete a template
  data, status_code, headers = api_instance.delete_template_with_http_info(template_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DeleteTemplateResponse>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->delete_template_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
template_id String
version String [optional]

Return type

DeleteTemplateResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

expire_combined_submission

expire_combined_submission(combined_submission_id)

Expire a combined submission

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
combined_submission_id = 'com_0000000000000000001' # String | 

begin
  # Expire a combined submission
  result = api_instance.expire_combined_submission(combined_submission_id)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->expire_combined_submission: #{e}"
end

Using the expire_combined_submission_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> expire_combined_submission_with_http_info(combined_submission_id)

begin
  # Expire a combined submission
  data, status_code, headers = api_instance.expire_combined_submission_with_http_info(combined_submission_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CombinedSubmission>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->expire_combined_submission_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
combined_submission_id String

Return type

CombinedSubmission

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

expire_submission

expire_submission(submission_id)

Expire a PDF submission

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
submission_id = 'sub_000000000000000001' # String | 

begin
  # Expire a PDF submission
  result = api_instance.expire_submission(submission_id)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->expire_submission: #{e}"
end

Using the expire_submission_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> expire_submission_with_http_info(submission_id)

begin
  # Expire a PDF submission
  data, status_code, headers = api_instance.expire_submission_with_http_info(submission_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Submission>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->expire_submission_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
submission_id String

Return type

Submission

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

generate_pdf

generate_pdf(template_id, submission)

Generates a new PDF

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
template_id = 'tpl_000000000000000001' # String | 
submission = DocSpring::CreateSubmissionData.new({data: 3.56}) # CreateSubmissionData | 

begin
  # Generates a new PDF
  result = api_instance.generate_pdf(template_id, submission)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->generate_pdf: #{e}"
end

Using the generate_pdf_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> generate_pdf_with_http_info(template_id, submission)

begin
  # Generates a new PDF
  data, status_code, headers = api_instance.generate_pdf_with_http_info(template_id, submission)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CreateSubmissionResponse>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->generate_pdf_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
template_id String
submission CreateSubmissionData

Return type

CreateSubmissionResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

generate_preview

generate_preview(submission_id)

Generated a preview PDF for partially completed data requests

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
submission_id = 'sub_00000000000000001' # String | 

begin
  # Generated a preview PDF for partially completed data requests
  result = api_instance.generate_preview(submission_id)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->generate_preview: #{e}"
end

Using the generate_preview_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> generate_preview_with_http_info(submission_id)

begin
  # Generated a preview PDF for partially completed data requests
  data, status_code, headers = api_instance.generate_preview_with_http_info(submission_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PreviewPdfResponse>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->generate_preview_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
submission_id String

Return type

PreviewPdfResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_combined_submission

get_combined_submission(combined_submission_id)

Check the status of a combined submission (merged PDFs)

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
combined_submission_id = 'com_0000000000000000001' # String | 

begin
  # Check the status of a combined submission (merged PDFs)
  result = api_instance.get_combined_submission(combined_submission_id)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->get_combined_submission: #{e}"
end

Using the get_combined_submission_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_combined_submission_with_http_info(combined_submission_id)

begin
  # Check the status of a combined submission (merged PDFs)
  data, status_code, headers = api_instance.get_combined_submission_with_http_info(combined_submission_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CombinedSubmission>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->get_combined_submission_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
combined_submission_id String

Return type

CombinedSubmission

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_data_request

get_data_request(data_request_id)

Look up a submission data request

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
data_request_id = 'drq_000000000000000001' # String | 

begin
  # Look up a submission data request
  result = api_instance.get_data_request(data_request_id)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->get_data_request: #{e}"
end

Using the get_data_request_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_data_request_with_http_info(data_request_id)

begin
  # Look up a submission data request
  data, status_code, headers = api_instance.get_data_request_with_http_info(data_request_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <SubmissionDataRequest>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->get_data_request_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
data_request_id String

Return type

SubmissionDataRequest

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_full_template

get_full_template(template_id)

Fetch the full template attributes

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
template_id = 'tpl_000000000000000001' # String | 

begin
  # Fetch the full template attributes
  result = api_instance.get_full_template(template_id)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->get_full_template: #{e}"
end

Using the get_full_template_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_full_template_with_http_info(template_id)

begin
  # Fetch the full template attributes
  data, status_code, headers = api_instance.get_full_template_with_http_info(template_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FullTemplate>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->get_full_template_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
template_id String

Return type

FullTemplate

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_presign_url

get_presign_url

Get a presigned URL so that you can upload a file to our AWS S3 bucket

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new

begin
  # Get a presigned URL so that you can upload a file to our AWS S3 bucket
  result = api_instance.get_presign_url
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->get_presign_url: #{e}"
end

Using the get_presign_url_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_presign_url_with_http_info

begin
  # Get a presigned URL so that you can upload a file to our AWS S3 bucket
  data, status_code, headers = api_instance.get_presign_url_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <UploadPresign>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->get_presign_url_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

UploadPresign

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_submission

get_submission(submission_id, opts)

Check the status of a PDF

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
submission_id = 'sub_000000000000000001' # String | 
opts = {
  include_data: true # Boolean | 
}

begin
  # Check the status of a PDF
  result = api_instance.get_submission(submission_id, opts)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->get_submission: #{e}"
end

Using the get_submission_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_submission_with_http_info(submission_id, opts)

begin
  # Check the status of a PDF
  data, status_code, headers = api_instance.get_submission_with_http_info(submission_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Submission>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->get_submission_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
submission_id String
include_data Boolean [optional]

Return type

Submission

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_submission_batch

get_submission_batch(submission_batch_id, opts)

Check the status of a submission batch job

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
submission_batch_id = 'sbb_000000000000000001' # String | 
opts = {
  include_submissions: true # Boolean | 
}

begin
  # Check the status of a submission batch job
  result = api_instance.get_submission_batch(submission_batch_id, opts)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->get_submission_batch: #{e}"
end

Using the get_submission_batch_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_submission_batch_with_http_info(submission_batch_id, opts)

begin
  # Check the status of a submission batch job
  data, status_code, headers = api_instance.get_submission_batch_with_http_info(submission_batch_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <SubmissionBatch>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->get_submission_batch_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
submission_batch_id String
include_submissions Boolean [optional]

Return type

SubmissionBatch

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_template

get_template(template_id)

Check the status of an uploaded template

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
template_id = 'tpl_000000000000000001' # String | 

begin
  # Check the status of an uploaded template
  result = api_instance.get_template(template_id)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->get_template: #{e}"
end

Using the get_template_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_template_with_http_info(template_id) 

begin
  # Check the status of an uploaded template
  data, status_code, headers = api_instance.get_template_with_http_info(template_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Template>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->get_template_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
template_id String

Return type

Template

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_template_schema

get_template_schema(template_id)

Fetch the JSON schema for a template

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
template_id = 'tpl_000000000000000001' # String | 

begin
  # Fetch the JSON schema for a template
  result = api_instance.get_template_schema(template_id)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->get_template_schema: #{e}"
end

Using the get_template_schema_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_template_schema_with_http_info(template_id)

begin
  # Fetch the JSON schema for a template
  data, status_code, headers = api_instance.get_template_schema_with_http_info(template_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TemplateSchema>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->get_template_schema_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
template_id String

Return type

TemplateSchema

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

list_combined_submissions

<Array> list_combined_submissions(opts)

Get a list of all combined submissions

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
opts = {
  page: 2, # Integer | Default: 1
  per_page: 1 # Integer | Default: 50
}

begin
  # Get a list of all combined submissions
  result = api_instance.list_combined_submissions(opts)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->list_combined_submissions: #{e}"
end

Using the list_combined_submissions_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> list_combined_submissions_with_http_info(opts)

begin
  # Get a list of all combined submissions
  data, status_code, headers = api_instance.list_combined_submissions_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<CombinedSubmission>>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->list_combined_submissions_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
page Integer Default: 1 [optional]
per_page Integer Default: 50 [optional]

Return type

Array<CombinedSubmission>

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

list_folders

<Array> list_folders(opts)

Get a list of all folders

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
opts = {
  parent_folder_id: 'fld_0000000000000000002' # String | Filter By Folder Id
}

begin
  # Get a list of all folders
  result = api_instance.list_folders(opts)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->list_folders: #{e}"
end

Using the list_folders_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> list_folders_with_http_info(opts)

begin
  # Get a list of all folders
  data, status_code, headers = api_instance.list_folders_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<Folder>>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->list_folders_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
parent_folder_id String Filter By Folder Id [optional]

Return type

Array<Folder>

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

list_submissions

list_submissions(opts)

List all submissions

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
opts = {
  cursor: 'sub_list_000012', # String | 
  limit: 3, # Float | 
  created_after: '2019-01-01T09:00:00-05:00', # String | 
  created_before: '2020-01-01T09:00:00.000+0200', # String | 
  type: 'test', # String | 
  include_data: true # Boolean | 
}

begin
  # List all submissions
  result = api_instance.list_submissions(opts)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->list_submissions: #{e}"
end

Using the list_submissions_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> list_submissions_with_http_info(opts)

begin
  # List all submissions
  data, status_code, headers = api_instance.list_submissions_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ListSubmissionsResponse>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->list_submissions_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
cursor String [optional]
limit Float [optional]
created_after String [optional]
created_before String [optional]
type String [optional]
include_data Boolean [optional]

Return type

ListSubmissionsResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

list_template_submissions

list_template_submissions(template_id, opts)

List all submissions for a given template

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
template_id = 'tpl_000000000000000002' # String | 
opts = {
  cursor: 'cursor_example', # String | 
  limit: 8.14, # Float | 
  created_after: 'created_after_example', # String | 
  created_before: 'created_before_example', # String | 
  type: 'type_example', # String | 
  include_data: true # Boolean | 
}

begin
  # List all submissions for a given template
  result = api_instance.list_template_submissions(template_id, opts)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->list_template_submissions: #{e}"
end

Using the list_template_submissions_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> list_template_submissions_with_http_info(template_id, opts)

begin
  # List all submissions for a given template
  data, status_code, headers = api_instance.list_template_submissions_with_http_info(template_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ListSubmissionsResponse>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->list_template_submissions_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
template_id String
cursor String [optional]
limit Float [optional]
created_after String [optional]
created_before String [optional]
type String [optional]
include_data Boolean [optional]

Return type

ListSubmissionsResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

list_templates

<Array> list_templates(opts)

Get a list of all templates

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
opts = {
  query: '2', # String | Search By Name
  parent_folder_id: 'fld_000000000000000001', # String | Filter By Folder Id
  page: 2, # Integer | Default: 1
  per_page: 1 # Integer | Default: 50
}

begin
  # Get a list of all templates
  result = api_instance.list_templates(opts)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->list_templates: #{e}"
end

Using the list_templates_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> list_templates_with_http_info(opts) 

begin
  # Get a list of all templates
  data, status_code, headers = api_instance.list_templates_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<Template>>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->list_templates_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
query String Search By Name [optional]
parent_folder_id String Filter By Folder Id [optional]
page Integer Default: 1 [optional]
per_page Integer Default: 50 [optional]

Return type

Array<Template>

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

move_folder_to_folder

move_folder_to_folder(folder_id, data)

Move a folder

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
folder_id = 'fld_0000000000000000001' # String | 
data = DocSpring::MoveFolderData.new # MoveFolderData | 

begin
  # Move a folder
  result = api_instance.move_folder_to_folder(folder_id, data)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->move_folder_to_folder: #{e}"
end

Using the move_folder_to_folder_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> move_folder_to_folder_with_http_info(folder_id, data)

begin
  # Move a folder
  data, status_code, headers = api_instance.move_folder_to_folder_with_http_info(folder_id, data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Folder>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->move_folder_to_folder_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
folder_id String
data MoveFolderData

Return type

Folder

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

move_template_to_folder

move_template_to_folder(template_id, data)

Move Template to folder

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
template_id = 'tpl_000000000000000001' # String | 
data = DocSpring::MoveTemplateData.new({parent_folder_id: 'parent_folder_id_example'}) # MoveTemplateData | 

begin
  # Move Template to folder
  result = api_instance.move_template_to_folder(template_id, data)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->move_template_to_folder: #{e}"
end

Using the move_template_to_folder_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> move_template_to_folder_with_http_info(template_id, data) 

begin
  # Move Template to folder
  data, status_code, headers = api_instance.move_template_to_folder_with_http_info(template_id, data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Template>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->move_template_to_folder_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
template_id String
data MoveTemplateData

Return type

Template

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

publish_template_version

publish_template_version(template_id, data)

Publish a template version

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
template_id = 'tpl_000000000000000001' # String | 
data = DocSpring::PublishVersionData.new({version_type: 'version_type_example'}) # PublishVersionData | 

begin
  # Publish a template version
  result = api_instance.publish_template_version(template_id, data)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->publish_template_version: #{e}"
end

Using the publish_template_version_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> publish_template_version_with_http_info(template_id, data)

begin
  # Publish a template version
  data, status_code, headers = api_instance.publish_template_version_with_http_info(template_id, data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PublishTemplateVersionResponse>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->publish_template_version_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
template_id String
data PublishVersionData

Return type

PublishTemplateVersionResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

rename_folder

rename_folder(folder_id, data)

Rename a folder

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
folder_id = 'fld_0000000000000000001' # String | 
data = DocSpring::RenameFolderData.new({name: 'name_example'}) # RenameFolderData | 

begin
  # Rename a folder
  api_instance.rename_folder(folder_id, data)
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->rename_folder: #{e}"
end

Using the rename_folder_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> rename_folder_with_http_info(folder_id, data)

begin
  # Rename a folder
  data, status_code, headers = api_instance.rename_folder_with_http_info(folder_id, data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->rename_folder_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
folder_id String
data RenameFolderData

Return type

nil (empty response body)

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

restore_template_version

restore_template_version(template_id, data)

Restore a template version

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
template_id = 'tpl_000000000000000001' # String | 
data = DocSpring::RestoreVersionData.new({version: 'version_example'}) # RestoreVersionData | 

begin
  # Restore a template version
  result = api_instance.restore_template_version(template_id, data)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->restore_template_version: #{e}"
end

Using the restore_template_version_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> restore_template_version_with_http_info(template_id, data)

begin
  # Restore a template version
  data, status_code, headers = api_instance.restore_template_version_with_http_info(template_id, data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RestoreTemplateVersionResponse>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->restore_template_version_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
template_id String
data RestoreVersionData

Return type

RestoreTemplateVersionResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

test_authentication

test_authentication

Test Authentication

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new

begin
  # Test Authentication
  result = api_instance.test_authentication
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->test_authentication: #{e}"
end

Using the test_authentication_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> test_authentication_with_http_info

begin
  # Test Authentication
  data, status_code, headers = api_instance.test_authentication_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AuthenticationSuccessResponse>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->test_authentication_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

AuthenticationSuccessResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

update_data_request

update_data_request(data_request_id, data)

Update a submission data request

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
data_request_id = 'drq_000000000000000001' # String | 
data = DocSpring::UpdateSubmissionDataRequestData.new # UpdateSubmissionDataRequestData | 

begin
  # Update a submission data request
  result = api_instance.update_data_request(data_request_id, data)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->update_data_request: #{e}"
end

Using the update_data_request_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_data_request_with_http_info(data_request_id, data)

begin
  # Update a submission data request
  data, status_code, headers = api_instance.update_data_request_with_http_info(data_request_id, data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <UpdateDataRequestResponse>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->update_data_request_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
data_request_id String
data UpdateSubmissionDataRequestData

Return type

UpdateDataRequestResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

update_template

update_template(template_id, data)

Update a Template

Examples

require 'time'
require 'docspring'
# setup authorization
DocSpring.configure do |config|
  # Configure HTTP basic authorization: api_token_basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = DocSpring::PDFApi.new
template_id = 'tpl_000000000000000003' # String | 
data = DocSpring::UpdateTemplateData.new({template: DocSpring::TemplateData.new}) # UpdateTemplateData | 

begin
  # Update a Template
  result = api_instance.update_template(template_id, data)
  p result
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->update_template: #{e}"
end

Using the update_template_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_template_with_http_info(template_id, data)

begin
  # Update a Template
  data, status_code, headers = api_instance.update_template_with_http_info(template_id, data)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <UpdateTemplateResponse>
rescue DocSpring::ApiError => e
  puts "Error when calling PDFApi->update_template_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
template_id String
data UpdateTemplateData

Return type

UpdateTemplateResponse

Authorization

api_token_basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json