docspring 3.5.0 → 4.0.0

data/lib/docspring/models/html_engine_options.rb

@@ -0,0 +1,416 @@
+=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
+  # How an HTML template's PDFs are printed.
+  class HtmlEngineOptions < ApiModelBase
+    # The paper size. `Custom` uses `width` and `height`.
+    attr_accessor :format
+
+    # The page width for the `Custom` format, with a unit (`8.5in`, `210mm`).
+    attr_accessor :width
+
+    # The page height for the `Custom` format, with a unit.
+    attr_accessor :height
+
+    # How much to scale the page, such as `0.8`. `1` prints it at its normal size.
+    attr_accessor :scale
+
+    # Print pages in landscape orientation.
+    attr_accessor :landscape
+
+    # Print background colors and images.
+    attr_accessor :print_background
+
+    # The top margin, with a unit, such as `1in` or `20mm`.
+    attr_accessor :margin_top
+
+    # The bottom margin, with a unit.
+    attr_accessor :margin_bottom
+
+    # The left margin, with a unit.
+    attr_accessor :margin_left
+
+    # The right margin, with a unit.
+    attr_accessor :margin_right
+
+    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
+      {
+        :'format' => :'format',
+        :'width' => :'width',
+        :'height' => :'height',
+        :'scale' => :'scale',
+        :'landscape' => :'landscape',
+        :'print_background' => :'print_background',
+        :'margin_top' => :'margin_top',
+        :'margin_bottom' => :'margin_bottom',
+        :'margin_left' => :'margin_left',
+        :'margin_right' => :'margin_right'
+      }
+    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
+      {
+        :'format' => :'PageFormat',
+        :'width' => :'String',
+        :'height' => :'String',
+        :'scale' => :'Float',
+        :'landscape' => :'Boolean',
+        :'print_background' => :'Boolean',
+        :'margin_top' => :'String',
+        :'margin_bottom' => :'String',
+        :'margin_left' => :'String',
+        :'margin_right' => :'String'
+      }
+    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::HtmlEngineOptions` 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::HtmlEngineOptions`. 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?(:'format')
+        self.format = attributes[:'format']
+      else
+        self.format = nil
+      end
+
+      if attributes.key?(:'width')
+        self.width = attributes[:'width']
+      end
+
+      if attributes.key?(:'height')
+        self.height = attributes[:'height']
+      end
+
+      if attributes.key?(:'scale')
+        self.scale = attributes[:'scale']
+      else
+        self.scale = nil
+      end
+
+      if attributes.key?(:'landscape')
+        self.landscape = attributes[:'landscape']
+      else
+        self.landscape = nil
+      end
+
+      if attributes.key?(:'print_background')
+        self.print_background = attributes[:'print_background']
+      else
+        self.print_background = nil
+      end
+
+      if attributes.key?(:'margin_top')
+        self.margin_top = attributes[:'margin_top']
+      else
+        self.margin_top = nil
+      end
+
+      if attributes.key?(:'margin_bottom')
+        self.margin_bottom = attributes[:'margin_bottom']
+      else
+        self.margin_bottom = nil
+      end
+
+      if attributes.key?(:'margin_left')
+        self.margin_left = attributes[:'margin_left']
+      else
+        self.margin_left = nil
+      end
+
+      if attributes.key?(:'margin_right')
+        self.margin_right = attributes[:'margin_right']
+      else
+        self.margin_right = 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 @format.nil?
+        invalid_properties.push('invalid value for "format", format cannot be nil.')
+      end
+
+      if @scale.nil?
+        invalid_properties.push('invalid value for "scale", scale cannot be nil.')
+      end
+
+      if @landscape.nil?
+        invalid_properties.push('invalid value for "landscape", landscape cannot be nil.')
+      end
+
+      if @print_background.nil?
+        invalid_properties.push('invalid value for "print_background", print_background cannot be nil.')
+      end
+
+      if @margin_top.nil?
+        invalid_properties.push('invalid value for "margin_top", margin_top cannot be nil.')
+      end
+
+      if @margin_bottom.nil?
+        invalid_properties.push('invalid value for "margin_bottom", margin_bottom cannot be nil.')
+      end
+
+      if @margin_left.nil?
+        invalid_properties.push('invalid value for "margin_left", margin_left cannot be nil.')
+      end
+
+      if @margin_right.nil?
+        invalid_properties.push('invalid value for "margin_right", margin_right 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 @format.nil?
+      return false if @scale.nil?
+      return false if @landscape.nil?
+      return false if @print_background.nil?
+      return false if @margin_top.nil?
+      return false if @margin_bottom.nil?
+      return false if @margin_left.nil?
+      return false if @margin_right.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] format Value to be assigned
+    def format=(format)
+      if format.nil?
+        fail ArgumentError, 'format cannot be nil'
+      end
+
+      @format = format
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] scale Value to be assigned
+    def scale=(scale)
+      if scale.nil?
+        fail ArgumentError, 'scale cannot be nil'
+      end
+
+      @scale = scale
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] landscape Value to be assigned
+    def landscape=(landscape)
+      if landscape.nil?
+        fail ArgumentError, 'landscape cannot be nil'
+      end
+
+      @landscape = landscape
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] print_background Value to be assigned
+    def print_background=(print_background)
+      if print_background.nil?
+        fail ArgumentError, 'print_background cannot be nil'
+      end
+
+      @print_background = print_background
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] margin_top Value to be assigned
+    def margin_top=(margin_top)
+      if margin_top.nil?
+        fail ArgumentError, 'margin_top cannot be nil'
+      end
+
+      @margin_top = margin_top
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] margin_bottom Value to be assigned
+    def margin_bottom=(margin_bottom)
+      if margin_bottom.nil?
+        fail ArgumentError, 'margin_bottom cannot be nil'
+      end
+
+      @margin_bottom = margin_bottom
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] margin_left Value to be assigned
+    def margin_left=(margin_left)
+      if margin_left.nil?
+        fail ArgumentError, 'margin_left cannot be nil'
+      end
+
+      @margin_left = margin_left
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] margin_right Value to be assigned
+    def margin_right=(margin_right)
+      if margin_right.nil?
+        fail ArgumentError, 'margin_right cannot be nil'
+      end
+
+      @margin_right = margin_right
+    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 &&
+          format == o.format &&
+          width == o.width &&
+          height == o.height &&
+          scale == o.scale &&
+          landscape == o.landscape &&
+          print_background == o.print_background &&
+          margin_top == o.margin_top &&
+          margin_bottom == o.margin_bottom &&
+          margin_left == o.margin_left &&
+          margin_right == o.margin_right
+    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
+      [format, width, height, scale, landscape, print_background, margin_top, margin_bottom, margin_left, margin_right].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/html_engine_options_input.rb

