DocSpring - the Ruby gem for the DocSpring API

Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: v1
• Package version: 3.2.0
• Generator version: 7.16.0-DOCSPRING
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

To build the Ruby code into a gem:

gem build docspring.gemspec

Then either install the gem locally:

gem install ./docspring-3.2.0.gem

(for development, run gem install --dev ./docspring-3.2.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'docspring', '~> 3.2.0'

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'docspring', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Please follow the installation procedure and then run the following code:

# Load the gem
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::Client.new
template_id = 'tpl_1234567890abcdef02' # 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 "Exception when calling Client->add_fields_to_template: #{e}"
end

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

• DocSpring::AddFieldsData
• DocSpring::BatchGeneratePdfs201Response
• DocSpring::CombinePdfsData
• DocSpring::CombinedSubmission
• DocSpring::CombinedSubmissionAction
• DocSpring::CopyTemplateOptions
• DocSpring::CreateCombinedSubmissionResponse
• DocSpring::CreateCustomFileData
• DocSpring::CreateCustomFileResponse
• DocSpring::CreateFolderData
• DocSpring::CreateHtmlTemplate
• DocSpring::CreatePdfSubmissionData
• DocSpring::CreatePdfTemplate
• DocSpring::CreateSubmissionDataRequestData
• DocSpring::CreateSubmissionDataRequestEventRequest
• DocSpring::CreateSubmissionDataRequestEventResponse
• DocSpring::CreateSubmissionDataRequestResponse
• DocSpring::CreateSubmissionDataRequestTokenResponse
• DocSpring::CreateSubmissionResponse
• DocSpring::CustomFile
• DocSpring::ErrorOrMultipleErrorsResponse
• DocSpring::ErrorResponse
• DocSpring::Folder
• DocSpring::JsonSchema
• DocSpring::ListSubmissionsResponse
• DocSpring::MoveFolderData
• DocSpring::MoveTemplateData
• DocSpring::MultipleErrorsResponse
• DocSpring::PublishVersionData
• DocSpring::RenameFolderData
• DocSpring::RestoreVersionData
• DocSpring::Submission
• DocSpring::Submission422Response
• DocSpring::SubmissionAction
• DocSpring::SubmissionBatch
• DocSpring::SubmissionBatchData
• DocSpring::SubmissionBatchWithSubmissions
• DocSpring::SubmissionDataRequest
• DocSpring::SubmissionDataRequestEvent
• DocSpring::SubmissionDataRequestShow
• DocSpring::SubmissionDataRequestToken
• DocSpring::SubmissionPreview
• DocSpring::SuccessErrorResponse
• DocSpring::SuccessMultipleErrorsResponse
• DocSpring::Template
• DocSpring::TemplateAddFieldsResponse
• DocSpring::TemplateDeleteResponse
• DocSpring::TemplatePreview
• DocSpring::TemplatePublishVersionResponse
• DocSpring::UpdateHtmlTemplate
• DocSpring::UpdatePdfTemplate
• DocSpring::UpdateSubmissionDataRequestData
• DocSpring::UploadPresignResponse

Authentication schemes defined for the API:

• Type: HTTP basic authentication