docspring 4.0.0 → 4.2.0

data/lib/docspring/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.26.0-DOCSPRING
 =end
 
 module DocSpring
-  VERSION = '4.0.0'
+  VERSION = '4.2.0'
 end

data/lib/docspring/webhook_signature.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'openssl'
+
+module DocSpring
+  # The number of seconds a webhook request's signature stays valid (verify_webhook_signature)
+  WEBHOOK_SIGNATURE_TOLERANCE = 300
+
+  # Checks a webhook request's X-DocSpring-Signature header (https://docspring.com/docs/webhooks/verifying-signatures/).
+  # Returns true when one of its v1 signatures is the HMAC-SHA256 of "{t}.{payload}" with the webhook's secret, and its
+  # timestamp t is at most `tolerance` seconds from `now`. Returns false for anything else, including a missing or
+  # malformed header.
+  #
+  # payload: the request body exactly as it was received (Rails: request.raw_post), not parsed JSON.
+  # signature_header: the X-DocSpring-Signature header.
+  # secret: the webhook's signing secret.
+  # tolerance: how many seconds old (or early) the timestamp can be. 5 minutes by default.
+  # now: the current Unix time in seconds, for tests. The system clock by default.
+  def self.verify_webhook_signature(payload, signature_header, secret, tolerance: WEBHOOK_SIGNATURE_TOLERANCE, now: nil)
+    return false unless payload.is_a?(String) && signature_header.is_a?(String) && secret.is_a?(String) && !secret.empty?
+
+    parts = signature_header.split(',').map { |part| part.strip.split('=', 2) }
+    timestamp = parts.find { |key, _value| key == 't' }&.last
+    signatures = parts.filter_map { |key, value| value if key == 'v1' && value && !value.empty? }
+    return false unless timestamp&.match?(/\A\d+\z/) && !signatures.empty?
+
+    now = Time.now.to_i if now.nil?
+    return false if (now.to_i - timestamp.to_i).abs > tolerance
+
+    expected = OpenSSL::HMAC.hexdigest('SHA256', secret, "#{timestamp}.#{payload}")
+    signatures.any? { |signature| webhook_signature_equal?(signature, expected) }
+  end
+
+  # Compares two signatures in constant time, so a timing attack can't find a valid one byte by byte
+  def self.webhook_signature_equal?(signature, expected)
+    return false unless signature.bytesize == expected.bytesize
+    # OpenSSL 2.2 (Ruby 3.0) and later
+    return OpenSSL.fixed_length_secure_compare(signature, expected) if OpenSSL.respond_to?(:fixed_length_secure_compare)
+
+    difference = 0
+    signature.bytes.zip(expected.bytes) { |a, b| difference |= a ^ b }
+    difference == 0
+  end
+  private_class_method :webhook_signature_equal?
+end

data/lib/docspring.rb

@@ -14,11 +14,13 @@ Generator version: 7.26.0-DOCSPRING
 require 'docspring/api_client'
 require 'docspring/api_error'
 require 'docspring/request_validator'
+require 'docspring/webhook_signature'
 require 'docspring/api_model_base'
 require 'docspring/version'
 require 'docspring/configuration'
 
 # Models
+require 'docspring/models/add_template_fields_request'
 require 'docspring/models/ai_field_naming_language'
 require 'docspring/models/authentication_check'
 require 'docspring/models/barcode_symbology'
@@ -40,6 +42,7 @@ require 'docspring/models/create_signature_request_event_request'
 require 'docspring/models/create_signature_request_token_request'
 require 'docspring/models/create_submission_batch_request'
 require 'docspring/models/create_submission_request'
+require 'docspring/models/create_template_preview_request'
 require 'docspring/models/create_template_request'
 require 'docspring/models/create_webhook_request'
 require 'docspring/models/custom_file'
@@ -50,12 +53,19 @@ require 'docspring/models/error_detail'
 require 'docspring/models/error_info'
 require 'docspring/models/error_response'
 require 'docspring/models/expiration_interval'
