docspring 4.0.0 → 4.1.0

data/lib/docspring/api_client.rb

@@ -33,7 +33,7 @@ module DocSpring
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "docspring-ruby-4.0.0"
+      @user_agent = "docspring-ruby-4.1.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/docspring/models/add_template_fields_request.rb

@@ -0,0 +1,187 @@
+=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 'date'
+require 'time'
+
+module DocSpring
+  # The fields to add to the template's draft.
+  class AddTemplateFieldsRequest < ApiModelBase
+    # The fields to add. Settings left out have their defaults, except that a field with the name of other fields takes their shared settings. Shared settings it sets change them for every field with the name.
+    attr_accessor :fields
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'fields' => :'fields'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'fields' => :'Array<FieldInput>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Returns attribute type mapping
+    def self.acceptable_openapi_types
+      openapi_types
+    end
+
+    # Returns the nullable attributes
+    def self.acceptable_openapi_nullable
+      openapi_nullable
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::AddTemplateFieldsRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::AddTemplateFieldsRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'fields')
+        if (value = attributes[:'fields']).is_a?(Array)
+          self.fields = value
+        end
+      else
+        self.fields = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @fields.nil?
+        invalid_properties.push('invalid value for "fields", fields cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @fields.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] fields Value to be assigned
+    def fields=(fields)
+      if fields.nil?
+        fail ArgumentError, 'fields cannot be nil'
+      end
+
+      @fields = fields
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          fields == o.fields
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [fields].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      map = acceptable_attribute_map
+      transformed_hash = {}
+      acceptable_openapi_types.each_pair do |key, type|
+        if attributes.key?(map[key]) && attributes[map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[map[key]])
+        end
+      end
+      # Responses can include enum values added after this client was released, so the enum setters
+      # accept any value while the model is built from a response
+      allocate.tap do |model|
+        model.instance_variable_set(:@_skip_enum_validation, true)
+        model.send(:initialize, transformed_hash)
+        model.remove_instance_variable(:@_skip_enum_validation)
+      end
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      self.class.acceptable_attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.acceptable_openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/docspring/models/create_submission_batch_request.rb

@@ -28,6 +28,9 @@ module DocSpring
     # The default `test` for each submission that doesn't set its own.
     attr_accessor :test
 
+    # The default `output_formats` for each submission that doesn't set its own.
+    attr_accessor :output_formats
+
     # Up to 50 submissions. Each one takes the properties of POST /templates/{template_id}/submissions except `signature_requests`, plus `template_id` and `template_version` when it uses a different template from the batch.
     attr_accessor :submissions
 
@@ -38,6 +41,7 @@ module DocSpring
         :'template_id' => :'template_id',
         :'template_version' => :'template_version',
         :'test' => :'test',
+        :'output_formats' => :'output_formats',
         :'submissions' => :'submissions'
       }
     end
@@ -59,6 +63,7 @@ module DocSpring
         :'template_id' => :'String',
         :'template_version' => :'String',
         :'test' => :'Boolean',
+        :'output_formats' => :'Array<OutputFormat>',
         :'submissions' => :'Array<SubmissionInput>'
       }
     end
@@ -113,6 +118,12 @@ module DocSpring
         self.test = attributes[:'test']
       end
 
+      if attributes.key?(:'output_formats')
+        if (value = attributes[:'output_formats']).is_a?(Array)
+          self.output_formats = value
+        end
+      end
+
       if attributes.key?(:'submissions')
         if (value = attributes[:'submissions']).is_a?(Array)
           self.submissions = value
@@ -142,6 +153,16 @@ module DocSpring
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] output_formats Value to be assigned
+    def output_formats=(output_formats)
+      if output_formats.nil?
+        fail ArgumentError, 'output_formats cannot be nil'
+      end
+
+      @output_formats = output_formats
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] submissions Value to be assigned
     def submissions=(submissions)
@@ -161,6 +182,7 @@ module DocSpring
           template_id == o.template_id &&
           template_version == o.template_version &&
           test == o.test &&
+          output_formats == o.output_formats &&
           submissions == o.submissions
     end
 
@@ -173,7 +195,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [metadata, template_id, template_version, test, submissions].hash
+      [metadata, template_id, template_version, test, output_formats, submissions].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/create_submission_request.rb

@@ -31,6 +31,9 @@ module DocSpring
     # A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set.
     attr_accessor :password
 
