https://github.com/docspring/docspring-ruby
Ruby API Client for DocSpring
https://github.com/docspring/docspring-ruby
Last synced: about 1 year ago
JSON representation
Ruby API Client for DocSpring
- Host: GitHub
- URL: https://github.com/docspring/docspring-ruby
- Owner: DocSpring
- License: mit
- Created: 2019-11-08T18:10:34.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-01-30T08:34:36.000Z (over 1 year ago)
- Last Synced: 2025-01-30T09:28:52.244Z (over 1 year ago)
- Language: Ruby
- Homepage: https://rubygems.org/gems/docspring
- Size: 215 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# docspring
DocSpring - the Ruby gem for the DocSpring API
DocSpring provides an API that helps you fill out and sign PDF templates.
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: v1
- Package version: 3.1.0
- Generator version: 7.11.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
## Installation
### Build a gem
To build the Ruby code into a gem:
```shell
gem build docspring.gemspec
```
Then either install the gem locally:
```shell
gem install ./docspring-3.1.0.gem
```
(for development, run `gem install --dev ./docspring-3.1.0.gem` to install the development dependencies)
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
Finally add this to the Gemfile:
gem 'docspring', '~> 3.1.0'
### Install from Git
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
Include the Ruby code directly using `-I` as follows:
```shell
ruby -Ilib script.rb
```
## Getting Started
Please follow the [installation](#installation) procedure and then run the following code:
```ruby
# 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::PDFApi.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 PDFApi->add_fields_to_template: #{e}"
end
```
## Documentation for API Endpoints
All URIs are relative to *https://sync.api.docspring.com/api/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DocSpring::PDFApi* | [**add_fields_to_template**](docs/PDFApi.md#add_fields_to_template) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template
*DocSpring::PDFApi* | [**batch_generate_pdfs**](docs/PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
*DocSpring::PDFApi* | [**combine_pdfs**](docs/PDFApi.md#combine_pdfs) | **POST** /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files
*DocSpring::PDFApi* | [**combine_submissions**](docs/PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
*DocSpring::PDFApi* | [**copy_template**](docs/PDFApi.md#copy_template) | **POST** /templates/{template_id}/copy | Copy a Template
*DocSpring::PDFApi* | [**create_custom_file_from_upload**](docs/PDFApi.md#create_custom_file_from_upload) | **POST** /custom_files | Create a new custom file from a cached presign upload
*DocSpring::PDFApi* | [**create_data_request_event**](docs/PDFApi.md#create_data_request_event) | **POST** /data_requests/{data_request_id}/events | Creates a new event for emailing a signee a request for signature
*DocSpring::PDFApi* | [**create_data_request_token**](docs/PDFApi.md#create_data_request_token) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
*DocSpring::PDFApi* | [**create_folder**](docs/PDFApi.md#create_folder) | **POST** /folders/ | Create a folder
*DocSpring::PDFApi* | [**create_html_template**](docs/PDFApi.md#create_html_template) | **POST** /templates?endpoint_description=html | Create a new HTML template
*DocSpring::PDFApi* | [**create_pdf_template**](docs/PDFApi.md#create_pdf_template) | **POST** /templates | Create a new PDF template with a form POST file upload
*DocSpring::PDFApi* | [**create_pdf_template_from_upload**](docs/PDFApi.md#create_pdf_template_from_upload) | **POST** /templates?endpoint_description=cached_upload | Create a new PDF template from a cached presign upload
*DocSpring::PDFApi* | [**delete_folder**](docs/PDFApi.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder
*DocSpring::PDFApi* | [**delete_template**](docs/PDFApi.md#delete_template) | **DELETE** /templates/{template_id} | Delete a template
*DocSpring::PDFApi* | [**expire_combined_submission**](docs/PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
*DocSpring::PDFApi* | [**expire_submission**](docs/PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
*DocSpring::PDFApi* | [**generate_pdf**](docs/PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
*DocSpring::PDFApi* | [**generate_pdf_for_html_template**](docs/PDFApi.md#generate_pdf_for_html_template) | **POST** /templates/{template_id}/submissions?endpoint_description=html_templates | Generates a new PDF for an HTML template
*DocSpring::PDFApi* | [**generate_preview**](docs/PDFApi.md#generate_preview) | **POST** /submissions/{submission_id}/generate_preview | Generated a preview PDF for partially completed data requests
*DocSpring::PDFApi* | [**get_combined_submission**](docs/PDFApi.md#get_combined_submission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
*DocSpring::PDFApi* | [**get_data_request**](docs/PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request
*DocSpring::PDFApi* | [**get_full_template**](docs/PDFApi.md#get_full_template) | **GET** /templates/{template_id}?full=true | Fetch the full attributes for a PDF template
*DocSpring::PDFApi* | [**get_presign_url**](docs/PDFApi.md#get_presign_url) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket
*DocSpring::PDFApi* | [**get_submission**](docs/PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
*DocSpring::PDFApi* | [**get_submission_batch**](docs/PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
*DocSpring::PDFApi* | [**get_template**](docs/PDFApi.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded template
*DocSpring::PDFApi* | [**get_template_schema**](docs/PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
*DocSpring::PDFApi* | [**list_combined_submissions**](docs/PDFApi.md#list_combined_submissions) | **GET** /combined_submissions | Get a list of all combined submissions
*DocSpring::PDFApi* | [**list_folders**](docs/PDFApi.md#list_folders) | **GET** /folders/ | Get a list of all folders
*DocSpring::PDFApi* | [**list_submissions**](docs/PDFApi.md#list_submissions) | **GET** /submissions | List all submissions
*DocSpring::PDFApi* | [**list_template_submissions**](docs/PDFApi.md#list_template_submissions) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
*DocSpring::PDFApi* | [**list_templates**](docs/PDFApi.md#list_templates) | **GET** /templates | Get a list of all templates
*DocSpring::PDFApi* | [**move_folder_to_folder**](docs/PDFApi.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder
*DocSpring::PDFApi* | [**move_template_to_folder**](docs/PDFApi.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder
*DocSpring::PDFApi* | [**publish_template_version**](docs/PDFApi.md#publish_template_version) | **POST** /templates/{template_id}/publish_version | Publish a template version
*DocSpring::PDFApi* | [**rename_folder**](docs/PDFApi.md#rename_folder) | **POST** /folders/{folder_id}/rename | Rename a folder
*DocSpring::PDFApi* | [**restore_template_version**](docs/PDFApi.md#restore_template_version) | **POST** /templates/{template_id}/restore_version | Restore a template version
*DocSpring::PDFApi* | [**test_authentication**](docs/PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication
*DocSpring::PDFApi* | [**update_data_request**](docs/PDFApi.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request
*DocSpring::PDFApi* | [**update_template**](docs/PDFApi.md#update_template) | **PUT** /templates/{template_id} | Update a Template
## Documentation for Models
- [DocSpring::AddFieldsData](docs/AddFieldsData.md)
- [DocSpring::BatchGeneratePdfs201Response](docs/BatchGeneratePdfs201Response.md)
- [DocSpring::CombinePdfsData](docs/CombinePdfsData.md)
- [DocSpring::CombinedSubmission](docs/CombinedSubmission.md)
- [DocSpring::CombinedSubmissionAction](docs/CombinedSubmissionAction.md)
- [DocSpring::CombinedSubmissionData](docs/CombinedSubmissionData.md)
- [DocSpring::CopyTemplateOptions](docs/CopyTemplateOptions.md)
- [DocSpring::CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
- [DocSpring::CreateCustomFileData](docs/CreateCustomFileData.md)
- [DocSpring::CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
- [DocSpring::CreateFolderData](docs/CreateFolderData.md)
- [DocSpring::CreateHtmlSubmissionData](docs/CreateHtmlSubmissionData.md)
- [DocSpring::CreateHtmlTemplate](docs/CreateHtmlTemplate.md)
- [DocSpring::CreatePdfSubmissionData](docs/CreatePdfSubmissionData.md)
- [DocSpring::CreatePdfTemplate](docs/CreatePdfTemplate.md)
- [DocSpring::CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)
- [DocSpring::CreateSubmissionDataRequestEventRequest](docs/CreateSubmissionDataRequestEventRequest.md)
- [DocSpring::CreateSubmissionDataRequestEventResponse](docs/CreateSubmissionDataRequestEventResponse.md)
- [DocSpring::CreateSubmissionDataRequestResponse](docs/CreateSubmissionDataRequestResponse.md)
- [DocSpring::CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
- [DocSpring::CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
- [DocSpring::CustomFile](docs/CustomFile.md)
- [DocSpring::ErrorResponse](docs/ErrorResponse.md)
- [DocSpring::Folder](docs/Folder.md)
- [DocSpring::JsonSchema](docs/JsonSchema.md)
- [DocSpring::ListSubmissionsResponse](docs/ListSubmissionsResponse.md)
- [DocSpring::MoveFolderData](docs/MoveFolderData.md)
- [DocSpring::MoveTemplateData](docs/MoveTemplateData.md)
- [DocSpring::MultipleErrorsResponse](docs/MultipleErrorsResponse.md)
- [DocSpring::PublishVersionData](docs/PublishVersionData.md)
- [DocSpring::RenameFolderData](docs/RenameFolderData.md)
- [DocSpring::RestoreVersionData](docs/RestoreVersionData.md)
- [DocSpring::Submission](docs/Submission.md)
- [DocSpring::SubmissionAction](docs/SubmissionAction.md)
- [DocSpring::SubmissionBatch](docs/SubmissionBatch.md)
- [DocSpring::SubmissionBatchData](docs/SubmissionBatchData.md)
- [DocSpring::SubmissionBatchWithSubmissions](docs/SubmissionBatchWithSubmissions.md)
- [DocSpring::SubmissionDataRequest](docs/SubmissionDataRequest.md)
- [DocSpring::SubmissionDataRequestEvent](docs/SubmissionDataRequestEvent.md)
- [DocSpring::SubmissionDataRequestShow](docs/SubmissionDataRequestShow.md)
- [DocSpring::SubmissionDataRequestToken](docs/SubmissionDataRequestToken.md)
- [DocSpring::SubmissionPreview](docs/SubmissionPreview.md)
- [DocSpring::SuccessErrorResponse](docs/SuccessErrorResponse.md)
- [DocSpring::SuccessMultipleErrorsResponse](docs/SuccessMultipleErrorsResponse.md)
- [DocSpring::Template](docs/Template.md)
- [DocSpring::TemplateAddFieldsResponse](docs/TemplateAddFieldsResponse.md)
- [DocSpring::TemplateDeleteResponse](docs/TemplateDeleteResponse.md)
- [DocSpring::TemplatePreview](docs/TemplatePreview.md)
- [DocSpring::TemplatePublishVersionResponse](docs/TemplatePublishVersionResponse.md)
- [DocSpring::UpdateHtmlTemplate](docs/UpdateHtmlTemplate.md)
- [DocSpring::UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
- [DocSpring::UploadPresignResponse](docs/UploadPresignResponse.md)
## Documentation for Authorization
Authentication schemes defined for the API:
### api_token_basic
- **Type**: HTTP basic authentication