+require 'docspring/models/field'
 require 'docspring/models/field_comparison_condition'
 require 'docspring/models/field_comparison_operator'
+require 'docspring/models/field_dependency'
+require 'docspring/models/field_dependency_input'
 require 'docspring/models/field_display_type'
 require 'docspring/models/field_equals_condition'
 require 'docspring/models/field_equals_operator'
+require 'docspring/models/field_group'
+require 'docspring/models/field_group_input'
+require 'docspring/models/field_group_type'
 require 'docspring/models/field_in_condition'
+require 'docspring/models/field_input'
 require 'docspring/models/field_override'
 require 'docspring/models/field_presence_condition'
 require 'docspring/models/field_presence_operator'
@@ -64,8 +74,11 @@ require 'docspring/models/field_reimport_state'
 require 'docspring/models/field_setup_logic'
 require 'docspring/models/field_setup_naming'
 require 'docspring/models/field_setup_source'
+require 'docspring/models/field_type'
 require 'docspring/models/folder'
 require 'docspring/models/folder_list'
+require 'docspring/models/generate_files_format'
+require 'docspring/models/generate_submission_files_request'
 require 'docspring/models/generated_file'
 require 'docspring/models/generated_file_state'
 require 'docspring/models/html_engine_options'
@@ -76,9 +89,16 @@ require 'docspring/models/model_code_language'
 require 'docspring/models/move_folder_request'
 require 'docspring/models/move_template_request'
 require 'docspring/models/number_condition_type'
+require 'docspring/models/output_format'
 require 'docspring/models/page_format'
+require 'docspring/models/page_image'
+require 'docspring/models/page_images'
+require 'docspring/models/predefined_field'
+require 'docspring/models/predefined_field_input'
 require 'docspring/models/publish_template_version_request'
+require 'docspring/models/remove_template_fields_request'
 require 'docspring/models/rename_folder_request'
+require 'docspring/models/reorder_template_fields_request'
 require 'docspring/models/restore_template_version_request'
 require 'docspring/models/shape_type'
 require 'docspring/models/signature_request'
@@ -104,13 +124,20 @@ require 'docspring/models/submission_list'
 require 'docspring/models/submission_source'
 require 'docspring/models/submission_source_pdf'
 require 'docspring/models/submission_state'
+require 'docspring/models/submission_summary'
+require 'docspring/models/submission_validation'
 require 'docspring/models/template'
 require 'docspring/models/template_actor'
 require 'docspring/models/template_actor_type'
 require 'docspring/models/template_defaults'
 require 'docspring/models/template_defaults_input'
+require 'docspring/models/template_diff'
+require 'docspring/models/template_diff_summary'
 require 'docspring/models/template_document'
 require 'docspring/models/template_document_state'
+require 'docspring/models/template_document_summary'
+require 'docspring/models/template_field_change'
+require 'docspring/models/template_field_changes'
 require 'docspring/models/template_field_dependency'
 require 'docspring/models/template_field_dependency_action'
 require 'docspring/models/template_field_dependency_condition'
@@ -119,13 +146,18 @@ require 'docspring/models/template_field_dependency_input'
 require 'docspring/models/template_field_dependency_match'
 require 'docspring/models/template_field_dependency_operator'
 require 'docspring/models/template_field_logic_status'
+require 'docspring/models/template_field_move'
+require 'docspring/models/template_fields'
 require 'docspring/models/template_form_mode'
 require 'docspring/models/template_model_code'
 require 'docspring/models/template_page_ai_error'
 require 'docspring/models/template_page_ai_naming_status'
 require 'docspring/models/template_page_fields_status'
 require 'docspring/models/template_page_image_status'
+require 'docspring/models/template_page_images'
 require 'docspring/models/template_page_processing_status'
+require 'docspring/models/template_preview'
+require 'docspring/models/template_preview_state'
 require 'docspring/models/template_source_pdf'
 require 'docspring/models/template_summary'
 require 'docspring/models/template_summary_list'
