README.md in docspring-1.1.0 vs README.md in docspring-1.2.0

- old
+ new

@@ -5,11 +5,11 @@ DocSpring is a service 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: 1.1.0 +- Package version: 1.2.0 - Build package: com.docspring.codegen.DocSpringRubyClientCodegen ## Installation ### Build a gem @@ -21,19 +21,19 @@ ``` Then either install the gem locally: ```shell -gem install ./docspring-1.1.0.gem +gem install ./docspring-1.2.0.gem ``` -(for development, run `gem install --dev ./docspring-1.1.0.gem` to install the development dependencies) +(for development, run `gem install --dev ./docspring-1.2.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', '~> 1.1.0' + gem 'docspring', '~> 1.2.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: @@ -60,29 +60,30 @@ config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' end api_instance = DocSpring::PDFApi.new -template_id = 'tpl_000000000000000001' # String | -request_body = nil # Array<Object> | +template_id = 'tpl_000000000000000002' # String | +add_fields_data = DocSpring::AddFieldsData.new # AddFieldsData | begin - #Generates multiple PDFs - result = api_instance.batch_generate_pdf_v1(template_id, request_body) + #Add new fields to a Template + result = api_instance.add_fields_to_template(template_id, add_fields_data) p result rescue DocSpring::ApiError => e - puts "Exception when calling PDFApi->batch_generate_pdf_v1: #{e}" + puts "Exception when calling PDFApi->add_fields_to_template: #{e}" end ``` ## Documentation for API Endpoints All URIs are relative to *https://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_pdf_v1**](docs/PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs *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&#x3D;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* | [**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 @@ -112,32 +113,35 @@ *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::AddFieldsTemplateResponse](docs/AddFieldsTemplateResponse.md) - [DocSpring::AuthenticationError](docs/AuthenticationError.md) - [DocSpring::AuthenticationSuccessResponse](docs/AuthenticationSuccessResponse.md) - [DocSpring::CombinePdfsData](docs/CombinePdfsData.md) - [DocSpring::CombinedSubmission](docs/CombinedSubmission.md) - [DocSpring::CombinedSubmissionAction](docs/CombinedSubmissionAction.md) - [DocSpring::CombinedSubmissionData](docs/CombinedSubmissionData.md) - [DocSpring::CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md) - [DocSpring::CreateCustomFileData](docs/CreateCustomFileData.md) - [DocSpring::CreateCustomFileResponse](docs/CreateCustomFileResponse.md) - [DocSpring::CreateFolderData](docs/CreateFolderData.md) + - [DocSpring::CreateHtmlTemplateData](docs/CreateHtmlTemplateData.md) - [DocSpring::CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md) - [DocSpring::CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md) - [DocSpring::CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md) - [DocSpring::CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md) - [DocSpring::CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md) - [DocSpring::CreateSubmissionResponse](docs/CreateSubmissionResponse.md) - - [DocSpring::CreateTemplateData](docs/CreateTemplateData.md) - - [DocSpring::CreateTemplateData1](docs/CreateTemplateData1.md) + - [DocSpring::CreateTemplateFromUploadData](docs/CreateTemplateFromUploadData.md) - [DocSpring::CustomFile](docs/CustomFile.md) - [DocSpring::Error](docs/Error.md) - [DocSpring::Folder](docs/Folder.md) - [DocSpring::FoldersFolder](docs/FoldersFolder.md) + - [DocSpring::HtmlTemplateData](docs/HtmlTemplateData.md) - [DocSpring::InvalidRequest](docs/InvalidRequest.md) - [DocSpring::MoveFolderData](docs/MoveFolderData.md) - [DocSpring::MoveTemplateData](docs/MoveTemplateData.md) - [DocSpring::PendingTemplate](docs/PendingTemplate.md) - [DocSpring::RenameFolderData](docs/RenameFolderData.md) @@ -147,17 +151,18 @@ - [DocSpring::SubmissionBatchData](docs/SubmissionBatchData.md) - [DocSpring::SubmissionData](docs/SubmissionData.md) - [DocSpring::SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md) - [DocSpring::SubmissionDataRequest](docs/SubmissionDataRequest.md) - [DocSpring::Template](docs/Template.md) - - [DocSpring::TemplatesdesccachedUploadTemplate](docs/TemplatesdesccachedUploadTemplate.md) - - [DocSpring::TemplatesdesccachedUploadTemplateDocument](docs/TemplatesdesccachedUploadTemplateDocument.md) - - [DocSpring::TemplatesdesccachedUploadTemplateDocumentMetadata](docs/TemplatesdesccachedUploadTemplateDocumentMetadata.md) - - [DocSpring::TemplatestemplateIdTemplate](docs/TemplatestemplateIdTemplate.md) + - [DocSpring::TemplateData](docs/TemplateData.md) + - [DocSpring::TemplatestemplateIdaddFieldsFields](docs/TemplatestemplateIdaddFieldsFields.md) - [DocSpring::UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md) - [DocSpring::UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md) - [DocSpring::UpdateTemplateData](docs/UpdateTemplateData.md) - [DocSpring::UpdateTemplateResponse](docs/UpdateTemplateResponse.md) + - [DocSpring::UploadTemplateData](docs/UploadTemplateData.md) + - [DocSpring::UploadTemplateDataDocument](docs/UploadTemplateDataDocument.md) + - [DocSpring::UploadTemplateDataDocumentMetadata](docs/UploadTemplateDataDocumentMetadata.md) ## Documentation for Authorization