Updated on 2025-01-30 21:34:12. Version: 2.0.0

Author: ndbroadbent

.gitlab-ci.yml

@@ -0,0 +1,26 @@
+.ruby: &ruby
+  variables:
+    LANG: "C.UTF-8"
+  before_script:
+    - ruby -v
+    - bundle config set --local deployment true
+    - bundle install -j $(nproc)
+  parallel:
+    matrix:
+      - RUBY_VERSION: ['2.7', '3.0', '3.1']
+  image: "ruby:$RUBY_VERSION"
+  cache:
+    paths:
+      - vendor/ruby
+    key: 'ruby-$RUBY_VERSION'
+
+gem:
+  extends: .ruby
+  script:
+    - bundle exec rspec
+    - bundle exec rake build
+    - bundle exec rake install
+  artifacts:
+    paths:
+      - pkg/*.gem
+

.openapi-generator/FILES

@@ -0,0 +1,220 @@
+.gitignore
+.gitlab-ci.yml
+.rspec
+.rubocop.yml
+.travis.yml
+Gemfile
+README.md
+Rakefile
+docs/AddFieldsData.md
+docs/AddFieldsTemplateResponse.md
+docs/AuthenticationError.md
+docs/AuthenticationSuccessResponse.md
+docs/CombinePdfsData.md
+docs/CombinedSubmission.md
+docs/CombinedSubmissionAction.md
+docs/CombinedSubmissionData.md
+docs/CopyTemplateData.md
+docs/CreateCombinedSubmissionResponse.md
+docs/CreateCustomFileData.md
+docs/CreateCustomFileResponse.md
+docs/CreateFolderAttributes.md
+docs/CreateFolderData.md
+docs/CreateHtmlTemplateData.md
+docs/CreateSubmissionBatchResponse.md
+docs/CreateSubmissionBatchSubmissionsResponse.md
+docs/CreateSubmissionData.md
+docs/CreateSubmissionDataRequestData.md
+docs/CreateSubmissionDataRequestEventRequest.md
+docs/CreateSubmissionDataRequestEventResponse.md
+docs/CreateSubmissionDataRequestTokenResponse.md
+docs/CreateSubmissionResponse.md
+docs/CreateTemplateFromUploadData.md
+docs/DataRequestToken.md
+docs/DeleteTemplateResponse.md
+docs/ErrorResponse.md
+docs/Folder.md
+docs/FullTemplate.md
+docs/HtmlTemplateData.md
+docs/HtmlTemplateDataWebhookOptions.md
+docs/InvalidRequest.md
+docs/InvalidRequestSingleError.md
+docs/ListSubmissionsResponse.md
+docs/MoveFolderData.md
+docs/MoveTemplateData.md
+docs/PDFApi.md
+docs/PendingTemplate.md
+docs/PreviewPdfResponse.md
+docs/PublishTemplateVersion404Response.md
+docs/PublishTemplateVersion422Response.md
+docs/PublishTemplateVersionResponse.md
+docs/PublishTemplateVersionResponseResult.md
+docs/PublishVersionData.md
+docs/RenameFolderData.md
+docs/RestoreTemplateVersionResponse.md
+docs/RestoreVersionData.md
+docs/Submission.md
+docs/SubmissionAction.md
+docs/SubmissionBatch.md
+docs/SubmissionBatchData.md
+docs/SubmissionData.md
+docs/SubmissionDataBatchRequest.md
+docs/SubmissionDataRequest.md
+docs/SubmissionDataRequestEvent.md
+docs/Template.md
+docs/TemplateData.md
+docs/TemplateDefaults.md
+docs/TemplateDocument.md
+docs/TemplateDocumentMetadata.md
+docs/TemplateSchema.md
+docs/UpdateDataRequestResponse.md
+docs/UpdateSubmissionDataRequestData.md
+docs/UpdateTemplateData.md
+docs/UpdateTemplateResponse.md
+docs/UploadPresign.md
+docs/UploadTemplateData.md
+docspring.gemspec
+git_push.sh
+lib/docspring.rb
+lib/docspring/api/client.rb
+lib/docspring/api/pdf_api.rb
+lib/docspring/api_client.rb
+lib/docspring/api_error.rb
+lib/docspring/configuration.rb
+lib/docspring/models/add_fields_data.rb
+lib/docspring/models/add_fields_template_response.rb
+lib/docspring/models/authentication_error.rb
+lib/docspring/models/authentication_success_response.rb
+lib/docspring/models/combine_pdfs_data.rb
+lib/docspring/models/combined_submission.rb
+lib/docspring/models/combined_submission_action.rb
+lib/docspring/models/combined_submission_data.rb
+lib/docspring/models/copy_template_data.rb
+lib/docspring/models/create_combined_submission_response.rb
+lib/docspring/models/create_custom_file_data.rb
+lib/docspring/models/create_custom_file_response.rb
+lib/docspring/models/create_folder_attributes.rb
+lib/docspring/models/create_folder_data.rb
+lib/docspring/models/create_html_template_data.rb
+lib/docspring/models/create_submission_batch_response.rb
+lib/docspring/models/create_submission_batch_submissions_response.rb
+lib/docspring/models/create_submission_data.rb
+lib/docspring/models/create_submission_data_request_data.rb
+lib/docspring/models/create_submission_data_request_event_request.rb
+lib/docspring/models/create_submission_data_request_event_response.rb
+lib/docspring/models/create_submission_data_request_token_response.rb
+lib/docspring/models/create_submission_response.rb
+lib/docspring/models/create_template_from_upload_data.rb
+lib/docspring/models/data_request_token.rb
+lib/docspring/models/delete_template_response.rb
+lib/docspring/models/error_response.rb
+lib/docspring/models/folder.rb
+lib/docspring/models/full_template.rb
+lib/docspring/models/html_template_data.rb
+lib/docspring/models/html_template_data_webhook_options.rb
+lib/docspring/models/invalid_request.rb
+lib/docspring/models/invalid_request_single_error.rb
+lib/docspring/models/list_submissions_response.rb
+lib/docspring/models/move_folder_data.rb
+lib/docspring/models/move_template_data.rb
+lib/docspring/models/pending_template.rb
+lib/docspring/models/preview_pdf_response.rb
+lib/docspring/models/publish_template_version404_response.rb
+lib/docspring/models/publish_template_version422_response.rb
+lib/docspring/models/publish_template_version_response.rb
+lib/docspring/models/publish_template_version_response_result.rb
+lib/docspring/models/publish_version_data.rb
+lib/docspring/models/rename_folder_data.rb
+lib/docspring/models/restore_template_version_response.rb
+lib/docspring/models/restore_version_data.rb
+lib/docspring/models/submission.rb
+lib/docspring/models/submission_action.rb
+lib/docspring/models/submission_batch.rb
+lib/docspring/models/submission_batch_data.rb
+lib/docspring/models/submission_data.rb
+lib/docspring/models/submission_data_batch_request.rb
+lib/docspring/models/submission_data_request.rb
+lib/docspring/models/submission_data_request_event.rb
+lib/docspring/models/template.rb
+lib/docspring/models/template_data.rb
+lib/docspring/models/template_defaults.rb
+lib/docspring/models/template_document.rb
+lib/docspring/models/template_document_metadata.rb
+lib/docspring/models/template_schema.rb
+lib/docspring/models/update_data_request_response.rb
+lib/docspring/models/update_submission_data_request_data.rb
+lib/docspring/models/update_template_data.rb
+lib/docspring/models/update_template_response.rb
+lib/docspring/models/upload_presign.rb
+lib/docspring/models/upload_template_data.rb
+lib/docspring/version.rb
+spec/api/client_integration_spec.rb
+spec/api/pdf_api_integration_spec.rb
+spec/api/pdf_api_spec.rb
+spec/models/add_fields_data_spec.rb
+spec/models/add_fields_template_response_spec.rb
+spec/models/authentication_error_spec.rb
+spec/models/authentication_success_response_spec.rb
+spec/models/combine_pdfs_data_spec.rb
+spec/models/combined_submission_action_spec.rb
+spec/models/combined_submission_data_spec.rb
+spec/models/combined_submission_spec.rb
+spec/models/copy_template_data_spec.rb
+spec/models/create_combined_submission_response_spec.rb
+spec/models/create_custom_file_data_spec.rb
+spec/models/create_custom_file_response_spec.rb
+spec/models/create_folder_attributes_spec.rb
+spec/models/create_folder_data_spec.rb
+spec/models/create_html_template_data_spec.rb
+spec/models/create_submission_batch_response_spec.rb
+spec/models/create_submission_batch_submissions_response_spec.rb
+spec/models/create_submission_data_request_data_spec.rb
+spec/models/create_submission_data_request_event_request_spec.rb
+spec/models/create_submission_data_request_event_response_spec.rb
+spec/models/create_submission_data_request_token_response_spec.rb
+spec/models/create_submission_data_spec.rb
+spec/models/create_submission_response_spec.rb
+spec/models/create_template_from_upload_data_spec.rb
+spec/models/data_request_token_spec.rb
+spec/models/delete_template_response_spec.rb
+spec/models/error_response_spec.rb
+spec/models/folder_spec.rb
+spec/models/full_template_spec.rb
+spec/models/html_template_data_spec.rb
+spec/models/html_template_data_webhook_options_spec.rb
+spec/models/invalid_request_single_error_spec.rb
+spec/models/invalid_request_spec.rb
+spec/models/list_submissions_response_spec.rb
+spec/models/move_folder_data_spec.rb
+spec/models/move_template_data_spec.rb
+spec/models/pending_template_spec.rb
+spec/models/preview_pdf_response_spec.rb
+spec/models/publish_template_version404_response_spec.rb
+spec/models/publish_template_version422_response_spec.rb
+spec/models/publish_template_version_response_result_spec.rb
+spec/models/publish_template_version_response_spec.rb
+spec/models/publish_version_data_spec.rb
+spec/models/rename_folder_data_spec.rb
+spec/models/restore_template_version_response_spec.rb
+spec/models/restore_version_data_spec.rb
+spec/models/submission_action_spec.rb
+spec/models/submission_batch_data_spec.rb
+spec/models/submission_batch_spec.rb
+spec/models/submission_data_batch_request_spec.rb
+spec/models/submission_data_request_event_spec.rb
+spec/models/submission_data_request_spec.rb
+spec/models/submission_data_spec.rb
+spec/models/submission_spec.rb
+spec/models/template_data_spec.rb
+spec/models/template_defaults_spec.rb
+spec/models/template_document_metadata_spec.rb
+spec/models/template_document_spec.rb
+spec/models/template_schema_spec.rb
+spec/models/template_spec.rb
+spec/models/update_data_request_response_spec.rb
+spec/models/update_submission_data_request_data_spec.rb
+spec/models/update_template_data_spec.rb
+spec/models/update_template_response_spec.rb
+spec/models/upload_presign_spec.rb
+spec/models/upload_template_data_spec.rb
+spec/spec_helper.rb

.openapi-generator/VERSION

@@ -1 +1 @@
-3.3.0
+7.11.0

.rubocop.yml

@@ -1,7 +1,7 @@
 # This file is based on https://github.com/rails/rails/blob/master/.rubocop.yml (MIT license)
 # Automatically generated by OpenAPI Generator (https://openapi-generator.tech)
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.4
   # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
   # to ignore them, so only the ones explicitly set in this file are enabled.
   DisabledByDefault: true
@@ -14,12 +14,6 @@ AllCops:
 Style/AndOr:
   Enabled: true
 
-# Do not use braces for hash literals when they are the last argument of a
-# method call.
-Style/BracesAroundHashParameters:
-  Enabled: true
-  EnforcedStyle: context_dependent
-
 # Align `when` with `case`.
 Layout/CaseIndentation:
   Enabled: true
@@ -46,7 +40,7 @@ Layout/EmptyLinesAroundMethodBody:
 Layout/EmptyLinesAroundModuleBody:
   Enabled: true
 
-Layout/FirstParameterIndentation:
+Layout/FirstArgumentIndentation:
   Enabled: true
 
 # Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
@@ -57,7 +51,7 @@ Style/HashSyntax:
 # extra level of indentation.
 Layout/IndentationConsistency:
   Enabled: true
-  EnforcedStyle: rails
+  EnforcedStyle: indented_internal_methods
 
 # Two spaces, no tabs (for indentation).
 Layout/IndentationWidth:
@@ -119,19 +113,19 @@ Layout/SpaceInsideParens:
 #  EnforcedStyle: single_quotes
 
 # Detect hard tabs, no hard tabs.
-Layout/Tab:
+Layout/IndentationStyle:
   Enabled: true
 
 # Blank lines should not have any spaces.
-Layout/TrailingBlankLines:
+Layout/TrailingEmptyLines:
   Enabled: true
 
 # No trailing whitespace.
 Layout/TrailingWhitespace:
   Enabled: false
 
 # Use quotes for string literals when they are enough.
-Style/UnneededPercentQ:
+Style/RedundantPercentQ:
   Enabled: true
 
 # Align `end` with the matching keyword or starting expression except for

.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.7
+  - 3.0
+  - 3.1
+script:
+  - bundle install --path vendor/bundle
+  - bundle exec rspec
+  - gem build docspring.gemspec
+  - gem install ./docspring-2.0.0.gem

CHANGELOG.md

@@ -1,3 +1,8 @@
+### 2.0.0 [January 30, 2025]
+
+- Updated OpenAPI Generator to 7.11.0
+- Added template versioning parameters to API methods
+
 ### 1.4.1 [November 28, 2021]
 
 - Added 'password' parameter to Generate PDF and Combine PDF API endpoints. You can now encrypt each generated PDF with a unique password.

Gemfile

@@ -3,7 +3,11 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '>= 12.3.3'
+  gem 'rake', '~> 13.0.1'
   gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+  # <--------------- BEGIN DOCSPRING CUSTOMIZATION ----------------->
+  # Description: Add bundler-audit for security checks
   gem 'bundler-audit'
+  # <--------------- END DOCSPRING CUSTOMIZATION ----------------->
 end