@@ -138,11 +170,13 @@ require 'docspring/models/text_vertical_alignment'
 require 'docspring/models/typeface'
 require 'docspring/models/update_signature_request_request'
 require 'docspring/models/update_template_document_request'
+require 'docspring/models/update_template_fields_request'
 require 'docspring/models/update_template_request'
 require 'docspring/models/update_webhook_request'
 require 'docspring/models/upload_method'
 require 'docspring/models/upload_presign'
 require 'docspring/models/url_source_pdf'
+require 'docspring/models/validate_submission_request'
 require 'docspring/models/webhook'
 require 'docspring/models/webhook_event_type'
 require 'docspring/models/webhook_list'

data/spec/api/client_spec.rb

@@ -32,6 +32,19 @@ describe 'Client' do
     end
   end
 
+  # unit tests for add_template_fields
+  # Add fields to a template
+  # Adds fields to a template's draft and returns all of its fields. Publish a version for submissions of published versions to have them. 
+  # @param template_id The template's ID.
+  # @param body The fields to add to the template's draft.
+  # @param [Hash] opts the optional parameters
+  # @return [TemplateFields]
+  describe 'add_template_fields test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for copy_template
   # Copy a template
   # Copies a template (its draft, or a published version) into a new template.
@@ -51,6 +64,7 @@ describe 'Client' do
   # @param body The PDFs to merge, and the combined PDF's settings.
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :wait Wait until the PDF has been generated before responding. Default true on sync.api hosts.
+  # @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another combined PDF. Send a new key with each new combined PDF, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds.
   # @return [CombinedPdf]
   describe 'create_combined_pdf test' do
     it 'should work' do
@@ -84,7 +98,7 @@ describe 'Client' do
 
   # unit tests for create_signature_request_event
   # Record a signature request event
-  # Records something that happened outside DocSpring in the signature request's audit trail: you sent the request to the person (`send_request`). The audit trail shows it as reported by your account. 
+  # Records something that happened outside DocSpring in the signature request's audit trail: you sent the request to the person (`send_request`). The audit trail shows it as reported by your account. A finished (completed, declined or expired) signature request's audit trail takes no more events, and a test API token can't record one for a live signature request. 
   # @param signature_request_id The signature request's ID.
   # @param body The event to record.
   # @param [Hash] opts the optional parameters
@@ -115,7 +129,8 @@ describe 'Client' do
   # @param body The submission's data and settings.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :version The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published).
-  # @option opts [Boolean] :wait Wait until the PDF has been generated before responding. Default true on sync.api hosts.
+  # @option opts [Boolean] :wait Wait until the files have been generated before responding. Default true on sync.api hosts.
+  # @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another submission. Send a new key with each new submission, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds.
   # @return [Submission]
   describe 'create_submission test' do
     it 'should work' do
@@ -129,6 +144,7 @@ describe 'Client' do
   # @param body The submissions to create, and the settings they share.
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :wait Wait until every PDF in the batch has been generated before responding. Default true on sync.api hosts.
+  # @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another batch. Send a new key with each new batch, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds.
   # @return [SubmissionBatch]
   describe 'create_submission_batch test' do
     it 'should work' do
@@ -141,7 +157,7 @@ describe 'Client' do
   # Creates an HTML template, or a PDF template from a PDF you uploaded with the presigned upload (GET /uploads/presign): pass its `fields.key` as `cache_id`. To send the PDF with the request instead, use POST /templates/upload.  A PDF template is ready to generate PDFs once DocSpring has processed its PDF (`ready` is true). On sync.api hosts the request waits for that unless you pass `wait=false`. 
   # @param body The template to create.
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :wait Wait until the PDF has been processed before responding. Default true on sync.api hosts.
+  # @option opts [Boolean] :wait Wait until the PDF has been processed, and a `document_url` downloaded, before responding. Default true on sync.api hosts.
   # @return [Template]
   describe 'create_template test' do
     it 'should work' do
@@ -149,6 +165,20 @@ describe 'Client' do
     end
   end
 
