{"id":19383882,"url":"https://github.com/docspring/docspring-ruby","last_synced_at":"2025-04-23T20:05:04.817Z","repository":{"id":56844321,"uuid":"220522711","full_name":"DocSpring/docspring-ruby","owner":"DocSpring","description":"Ruby API Client for DocSpring","archived":false,"fork":false,"pushed_at":"2025-01-30T08:34:36.000Z","size":220,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-30T09:28:52.244Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/docspring","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DocSpring.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-08T18:10:34.000Z","updated_at":"2025-01-30T08:34:40.000Z","dependencies_parsed_at":"2022-09-09T04:11:22.380Z","dependency_job_id":null,"html_url":"https://github.com/DocSpring/docspring-ruby","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DocSpring","download_url":"https://codeload.github.com/DocSpring/docspring-ruby/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240521037,"owners_count":19814694,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T09:28:15.334Z","updated_at":"2025-04-23T20:05:04.803Z","avatar_url":"https://github.com/DocSpring.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docspring\n\nDocSpring - the Ruby gem for the DocSpring API\n\nDocSpring provides an API that helps you fill out and sign PDF templates.\n\nThis SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: v1\n- Package version: 3.1.0\n- Generator version: 7.11.0\n- Build package: org.openapitools.codegen.languages.RubyClientCodegen\n\n## Installation\n\n### Build a gem\n\nTo build the Ruby code into a gem:\n\n```shell\ngem build docspring.gemspec\n```\n\nThen either install the gem locally:\n\n```shell\ngem install ./docspring-3.1.0.gem\n```\n\n(for development, run `gem install --dev ./docspring-3.1.0.gem` to install the development dependencies)\n\nor publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).\n\nFinally add this to the Gemfile:\n\n    gem 'docspring', '~\u003e 3.1.0'\n\n### Install from Git\n\nIf 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:\n\n    gem 'docspring', :git =\u003e 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'\n\n### Include the Ruby code directly\n\nInclude the Ruby code directly using `-I` as follows:\n\n```shell\nruby -Ilib script.rb\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) procedure and then run the following code:\n\n```ruby\n# Load the gem\nrequire 'docspring'\n\n# Setup authorization\nDocSpring.configure do |config|\n  # Configure HTTP basic authorization: api_token_basic\n  config.username = 'YOUR_USERNAME'\n  config.password = 'YOUR_PASSWORD'\nend\n\napi_instance = DocSpring::PDFApi.new\ntemplate_id = 'tpl_1234567890abcdef02' # String | \ndata = DocSpring::AddFieldsData.new({fields: [3.56]}) # AddFieldsData | \n\nbegin\n  #Add new fields to a Template\n  result = api_instance.add_fields_to_template(template_id, data)\n  p result\nrescue DocSpring::ApiError =\u003e e\n  puts \"Exception when calling PDFApi-\u003eadd_fields_to_template: #{e}\"\nend\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://sync.api.docspring.com/api/v1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*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\n*DocSpring::PDFApi* | [**batch_generate_pdfs**](docs/PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs\n*DocSpring::PDFApi* | [**combine_pdfs**](docs/PDFApi.md#combine_pdfs) | **POST** /combined_submissions?v\u0026#x3D;2 | Merge submission PDFs, template PDFs, or custom files\n*DocSpring::PDFApi* | [**combine_submissions**](docs/PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together\n*DocSpring::PDFApi* | [**copy_template**](docs/PDFApi.md#copy_template) | **POST** /templates/{template_id}/copy | Copy a Template\n*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\n*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\n*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\n*DocSpring::PDFApi* | [**create_folder**](docs/PDFApi.md#create_folder) | **POST** /folders/ | Create a folder\n*DocSpring::PDFApi* | [**create_html_template**](docs/PDFApi.md#create_html_template) | **POST** /templates?endpoint_description\u0026#x3D;html | Create a new HTML template\n*DocSpring::PDFApi* | [**create_pdf_template**](docs/PDFApi.md#create_pdf_template) | **POST** /templates | Create a new PDF template with a form POST file upload\n*DocSpring::PDFApi* | [**create_pdf_template_from_upload**](docs/PDFApi.md#create_pdf_template_from_upload) | **POST** /templates?endpoint_description\u0026#x3D;cached_upload | Create a new PDF template from a cached presign upload\n*DocSpring::PDFApi* | [**delete_folder**](docs/PDFApi.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder\n*DocSpring::PDFApi* | [**delete_template**](docs/PDFApi.md#delete_template) | **DELETE** /templates/{template_id} | Delete a template\n*DocSpring::PDFApi* | [**expire_combined_submission**](docs/PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission\n*DocSpring::PDFApi* | [**expire_submission**](docs/PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission\n*DocSpring::PDFApi* | [**generate_pdf**](docs/PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF\n*DocSpring::PDFApi* | [**generate_pdf_for_html_template**](docs/PDFApi.md#generate_pdf_for_html_template) | **POST** /templates/{template_id}/submissions?endpoint_description\u0026#x3D;html_templates | Generates a new PDF for an HTML template\n*DocSpring::PDFApi* | [**generate_preview**](docs/PDFApi.md#generate_preview) | **POST** /submissions/{submission_id}/generate_preview | Generated a preview PDF for partially completed data requests\n*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)\n*DocSpring::PDFApi* | [**get_data_request**](docs/PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request\n*DocSpring::PDFApi* | [**get_full_template**](docs/PDFApi.md#get_full_template) | **GET** /templates/{template_id}?full\u0026#x3D;true | Fetch the full attributes for a PDF template\n*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\n*DocSpring::PDFApi* | [**get_submission**](docs/PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF\n*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\n*DocSpring::PDFApi* | [**get_template**](docs/PDFApi.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded template\n*DocSpring::PDFApi* | [**get_template_schema**](docs/PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template\n*DocSpring::PDFApi* | [**list_combined_submissions**](docs/PDFApi.md#list_combined_submissions) | **GET** /combined_submissions | Get a list of all combined submissions\n*DocSpring::PDFApi* | [**list_folders**](docs/PDFApi.md#list_folders) | **GET** /folders/ | Get a list of all folders\n*DocSpring::PDFApi* | [**list_submissions**](docs/PDFApi.md#list_submissions) | **GET** /submissions | List all submissions\n*DocSpring::PDFApi* | [**list_template_submissions**](docs/PDFApi.md#list_template_submissions) | **GET** /templates/{template_id}/submissions | List all submissions for a given template\n*DocSpring::PDFApi* | [**list_templates**](docs/PDFApi.md#list_templates) | **GET** /templates | Get a list of all templates\n*DocSpring::PDFApi* | [**move_folder_to_folder**](docs/PDFApi.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder\n*DocSpring::PDFApi* | [**move_template_to_folder**](docs/PDFApi.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder\n*DocSpring::PDFApi* | [**publish_template_version**](docs/PDFApi.md#publish_template_version) | **POST** /templates/{template_id}/publish_version | Publish a template version\n*DocSpring::PDFApi* | [**rename_folder**](docs/PDFApi.md#rename_folder) | **POST** /folders/{folder_id}/rename | Rename a folder\n*DocSpring::PDFApi* | [**restore_template_version**](docs/PDFApi.md#restore_template_version) | **POST** /templates/{template_id}/restore_version | Restore a template version\n*DocSpring::PDFApi* | [**test_authentication**](docs/PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication\n*DocSpring::PDFApi* | [**update_data_request**](docs/PDFApi.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request\n*DocSpring::PDFApi* | [**update_template**](docs/PDFApi.md#update_template) | **PUT** /templates/{template_id} | Update a Template\n\n\n## Documentation for Models\n\n - [DocSpring::AddFieldsData](docs/AddFieldsData.md)\n - [DocSpring::BatchGeneratePdfs201Response](docs/BatchGeneratePdfs201Response.md)\n - [DocSpring::CombinePdfsData](docs/CombinePdfsData.md)\n - [DocSpring::CombinedSubmission](docs/CombinedSubmission.md)\n - [DocSpring::CombinedSubmissionAction](docs/CombinedSubmissionAction.md)\n - [DocSpring::CombinedSubmissionData](docs/CombinedSubmissionData.md)\n - [DocSpring::CopyTemplateOptions](docs/CopyTemplateOptions.md)\n - [DocSpring::CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)\n - [DocSpring::CreateCustomFileData](docs/CreateCustomFileData.md)\n - [DocSpring::CreateCustomFileResponse](docs/CreateCustomFileResponse.md)\n - [DocSpring::CreateFolderData](docs/CreateFolderData.md)\n - [DocSpring::CreateHtmlSubmissionData](docs/CreateHtmlSubmissionData.md)\n - [DocSpring::CreateHtmlTemplate](docs/CreateHtmlTemplate.md)\n - [DocSpring::CreatePdfSubmissionData](docs/CreatePdfSubmissionData.md)\n - [DocSpring::CreatePdfTemplate](docs/CreatePdfTemplate.md)\n - [DocSpring::CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)\n - [DocSpring::CreateSubmissionDataRequestEventRequest](docs/CreateSubmissionDataRequestEventRequest.md)\n - [DocSpring::CreateSubmissionDataRequestEventResponse](docs/CreateSubmissionDataRequestEventResponse.md)\n - [DocSpring::CreateSubmissionDataRequestResponse](docs/CreateSubmissionDataRequestResponse.md)\n - [DocSpring::CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)\n - [DocSpring::CreateSubmissionResponse](docs/CreateSubmissionResponse.md)\n - [DocSpring::CustomFile](docs/CustomFile.md)\n - [DocSpring::ErrorResponse](docs/ErrorResponse.md)\n - [DocSpring::Folder](docs/Folder.md)\n - [DocSpring::JsonSchema](docs/JsonSchema.md)\n - [DocSpring::ListSubmissionsResponse](docs/ListSubmissionsResponse.md)\n - [DocSpring::MoveFolderData](docs/MoveFolderData.md)\n - [DocSpring::MoveTemplateData](docs/MoveTemplateData.md)\n - [DocSpring::MultipleErrorsResponse](docs/MultipleErrorsResponse.md)\n - [DocSpring::PublishVersionData](docs/PublishVersionData.md)\n - [DocSpring::RenameFolderData](docs/RenameFolderData.md)\n - [DocSpring::RestoreVersionData](docs/RestoreVersionData.md)\n - [DocSpring::Submission](docs/Submission.md)\n - [DocSpring::SubmissionAction](docs/SubmissionAction.md)\n - [DocSpring::SubmissionBatch](docs/SubmissionBatch.md)\n - [DocSpring::SubmissionBatchData](docs/SubmissionBatchData.md)\n - [DocSpring::SubmissionBatchWithSubmissions](docs/SubmissionBatchWithSubmissions.md)\n - [DocSpring::SubmissionDataRequest](docs/SubmissionDataRequest.md)\n - [DocSpring::SubmissionDataRequestEvent](docs/SubmissionDataRequestEvent.md)\n - [DocSpring::SubmissionDataRequestShow](docs/SubmissionDataRequestShow.md)\n - [DocSpring::SubmissionDataRequestToken](docs/SubmissionDataRequestToken.md)\n - [DocSpring::SubmissionPreview](docs/SubmissionPreview.md)\n - [DocSpring::SuccessErrorResponse](docs/SuccessErrorResponse.md)\n - [DocSpring::SuccessMultipleErrorsResponse](docs/SuccessMultipleErrorsResponse.md)\n - [DocSpring::Template](docs/Template.md)\n - [DocSpring::TemplateAddFieldsResponse](docs/TemplateAddFieldsResponse.md)\n - [DocSpring::TemplateDeleteResponse](docs/TemplateDeleteResponse.md)\n - [DocSpring::TemplatePreview](docs/TemplatePreview.md)\n - [DocSpring::TemplatePublishVersionResponse](docs/TemplatePublishVersionResponse.md)\n - [DocSpring::UpdateHtmlTemplate](docs/UpdateHtmlTemplate.md)\n - [DocSpring::UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)\n - [DocSpring::UploadPresignResponse](docs/UploadPresignResponse.md)\n\n\n## Documentation for Authorization\n\n\nAuthentication schemes defined for the API:\n### api_token_basic\n\n- **Type**: HTTP basic authentication\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fdocspring-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocspring%2Fdocspring-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fdocspring-ruby/lists"}