+    # What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
+    attr_accessor :output_formats
+
     # Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours.
     attr_accessor :expires_in
 
@@ -54,6 +57,7 @@ module DocSpring
         :'data' => :'data',
         :'metadata' => :'metadata',
         :'password' => :'password',
+        :'output_formats' => :'output_formats',
         :'expires_in' => :'expires_in',
         :'field_overrides' => :'field_overrides',
         :'html' => :'html',
@@ -80,6 +84,7 @@ module DocSpring
         :'data' => :'Hash<String, Object>',
         :'metadata' => :'Hash<String, Object>',
         :'password' => :'String',
+        :'output_formats' => :'Array<OutputFormat>',
         :'expires_in' => :'Integer',
         :'field_overrides' => :'Hash<String, FieldOverride>',
         :'html' => :'String',
@@ -144,6 +149,12 @@ module DocSpring
         self.password = attributes[:'password']
       end
 
+      if attributes.key?(:'output_formats')
+        if (value = attributes[:'output_formats']).is_a?(Array)
+          self.output_formats = value
+        end
+      end
+
       if attributes.key?(:'expires_in')
         self.expires_in = attributes[:'expires_in']
       end
@@ -184,6 +195,16 @@ module DocSpring
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] output_formats Value to be assigned
+    def output_formats=(output_formats)
+      if output_formats.nil?
+        fail ArgumentError, 'output_formats cannot be nil'
+      end
+
+      @output_formats = output_formats
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -194,6 +215,7 @@ module DocSpring
           data == o.data &&
           metadata == o.metadata &&
           password == o.password &&
+          output_formats == o.output_formats &&
           expires_in == o.expires_in &&
           field_overrides == o.field_overrides &&
           html == o.html &&
@@ -210,7 +232,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [test, editable, data, metadata, password, expires_in, field_overrides, html, css, signature_requests].hash
+      [test, editable, data, metadata, password, output_formats, expires_in, field_overrides, html, css, signature_requests].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/create_template_request.rb

@@ -100,6 +100,12 @@ module DocSpring
     # The template's conditional logic rules. Setting them replaces all of the rules.
     attr_accessor :field_dependencies
 
+    # The field names that people using the embedded template editor choose from, each with the data type and settings a field gets when it's given that name. Setting it replaces the whole list; an empty list turns them off.
+    attr_accessor :predefined_fields
+
+    # Sample submission data that sets `predefined_fields`: each value becomes a predefined field, with a type that fits it (`string`, `number`, `boolean`, `date`, `email` or `url`) and `required_in_template` true. Nested objects and arrays become names with `/`, such as `customer/email`. Without `predefined_fields` in the same request, it replaces them; with them, it adds to them and sets the types of the ones it has values for.
+    attr_accessor :predefined_fields_sample_data
+
     # The HTML of an HTML template, as a Liquid template. Null for PDF templates.
     attr_accessor :html
 
@@ -115,10 +121,16 @@ module DocSpring
     # Null resets the options to their defaults.
     attr_accessor :html_engine_options
 
-    # A PDF template's document: the `fields.key` of a file you uploaded with the presigned upload (GET /uploads/presign). Required for a PDF template. To upload the PDF with the request, use POST /templates/upload.
+    # A PDF template's document: the `fields.key` of a file you uploaded with the presigned upload (GET /uploads/presign). A PDF template needs one of `cache_id`, `document_url` and `document_base64`. To upload the PDF with the request, use POST /templates/upload.
     attr_accessor :cache_id
 
-    # The PDF's file name, for a `cache_id` (presigned uploads don't send one).
+    # An https:// link to the template's PDF (up to 100 MB), instead of `cache_id`. DocSpring downloads it after responding, following redirects to other https:// links: the template's `document.state` is `downloading` until then (sync.api hosts wait for it). If it can't be downloaded, the state is `download_failed` and `document.error_message` says why.
+    attr_accessor :document_url
+
+    # The template's PDF, encoded as base64 (a `data:` URI works too), instead of `cache_id`. Up to 7 MB before it's encoded: send a larger file with `cache_id` or `document_url`.
+    attr_accessor :document_base64
+
+    # The PDF's file name, for a `cache_id` (presigned uploads don't send one) or `document_base64`. A `document_url`'s is the last part of its path unless you set it.
     attr_accessor :filename
 
     # Set up the PDF's fields as DocSpring's "Automatically detect fields" upload option does: import or detect the fields, name them with AI, and set up conditional logic. `field_source`, `field_naming` and `field_logic` choose how. Default false. `document.page_processing_statuses` and `document.field_logic_status` show how it's going, and `document.state` becomes `processed` once every page's fields are set up.