+  # unit tests for create_template_preview
+  # Preview a template with data
+  # Makes PNG images of a template's pages filled in with the data you send (not a PDF), so you can check how an HTML or PDF template prints with your data before you publish a version or send live data. It renders the template's draft, or the published `version` you ask for. A preview makes no submission and uses no credits, and its pages are watermarked like a test submission's PDF. It's `pending` while it renders: get it with GET /templates/{template_id}/previews/{preview_id} until it's `processed`, with an image of each page, or `error`. 
+  # @param template_id The template's ID.
+  # @param body The data to render the template with.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :version A published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `draft`.
+  # @return [TemplatePreview]
+  describe 'create_template_preview test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for create_webhook
   # Create a webhook
   # Creates a webhook that sends a POST request to your endpoint whenever a subscribed event happens. Scope it to API tokens, templates or folders to receive only their events. 
@@ -234,6 +264,20 @@ describe 'Client' do
     end
   end
 
+  # unit tests for generate_submission_files
+  # Generate more files
+  # Adds formats to a processed submission's files, in the background: `png`, a PNG image of each page of the PDF (up to 100 pages). To make them with the submission, add them to `output_formats` when you create it.  Each new file is listed in `files` while it's made: on sync.api hosts the request waits for them (unless you pass `wait=false`), otherwise poll GET /submissions/{submission_id} until none of their `state` is `pending`. A file that couldn't be made has the state `error` and an `error_message`, and the submission stays processed. Asking for a format the submission already has (or is making) changes nothing. 
+  # @param submission_id The submission's ID.
+  # @param body The formats to make.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :wait Wait until the files have been generated before responding. Default true on sync.api hosts.
+  # @return [Submission]
+  describe 'generate_submission_files test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for generate_submission_preview
   # Generate a preview PDF
   # Generates a preview of a submission's PDF in the background, such as for a submission still waiting for its signature requests. It's in `files.preview` once `preview_generated_at` changes. 
@@ -343,13 +387,27 @@ describe 'Client' do
     end
   end
 
+  # unit tests for get_template_diff
+  # Compare a version of a template with the one before it
+  # Returns what changed in the template's draft since its latest published version (or in a published version since the one before it): fields added, removed, changed and moved, the settings that changed, and whether the document was replaced. Check it before you publish a version. 
+  # @param template_id The template's ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :version A published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `draft`.
+  # @return [TemplateDiff]
+  describe 'get_template_diff test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for get_template_model_code
   # Generate typed code for a template's submission data
-  # Generates types for a template's submission data in TypeScript, JavaScript, Ruby, Python, PHP, Java, C#, Elixir or Go, so your app catches mistakes before it calls the API. `root_type_name` is the type of the whole `data` object. Java returns every class in `code`, each under a `// ClassName.java` comment. A template with no named fields returns 422. 
+  # Generates types for a template's submission data in TypeScript, JavaScript, Ruby, Python, PHP, Java, C#, Elixir or Go, so your app catches mistakes before it calls the API. `root_type_name` is the type of the whole `data` object, and `just_types=true` leaves out the code that converts JSON to and from the types. Java returns every class in `code`, each under a `// ClassName.java` comment. A template with no named fields returns 422. 
   # @param template_id The template's ID.
   # @param lang The language to generate the code in.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :version The template version: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published), the version a submission uses by default.
+  # @option opts [Boolean] :just_types Return only the types (interfaces, classes or structs), without the code that converts JSON to and from them. Default false. JavaScript has no types and PHP no types-only code, so theirs is the same either way.
   # @return [TemplateModelCode]
   describe 'get_template_model_code test' do
     it 'should work' do
@@ -357,6 +415,32 @@ describe 'Client' do
     end
   end
 