@@ -0,0 +1,280 @@
+=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
+  # How an HTML template's PDFs are printed.
+  class HtmlEngineOptionsInput < ApiModelBase
+    # The paper size. `Custom` uses `width` and `height`.
+    attr_accessor :format
+
+    # The page width for the `Custom` format, with a unit (`8.5in`, `210mm`).
+    attr_accessor :width
+
+    # The page height for the `Custom` format, with a unit.
+    attr_accessor :height
+
+    # How much to scale the page, such as `0.8`. `1` prints it at its normal size.
+    attr_accessor :scale
+
+    # Print pages in landscape orientation.
+    attr_accessor :landscape
+
+    # Print background colors and images.
+    attr_accessor :print_background
+
+    # The top margin, with a unit, such as `1in` or `20mm`.
+    attr_accessor :margin_top
+
+    # The bottom margin, with a unit.
+    attr_accessor :margin_bottom
+
+    # The left margin, with a unit.
+    attr_accessor :margin_left
+
+    # The right margin, with a unit.
+    attr_accessor :margin_right
+
+    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
+      {
+        :'format' => :'format',
+        :'width' => :'width',
+        :'height' => :'height',
+        :'scale' => :'scale',
+        :'landscape' => :'landscape',
+        :'print_background' => :'print_background',
+        :'margin_top' => :'margin_top',
+        :'margin_bottom' => :'margin_bottom',
+        :'margin_left' => :'margin_left',
+        :'margin_right' => :'margin_right'
+      }
+    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
+      {
+        :'format' => :'PageFormat',
+        :'width' => :'String',
+        :'height' => :'String',
+        :'scale' => :'Float',
+        :'landscape' => :'Boolean',
+        :'print_background' => :'Boolean',
+        :'margin_top' => :'String',
+        :'margin_bottom' => :'String',
+        :'margin_left' => :'String',
+        :'margin_right' => :'String'
+      }
+    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::HtmlEngineOptionsInput` 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::HtmlEngineOptionsInput`. 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?(:'format')
+        self.format = attributes[:'format']
+      end
+
+      if attributes.key?(:'width')
+        self.width = attributes[:'width']
+      end
+
+      if attributes.key?(:'height')
+        self.height = attributes[:'height']
+      end
+
+      if attributes.key?(:'scale')
+        self.scale = attributes[:'scale']
+      end
+
+      if attributes.key?(:'landscape')
+        self.landscape = attributes[:'landscape']
+      end
+
+      if attributes.key?(:'print_background')
+        self.print_background = attributes[:'print_background']
+      end
+
+      if attributes.key?(:'margin_top')
+        self.margin_top = attributes[:'margin_top']
+      end
+
+      if attributes.key?(:'margin_bottom')
+        self.margin_bottom = attributes[:'margin_bottom']
+      end
+
+      if attributes.key?(:'margin_left')
+        self.margin_left = attributes[:'margin_left']
+      end
+
+      if attributes.key?(:'margin_right')
+        self.margin_right = attributes[:'margin_right']
+      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
+      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'
+      true
+    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 &&
+          format == o.format &&
+          width == o.width &&
+          height == o.height &&
+          scale == o.scale &&
+          landscape == o.landscape &&
+          print_background == o.print_background &&
+          margin_top == o.margin_top &&
+          margin_bottom == o.margin_bottom &&
+          margin_left == o.margin_left &&
+          margin_right == o.margin_right
+    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
+      [format, width, height, scale, landscape, print_background, margin_top, margin_bottom, margin_left, margin_right].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