@@ -186,12 +198,16 @@ module DocSpring
         :'slack_webhook_url' => :'slack_webhook_url',
         :'defaults' => :'defaults',
         :'field_dependencies' => :'field_dependencies',
+        :'predefined_fields' => :'predefined_fields',
+        :'predefined_fields_sample_data' => :'predefined_fields_sample_data',
         :'html' => :'html',
         :'scss' => :'scss',
         :'header_html' => :'header_html',
         :'footer_html' => :'footer_html',
         :'html_engine_options' => :'html_engine_options',
         :'cache_id' => :'cache_id',
+        :'document_url' => :'document_url',
+        :'document_base64' => :'document_base64',
         :'filename' => :'filename',
         :'detect_fields' => :'detect_fields',
         :'field_source' => :'field_source',
@@ -241,12 +257,16 @@ module DocSpring
         :'slack_webhook_url' => :'String',
         :'defaults' => :'TemplateDefaultsInput',
         :'field_dependencies' => :'Array<TemplateFieldDependencyInput>',
+        :'predefined_fields' => :'Array<PredefinedFieldInput>',
+        :'predefined_fields_sample_data' => :'Hash<String, Object>',
         :'html' => :'String',
         :'scss' => :'String',
         :'header_html' => :'String',
         :'footer_html' => :'String',
         :'html_engine_options' => :'HtmlEngineOptionsInput',
         :'cache_id' => :'String',
+        :'document_url' => :'String',
+        :'document_base64' => :'String',
         :'filename' => :'String',
         :'detect_fields' => :'Boolean',
         :'field_source' => :'FieldSetupSource',
@@ -263,6 +283,7 @@ module DocSpring
         :'encrypt_pdfs_password',
         :'redirect_url',
         :'slack_webhook_url',
+        :'predefined_fields_sample_data',
         :'html',
         :'scss',
         :'header_html',
@@ -415,6 +436,18 @@ module DocSpring
         end
       end
 
+      if attributes.key?(:'predefined_fields')
+        if (value = attributes[:'predefined_fields']).is_a?(Array)
+          self.predefined_fields = value
+        end
+      end
+
+      if attributes.key?(:'predefined_fields_sample_data')
+        if (value = attributes[:'predefined_fields_sample_data']).is_a?(Hash) || value.nil?
+          self.predefined_fields_sample_data = value
+        end
+      end
+
       if attributes.key?(:'html')
         self.html = attributes[:'html']
       end
@@ -439,6 +472,14 @@ module DocSpring
         self.cache_id = attributes[:'cache_id']
       end
 
+      if attributes.key?(:'document_url')
+        self.document_url = attributes[:'document_url']
+      end
+
+      if attributes.key?(:'document_base64')
+        self.document_base64 = attributes[:'document_base64']
+      end
+
       if attributes.key?(:'filename')
         self.filename = attributes[:'filename']
       end
@@ -523,12 +564,16 @@ module DocSpring
           slack_webhook_url == o.slack_webhook_url &&
           defaults == o.defaults &&
           field_dependencies == o.field_dependencies &&
+          predefined_fields == o.predefined_fields &&
+          predefined_fields_sample_data == o.predefined_fields_sample_data &&
           html == o.html &&
           scss == o.scss &&
           header_html == o.header_html &&
           footer_html == o.footer_html &&
           html_engine_options == o.html_engine_options &&
           cache_id == o.cache_id &&
+          document_url == o.document_url &&
+          document_base64 == o.document_base64 &&
           filename == o.filename &&
           detect_fields == o.detect_fields &&
           field_source == o.field_source &&
@@ -545,7 +590,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, template_type, parent_folder_id, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, slack_webhook_url, defaults, field_dependencies, html, scss, header_html, footer_html, html_engine_options, cache_id, filename, detect_fields, field_source, field_naming, field_logic].hash
+      [name, description, template_type, parent_folder_id, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, slack_webhook_url, defaults, field_dependencies, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, cache_id, document_url, document_base64, filename, detect_fields, field_source, field_naming, field_logic].hash
     end
 
     # Builds the object from hash