+  # unit tests for get_template_page_images
+  # Get images of a template's pages
+  # Returns a JPEG image of each page of a PDF template's PDF, with temporary links to download them: the draft's PDF, or a published version's. Use them to see the pages that fields are placed on. 
+  # @param template_id The template's ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :version A published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `draft`.
+  # @return [TemplatePageImages]
+  describe 'get_template_page_images test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_template_preview
+  # Get a template preview
+  # Returns a preview made with POST /templates/{template_id}/previews. Once it's `processed`, `pages` has a PNG image of each page with a temporary link to download it: a preview has no PDF. Previews are deleted an hour after they're created. 
+  # @param template_id The template's ID.
+  # @param preview_id The preview's ID.
+  # @param [Hash] opts the optional parameters
+  # @return [TemplatePreview]
+  describe 'get_template_preview test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for get_template_schema
   # Get the JSON Schema of a template's submission data
   # Returns the JSON Schema that a submission's `data` must match. Use it to check data before you create submissions, or to build a form for the template's fields. 
@@ -424,7 +508,7 @@ describe 'Client' do
 
   # unit tests for list_submissions
   # List submissions
-  # Returns the submissions in your account, newest first, one page at a time. Lists leave out each submission's `data` unless you pass `include_data=true`. 
+  # Returns the submissions in your account, newest first, one page at a time. Each one is a summary: its `data` is null unless you pass `include_data=true`, and its `files` are empty unless you pass `include_files=true`. Get a submission by its ID for its signature requests, uploads and page images. 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :template_id Only list this template's submissions.
   # @option opts [Boolean] :test Only list test submissions (true) or live submissions (false).
@@ -433,6 +517,8 @@ describe 'Client' do
   # @option opts [Boolean] :include_data Include each submission's `data` (null without it).
   # @option opts [Integer] :limit How many items to return (1-100, default 50).
   # @option opts [String] :cursor The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one.
+  # @option opts [SubmissionState] :state Only list submissions in this state (one state per request). The ones that failed are `invalid_data`, `error`, `syntax_error`, `image_download_failed` and `image_processing_failed`, and one still `pending` an hour after it was created is stuck.
+  # @option opts [Boolean] :include_files Include each submission's generated files and their download links (`files`, empty without it), without the page images' links.
   # @return [SubmissionList]
   describe 'list_submissions test' do
     it 'should work' do
@@ -440,6 +526,19 @@ describe 'Client' do
     end
   end
 
+  # unit tests for list_template_fields
+  # List a template's fields
+  # Returns a template's fields with all of their settings, page by page: the draft's fields, or a published version's. A PDF template's fields are placed on its pages: GET /templates/{template_id}/page_images has images of the pages. 
+  # @param template_id The template's ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :version A published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `draft`.
+  # @return [TemplateFields]
+  describe 'list_template_fields test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for list_template_submissions
   # List a template's submissions
   # Returns a template's submissions (from every version of the template), newest first.
@@ -451,6 +550,8 @@ describe 'Client' do
   # @option opts [Boolean] :include_data Include each submission's `data` (null without it).
   # @option opts [Integer] :limit How many items to return (1-100, default 50).
   # @option opts [String] :cursor The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one.
+  # @option opts [SubmissionState] :state Only list submissions in this state (one state per request). The ones that failed are `invalid_data`, `error`, `syntax_error`, `image_download_failed` and `image_processing_failed`, and one still `pending` an hour after it was created is stuck.
+  # @option opts [Boolean] :include_files Include each submission's generated files and their download links (`files`, empty without it), without the page images' links.
   # @return [SubmissionList]
   describe 'list_template_submissions test' do
     it 'should work' do
@@ -460,7 +561,7 @@ describe 'Client' do
 
   # unit tests for list_templates
   # List templates
-  # Returns the templates in your account (their drafts), newest first, one page at a time. Get a template by its ID for its HTML, defaults and published versions. 
+  # Returns the templates in your account (their drafts), newest first, one page at a time. Each one is a summary: get a template by its ID for its settings, its PDF in full, its HTML, defaults and published versions. 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :query Only list templates whose name contains this text (ignoring case).
   # @option opts [String] :parent_folder_id Only list the templates in this folder (not in its subfolders).
@@ -519,7 +620,7 @@ describe 'Client' do
 
   # unit tests for publish_template_version
   # Publish a template version
