docspring 3.5.0 → 4.0.0

data/lib/docspring/models/create_template_request.rb

@@ -0,0 +1,601 @@
+=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 template to create.
+  class CreateTemplateRequest < ApiModelBase
+    # The template's name.
+    attr_accessor :name
+
+    # Shown under the template's name at the top of its hosted forms, and used as their meta description. Not shown on embedded forms or signature requests.
+    attr_accessor :description
+
+    # `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. It can't be changed after the template is created.
+    attr_accessor :template_type
+
+    # The ID of the folder the template is in. Null for a template at the root. Setting it moves the template and all of its published versions.
+    attr_accessor :parent_folder_id
+
+    # A locked template can't be changed or deleted until it's unlocked (`locked` can always be changed).
+    attr_accessor :locked
+
+    # Print the submission ID in the footer of each page of PDFs signed through signature requests.
+    attr_accessor :add_signature_request_submission_id_footers
+
+    # The language AI field setup names fields in: `auto` uses the form's language when it's written in the Latin alphabet without accents, and English otherwise; `english` always uses English; `form_language` uses the form's language and script. New templates take it from your account's template settings. Null for HTML templates.
+    attr_accessor :ai_field_naming_language
+
+    # Accept submission data with properties that aren't fields of the template.
+    attr_accessor :allow_additional_properties
+
+    # Visual forms and signature request forms show the Continue button as soon as the required fields are filled in, without visiting each optional field. The `allowSkippingOptionalFields` embed option overrides it.
+    attr_accessor :allow_skipping_optional_fields
+
+    # The hosted form that /templates/{template_id}/form shows when its URL has no `mode` parameter: `web` (the web form), `visual` (the visual form, where fields are filled in on the PDF) or `dual` (both, in tabs). HTML templates have no visual form, so `web` is the only value they accept.
+    attr_accessor :default_form_mode
+
+    # Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it.
+    attr_accessor :editable_submissions
+
+    # The sites where the template's signature requests, forms and embedded template editor can be loaded: a host such as `app.example.com`, with an optional leading wildcard (`*.example.com`), port (`localhost:3000`) or scheme (`https://app.example.com`; without one, `http` and `https` both work). When it's empty, live signature requests don't load on any site, and the embedded template editor loads on every site.
+    attr_accessor :embed_domains
+
+    # Allow the embedded template editor to change sensitive template settings (webhooks, redirect URL, encryption, public access, expiration and so on).
+    attr_accessor :embed_edit_allow_settings
+
+    # Allow the embedded template editor to publish, restore, compare and delete published versions.
+    attr_accessor :embed_edit_allow_versioning
+
+    # Allow the embedded template editor to replace the template's PDF.
+    attr_accessor :embed_edit_allow_document_replacement
+
+    # Encrypt generated PDFs with `encrypt_pdfs_password`.
+    attr_accessor :encrypt_pdfs
+
+    # The password that opens encrypted PDFs. It's never returned; `has_encrypt_pdfs_password` says if it's set.
+    attr_accessor :encrypt_pdfs_password
+
+    # Delete each submission's data and PDF after `expire_after` `expiration_interval`.
+    attr_accessor :expire_submissions
+
+    # How many `expiration_interval`s a submission's data and PDF are kept for, when `expire_submissions` is on. At most 5256000 (10 years in minutes).
+    attr_accessor :expire_after
+
+    # The unit of `expire_after`.
+    attr_accessor :expiration_interval
+
+    # Add the audit trail to the end of PDFs signed through signature requests.
+    attr_accessor :merge_audit_trail_pdf
+
+    # Date fields also accept NN/NN/YYYY dates (with slashes, dashes or dots), read in the order of the template's default date format: month first for %m/%d/%Y, day first for %d/%m/%Y. When false, date fields only accept YYYY-MM-DD. Applies to PDF templates: an HTML template's date fields only accept YYYY-MM-DD. Date fields that include a time take RFC 3339 date-times either way.
+    attr_accessor :parse_dates_using_template_date_format
+
+    # Allow anyone with a submission's ID to download its PDF.
+    attr_accessor :public_submissions
+
+    # Allow anyone to fill in the template's web form.
+    attr_accessor :public_web_form
+
+    # Where the web form sends people after they submit it.
+    attr_accessor :redirect_url
+
+    # A Slack incoming webhook URL that is notified about the template's submissions. It's never returned; `has_slack_webhook_url` says if it's set.
+    attr_accessor :slack_webhook_url
+
+    # The default style of the template's fields. Setting it replaces the whole object.
+    attr_accessor :defaults
+
+    # The template's conditional logic rules. Setting them replaces all of the rules.
+    attr_accessor :field_dependencies
+
+    # The HTML of an HTML template, as a Liquid template. Null for PDF templates.
+    attr_accessor :html
+
+    # The SCSS of an HTML template.
+    attr_accessor :scss
+
+    # The HTML printed at the top of each page of an HTML template.
+    attr_accessor :header_html
+
+    # The HTML printed at the bottom of each page of an HTML template.
+    attr_accessor :footer_html
+
+    # 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.
+    attr_accessor :cache_id
+
+    # The PDF's file name, for a `cache_id` (presigned uploads don't send one).
+    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.
+    attr_accessor :detect_fields
+
+    # With `detect_fields`, where the fields come from. `auto` (the default) imports the form fields of a fillable PDF and detects the fields of a PDF without them; `pdf_detection` detects the fields from the page layout, even on a fillable PDF; `pdf_form_fields` only imports the PDF's form fields.
+    attr_accessor :field_source
+
+    # With `detect_fields`, how the fields are named. `ai` (the default) names them and sets their types and settings with AI; `preserve` keeps the names of the PDF's form fields, and AI only names the fields it detected. `preserve` needs `field_source` `auto` or `pdf_form_fields`.
+    attr_accessor :field_naming
+
+    # With `detect_fields`, whether AI reads the whole form once the fields are named and sets up conditional logic and required fields (`ai`) or not (`none`). Default: your account's template settings.
+    attr_accessor :field_logic
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'description' => :'description',
+        :'template_type' => :'template_type',
+        :'parent_folder_id' => :'parent_folder_id',
+        :'locked' => :'locked',
+        :'add_signature_request_submission_id_footers' => :'add_signature_request_submission_id_footers',
+        :'ai_field_naming_language' => :'ai_field_naming_language',
+        :'allow_additional_properties' => :'allow_additional_properties',
+        :'allow_skipping_optional_fields' => :'allow_skipping_optional_fields',
+        :'default_form_mode' => :'default_form_mode',
+        :'editable_submissions' => :'editable_submissions',
+        :'embed_domains' => :'embed_domains',
+        :'embed_edit_allow_settings' => :'embed_edit_allow_settings',
+        :'embed_edit_allow_versioning' => :'embed_edit_allow_versioning',
+        :'embed_edit_allow_document_replacement' => :'embed_edit_allow_document_replacement',
+        :'encrypt_pdfs' => :'encrypt_pdfs',
+        :'encrypt_pdfs_password' => :'encrypt_pdfs_password',
+        :'expire_submissions' => :'expire_submissions',
+        :'expire_after' => :'expire_after',
+        :'expiration_interval' => :'expiration_interval',
+        :'merge_audit_trail_pdf' => :'merge_audit_trail_pdf',
+        :'parse_dates_using_template_date_format' => :'parse_dates_using_template_date_format',
+        :'public_submissions' => :'public_submissions',
+        :'public_web_form' => :'public_web_form',
+        :'redirect_url' => :'redirect_url',
+        :'slack_webhook_url' => :'slack_webhook_url',
+        :'defaults' => :'defaults',
+        :'field_dependencies' => :'field_dependencies',
+        :'html' => :'html',
+        :'scss' => :'scss',
+        :'header_html' => :'header_html',
+        :'footer_html' => :'footer_html',
+        :'html_engine_options' => :'html_engine_options',
+        :'cache_id' => :'cache_id',
+        :'filename' => :'filename',
+        :'detect_fields' => :'detect_fields',
+        :'field_source' => :'field_source',
+        :'field_naming' => :'field_naming',
+        :'field_logic' => :'field_logic'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'description' => :'String',
+        :'template_type' => :'TemplateType',
+        :'parent_folder_id' => :'String',
+        :'locked' => :'Boolean',
+        :'add_signature_request_submission_id_footers' => :'Boolean',
+        :'ai_field_naming_language' => :'AiFieldNamingLanguage',
+        :'allow_additional_properties' => :'Boolean',
+        :'allow_skipping_optional_fields' => :'Boolean',
+        :'default_form_mode' => :'TemplateFormMode',
+        :'editable_submissions' => :'Boolean',
+        :'embed_domains' => :'Array<String>',
+        :'embed_edit_allow_settings' => :'Boolean',
+        :'embed_edit_allow_versioning' => :'Boolean',
+        :'embed_edit_allow_document_replacement' => :'Boolean',
+        :'encrypt_pdfs' => :'Boolean',
+        :'encrypt_pdfs_password' => :'String',
+        :'expire_submissions' => :'Boolean',
+        :'expire_after' => :'Integer',
+        :'expiration_interval' => :'ExpirationInterval',
+        :'merge_audit_trail_pdf' => :'Boolean',
+        :'parse_dates_using_template_date_format' => :'Boolean',
+        :'public_submissions' => :'Boolean',
+        :'public_web_form' => :'Boolean',
+        :'redirect_url' => :'String',
+        :'slack_webhook_url' => :'String',
+        :'defaults' => :'TemplateDefaultsInput',
+        :'field_dependencies' => :'Array<TemplateFieldDependencyInput>',
+        :'html' => :'String',
+        :'scss' => :'String',
+        :'header_html' => :'String',
+        :'footer_html' => :'String',
+        :'html_engine_options' => :'HtmlEngineOptionsInput',
+        :'cache_id' => :'String',
+        :'filename' => :'String',
+        :'detect_fields' => :'Boolean',
+        :'field_source' => :'FieldSetupSource',
+        :'field_naming' => :'FieldSetupNaming',
+        :'field_logic' => :'FieldSetupLogic'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'description',
+        :'parent_folder_id',
+        :'encrypt_pdfs_password',
+        :'redirect_url',
+        :'slack_webhook_url',
+        :'html',
+        :'scss',
+        :'header_html',
+        :'footer_html',
+        :'html_engine_options',
+      ])
+    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::CreateTemplateRequest` 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::CreateTemplateRequest`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'template_type')
+        self.template_type = attributes[:'template_type']
+      else
+        self.template_type = nil
+      end
+
+      if attributes.key?(:'parent_folder_id')
+        self.parent_folder_id = attributes[:'parent_folder_id']
+      end
+
+      if attributes.key?(:'locked')
+        self.locked = attributes[:'locked']
+      end
+
+      if attributes.key?(:'add_signature_request_submission_id_footers')
+        self.add_signature_request_submission_id_footers = attributes[:'add_signature_request_submission_id_footers']
+      end
+
+      if attributes.key?(:'ai_field_naming_language')
+        self.ai_field_naming_language = attributes[:'ai_field_naming_language']
+      end
+
+      if attributes.key?(:'allow_additional_properties')
+        self.allow_additional_properties = attributes[:'allow_additional_properties']
+      end
+
+      if attributes.key?(:'allow_skipping_optional_fields')
+        self.allow_skipping_optional_fields = attributes[:'allow_skipping_optional_fields']
+      end
+
+      if attributes.key?(:'default_form_mode')
+        self.default_form_mode = attributes[:'default_form_mode']
+      end
+
+      if attributes.key?(:'editable_submissions')
+        self.editable_submissions = attributes[:'editable_submissions']
+      end
+
+      if attributes.key?(:'embed_domains')
+        if (value = attributes[:'embed_domains']).is_a?(Array)
+          self.embed_domains = value
+        end
+      end
+
+      if attributes.key?(:'embed_edit_allow_settings')
+        self.embed_edit_allow_settings = attributes[:'embed_edit_allow_settings']
+      end
+
+      if attributes.key?(:'embed_edit_allow_versioning')
+        self.embed_edit_allow_versioning = attributes[:'embed_edit_allow_versioning']
+      end
+
+      if attributes.key?(:'embed_edit_allow_document_replacement')
+        self.embed_edit_allow_document_replacement = attributes[:'embed_edit_allow_document_replacement']
+      end
+
+      if attributes.key?(:'encrypt_pdfs')
+        self.encrypt_pdfs = attributes[:'encrypt_pdfs']
+      end
+
+      if attributes.key?(:'encrypt_pdfs_password')
+        self.encrypt_pdfs_password = attributes[:'encrypt_pdfs_password']
+      end
+
+      if attributes.key?(:'expire_submissions')
+        self.expire_submissions = attributes[:'expire_submissions']
+      end
+
+      if attributes.key?(:'expire_after')
+        self.expire_after = attributes[:'expire_after']
+      end
+
+      if attributes.key?(:'expiration_interval')
+        self.expiration_interval = attributes[:'expiration_interval']
+      end
+
+      if attributes.key?(:'merge_audit_trail_pdf')
+        self.merge_audit_trail_pdf = attributes[:'merge_audit_trail_pdf']
+      end
+
+      if attributes.key?(:'parse_dates_using_template_date_format')
+        self.parse_dates_using_template_date_format = attributes[:'parse_dates_using_template_date_format']
+      end
+
+      if attributes.key?(:'public_submissions')
+        self.public_submissions = attributes[:'public_submissions']
+      end
+
+      if attributes.key?(:'public_web_form')
+        self.public_web_form = attributes[:'public_web_form']
+      end
+
+      if attributes.key?(:'redirect_url')
+        self.redirect_url = attributes[:'redirect_url']
+      end
+
+      if attributes.key?(:'slack_webhook_url')
+        self.slack_webhook_url = attributes[:'slack_webhook_url']
+      end
+
+      if attributes.key?(:'defaults')
+        self.defaults = attributes[:'defaults']
+      end
+
+      if attributes.key?(:'field_dependencies')
+        if (value = attributes[:'field_dependencies']).is_a?(Array)
+          self.field_dependencies = value
+        end
+      end
+
+      if attributes.key?(:'html')
+        self.html = attributes[:'html']
+      end
+
+      if attributes.key?(:'scss')
+        self.scss = attributes[:'scss']
+      end
+
+      if attributes.key?(:'header_html')
+        self.header_html = attributes[:'header_html']
+      end
+
+      if attributes.key?(:'footer_html')
+        self.footer_html = attributes[:'footer_html']
+      end
+
+      if attributes.key?(:'html_engine_options')
+        self.html_engine_options = attributes[:'html_engine_options']
+      end
+
+      if attributes.key?(:'cache_id')
+        self.cache_id = attributes[:'cache_id']
+      end
+
+      if attributes.key?(:'filename')
+        self.filename = attributes[:'filename']
+      end
+
+      if attributes.key?(:'detect_fields')
+        self.detect_fields = attributes[:'detect_fields']
+      end
+
+      if attributes.key?(:'field_source')
+        self.field_source = attributes[:'field_source']
+      end
+
+      if attributes.key?(:'field_naming')
+        self.field_naming = attributes[:'field_naming']
+      end
+
+      if attributes.key?(:'field_logic')
+        self.field_logic = attributes[:'field_logic']
+      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 @template_type.nil?
+        invalid_properties.push('invalid value for "template_type", template_type 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 @template_type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] template_type Value to be assigned
+    def template_type=(template_type)
+      if template_type.nil?
+        fail ArgumentError, 'template_type cannot be nil'
+      end
+
+      @template_type = template_type
+    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 &&
+          name == o.name &&
+          description == o.description &&
+          template_type == o.template_type &&
+          parent_folder_id == o.parent_folder_id &&
+          locked == o.locked &&
+          add_signature_request_submission_id_footers == o.add_signature_request_submission_id_footers &&
+          ai_field_naming_language == o.ai_field_naming_language &&
+          allow_additional_properties == o.allow_additional_properties &&
+          allow_skipping_optional_fields == o.allow_skipping_optional_fields &&
+          default_form_mode == o.default_form_mode &&
+          editable_submissions == o.editable_submissions &&
+          embed_domains == o.embed_domains &&
+          embed_edit_allow_settings == o.embed_edit_allow_settings &&
+          embed_edit_allow_versioning == o.embed_edit_allow_versioning &&
+          embed_edit_allow_document_replacement == o.embed_edit_allow_document_replacement &&
+          encrypt_pdfs == o.encrypt_pdfs &&
+          encrypt_pdfs_password == o.encrypt_pdfs_password &&
+          expire_submissions == o.expire_submissions &&
+          expire_after == o.expire_after &&
+          expiration_interval == o.expiration_interval &&
+          merge_audit_trail_pdf == o.merge_audit_trail_pdf &&
+          parse_dates_using_template_date_format == o.parse_dates_using_template_date_format &&
+          public_submissions == o.public_submissions &&
+          public_web_form == o.public_web_form &&
+          redirect_url == o.redirect_url &&
+          slack_webhook_url == o.slack_webhook_url &&
+          defaults == o.defaults &&
+          field_dependencies == o.field_dependencies &&
+          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 &&
+          filename == o.filename &&
+          detect_fields == o.detect_fields &&
+          field_source == o.field_source &&
+          field_naming == o.field_naming &&
+          field_logic == o.field_logic
+    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
+      [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
+    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