-  # Publishes the template's draft as a new version that doesn't change. `version_type` says which part of the latest version number goes up. 
+  # Publishes the template's draft as a new version that doesn't change. `version_type` says which part of the latest version number goes up. While the template's PDF is downloading or being processed, or DocSpring is setting up its fields, it returns a 409 that says so. 
   # @param template_id The template's ID.
   # @param body The version to publish.
   # @param [Hash] opts the optional parameters
@@ -530,6 +631,19 @@ describe 'Client' do
     end
   end
 
+  # unit tests for remove_template_fields
+  # Remove fields from a template
+  # Removes fields from a template's draft and returns the fields that are left. Conditional logic that used only the removed fields is removed too. 
+  # @param template_id The template's ID.
+  # @param body The fields to remove from the template's draft.
+  # @param [Hash] opts the optional parameters
+  # @return [TemplateFields]
+  describe 'remove_template_fields test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for rename_folder
   # Rename a folder
   # Renames a folder. The name must be unique within its parent folder. 
@@ -543,6 +657,19 @@ describe 'Client' do
     end
   end
 
+  # unit tests for reorder_template_fields
+  # Reorder a template's fields
+  # Changes the order of the fields in a template's draft and returns them in their new order. Send every field's ID: each field stays on its page, and a page's fields are printed in this order, so a later field prints over an earlier one where they overlap. Their values are in this order in the template's data schema and forms. 
+  # @param template_id The template's ID.
+  # @param body The new order of the fields in the template's draft.
+  # @param [Hash] opts the optional parameters
+  # @return [TemplateFields]
+  describe 'reorder_template_fields test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for restore_template_version
   # Restore a template version
   # Replaces the template's draft with a copy of one of its published versions.
@@ -582,7 +709,7 @@ describe 'Client' do
 
   # unit tests for update_template
   # Update a template
-  # Changes a template's draft. Properties left out keep their values. `defaults` and `html_engine_options` replace the whole object. Setting `parent_folder_id` moves the template and all of its published versions. 
+  # Changes a template's draft. Properties left out keep their values. `defaults` and `html_engine_options` replace the whole object, and `field_groups` changes only the groups it lists. Setting `parent_folder_id` moves the template and all of its published versions. 
   # @param template_id The template's ID.
   # @param body The settings to change. Properties left out keep their values.
   # @param [Hash] opts the optional parameters
@@ -595,11 +722,11 @@ describe 'Client' do
 
   # unit tests for update_template_document
   # Replace a template's PDF
-  # Replaces a PDF template's PDF with one you uploaded with the presigned upload (GET /uploads/presign). The fields stay where they are, unless `reimport_fields` replaces them with the new PDF's fillable fields. To send the PDF with the request instead, use PUT /templates/{template_id}/document/upload. 
+  # Replaces a PDF template's PDF with one you uploaded with the presigned upload (GET /uploads/presign) (`cache_id`), a link to download it from (`document_url`), or the file in base64 (`document_base64`). The fields stay where they are, unless `reimport_fields` replaces them with the new PDF's fillable fields. To send the PDF as `multipart/form-data` instead, use PUT /templates/{template_id}/document/upload. 
   # @param template_id The template's ID.
-  # @param body The new PDF.
+  # @param body The new PDF, as one of `cache_id`, `document_url` and `document_base64`.
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :wait Wait until the PDF has been processed before responding. Default true on sync.api hosts.
+  # @option opts [Boolean] :wait Wait until the PDF has been processed, and a `document_url` downloaded, before responding. Default true on sync.api hosts.
   # @return [Template]
   describe 'update_template_document test' do
     it 'should work' do
@@ -607,6 +734,19 @@ describe 'Client' do
     end
   end
 
+  # unit tests for update_template_fields
+  # Update a template's fields
+  # Changes fields of a template's draft and returns all of its fields. Settings left out keep their values. A shared setting (`type`, `required`, `default`, ...) changes for every field with the same name. 
+  # @param template_id The template's ID.
+  # @param body The fields to change in the template's draft.
+  # @param [Hash] opts the optional parameters
+  # @return [TemplateFields]
+  describe 'update_template_fields test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for update_webhook
   # Update a webhook
   # Updates a webhook. Only the properties you send change.
@@ -625,7 +765,7 @@ describe 'Client' do
   # Creates a PDF template from a PDF sent with the request (`multipart/form-data`). For large files, upload the PDF with the presigned upload (GET /uploads/presign) and create the template with POST /templates. 
   # @param document The PDF.
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :wait Wait until the PDF has been processed before responding. Default true on sync.api hosts.
+  # @option opts [Boolean] :wait Wait until the PDF has been processed, and a `document_url` downloaded, before responding. Default true on sync.api hosts.
   # @option opts [String] :name The template's name.
   # @option opts [String] :description The template's description.
   # @option opts [String] :parent_folder_id The folder to put the template in. Left out, it's created at the root.
@@ -647,7 +787,7 @@ describe 'Client' do
   # @param template_id The template's ID.
   # @param document The new PDF.
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :wait Wait until the PDF has been processed before responding. Default true on sync.api hosts.
+  # @option opts [Boolean] :wait Wait until the PDF has been processed, and a `document_url` downloaded, before responding. Default true on sync.api hosts.
   # @option opts [Boolean] :reimport_fields Replace all of the template's fields with the fillable fields in the new PDF, once DocSpring has processed it (`document.field_reimport_state`). As on a first upload, the default typeface, font size, bold and color are taken from the PDF's fields; the template's other settings are kept. If the PDF has no fillable fields, the template keeps its fields. A locked template can't re-import its fields.
   # @return [Template]
   describe 'upload_template_document test' do
@@ -656,4 +796,18 @@ describe 'Client' do
     end
   end
 
+  # unit tests for validate_submission
+  # Check a submission without creating it
+  # Checks a submission as creating it would (its data against the template's fields, its settings and signature requests) without saving it, generating anything or using credits. It doesn't check your account's credits. The response says whether the submission is valid, and if not, has the error that creating it would return. 
+  # @param template_id The template's ID.
+  # @param body The submission's data and settings.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :version The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published).
+  # @return [SubmissionValidation]
+  describe 'validate_submission test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/spec/models/add_template_fields_request_spec.rb

@@ -0,0 +1,36 @@
+=begin
+#DocSpring API
+
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+
+The version of the OpenAPI document: v2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.26.0-DOCSPRING
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for DocSpring::AddTemplateFieldsRequest
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe DocSpring::AddTemplateFieldsRequest do
+  #let(:instance) { DocSpring::AddTemplateFieldsRequest.new }
+
+  describe 'test an instance of AddTemplateFieldsRequest' do
+    it 'should create an instance of AddTemplateFieldsRequest' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(DocSpring::AddTemplateFieldsRequest)
+    end
+  end
+
+  describe 'test attribute "fields"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/create_submission_batch_request_spec.rb

@@ -51,6 +51,12 @@ describe DocSpring::CreateSubmissionBatchRequest do
     end
   end
 
+  describe 'test attribute "output_formats"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "submissions"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/create_submission_request_spec.rb

@@ -57,6 +57,12 @@ describe DocSpring::CreateSubmissionRequest do
     end
   end
 
+  describe 'test attribute "output_formats"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "expires_in"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/create_template_preview_request_spec.rb

@@ -0,0 +1,36 @@
+=begin
+#DocSpring API
+
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+
+The version of the OpenAPI document: v2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.26.0-DOCSPRING
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for DocSpring::CreateTemplatePreviewRequest
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe DocSpring::CreateTemplatePreviewRequest do
+  #let(:instance) { DocSpring::CreateTemplatePreviewRequest.new }
+
+  describe 'test an instance of CreateTemplatePreviewRequest' do
+    it 'should create an instance of CreateTemplatePreviewRequest' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(DocSpring::CreateTemplatePreviewRequest)
+    end
+  end
+
+  describe 'test attribute "data"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end