docspring 3.5.0 → 4.1.0

data/lib/docspring/models/template_actor.rb

@@ -0,0 +1,259 @@
+=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
+  # A user in your account, an API token, or someone using the embedded template editor.
+  class TemplateActor < ApiModelBase
+    # `user`: a user in your account. `api`: an API token. `external_user`: someone using the embedded template editor, as identified by your app.
+    attr_accessor :type
+
+    # The user's ID, for `user`.
+    attr_accessor :user_id
+
+    # The ID your app gave the embedded editor's user, for `external_user`.
+    attr_accessor :external_id
+
+    # The user's name, or the name your app gave the embedded editor's user.
+    attr_accessor :name
+
+    # The email address your app gave the embedded editor's user, for `external_user`.
+    attr_accessor :email
+
+    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
+      {
+        :'type' => :'type',
+        :'user_id' => :'user_id',
+        :'external_id' => :'external_id',
+        :'name' => :'name',
+        :'email' => :'email'
+      }
+    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
+      {
+        :'type' => :'TemplateActorType',
+        :'user_id' => :'String',
+        :'external_id' => :'String',
+        :'name' => :'String',
+        :'email' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'user_id',
+        :'external_id',
+        :'name',
+        :'email'
+      ])
+    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::TemplateActor` 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::TemplateActor`. 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?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      else
+        self.user_id = nil
+      end
+
+      if attributes.key?(:'external_id')
+        self.external_id = attributes[:'external_id']
+      else
+        self.external_id = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      else
+        self.email = 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 @type.nil?
+        invalid_properties.push('invalid value for "type", 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 @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] type Value to be assigned
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'type cannot be nil'
+      end
+
+      @type = 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 &&
+          type == o.type &&
+          user_id == o.user_id &&
+          external_id == o.external_id &&
+          name == o.name &&
+          email == o.email
+    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
+      [type, user_id, external_id, name, email].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/template_actor_type.rb

@@ -0,0 +1,42 @@
+=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
+  class TemplateActorType
+    USER = "user".freeze
+    API = "api".freeze
+    EXTERNAL_USER = "external_user".freeze
+
+    def self.all_vars
+      @all_vars ||= [USER, API, EXTERNAL_USER].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      # Only responses are built from hashes, and a value added to the API after this client was released is kept as it
+      # is: the constants are the values this client knows
+      value
+    end
+  end
+end

data/lib/docspring/models/template_defaults.rb

@@ -0,0 +1,395 @@
+=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 default style of the template's fields. Each field can override it.
+  class TemplateDefaults < ApiModelBase
+    # The font of text fields.
+    attr_accessor :typeface
+
+    # The font size in points, a whole number.
+    attr_accessor :font_size
+
+    # Extra space between characters, in points (0 to 50).
+    attr_accessor :character_spacing
+
+    # The text color, as 6 hex digits without `#`, such as `444444`.
+    attr_accessor :color
+
+    # The field's background color, as 6 hex digits.
+    attr_accessor :background_color
+
+    # Print text in bold.
+    attr_accessor :bold
+
+    # Print text in capital letters.
+    attr_accessor :uppercase
+
+    # How text is aligned in its field. `justify` lines up both edges of every line of multiline text except the last of each paragraph.
+    attr_accessor :alignment
+
+    # The opacity of the field's content, from 0 (invisible) to 1.
+    attr_accessor :opacity
+
+    # How date fields are printed, as a strftime format such as `%m/%d/%Y`.
+    attr_accessor :date_format
+
+    # How date-time fields are printed, as a strftime format such as `%m/%d/%Y %H:%M:%S`.
+    attr_accessor :date_time_format
+
+    # The color of check marks, as 6 hex digits.
+    attr_accessor :check_color
+
+    # The character that a ticked check box prints.
+    attr_accessor :check_character
+
+    # The check box's background color, as 6 hex digits.
+    attr_accessor :check_background_color
+
+    # The background color that highlights required fields on visual forms and signature request forms, as 6 hex digits. PDFs don't print it.
+    attr_accessor :required_field_background_color
+
+    # The text a boolean field prints for `true`.
+    attr_accessor :true_text
+
+    # The text a boolean field prints for `false`.
+    attr_accessor :false_text
+
+    # The fill color of shapes, as 6 hex digits.
+    attr_accessor :shape_fill_color
+
+    # The border color of shapes, as 6 hex digits.
+    attr_accessor :shape_border_color
+
+    # The border width of shapes, in whole points (at least 1).
+    attr_accessor :shape_border_width
+
+    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
+      {
+        :'typeface' => :'typeface',
+        :'font_size' => :'font_size',
+        :'character_spacing' => :'character_spacing',
+        :'color' => :'color',
+        :'background_color' => :'background_color',
+        :'bold' => :'bold',
+        :'uppercase' => :'uppercase',
+        :'alignment' => :'alignment',
+        :'opacity' => :'opacity',
+        :'date_format' => :'date_format',
+        :'date_time_format' => :'date_time_format',
+        :'check_color' => :'check_color',
+        :'check_character' => :'check_character',
+        :'check_background_color' => :'check_background_color',
+        :'required_field_background_color' => :'required_field_background_color',
+        :'true_text' => :'true_text',
+        :'false_text' => :'false_text',
+        :'shape_fill_color' => :'shape_fill_color',
+        :'shape_border_color' => :'shape_border_color',
+        :'shape_border_width' => :'shape_border_width'
+      }
+    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
+      {
+        :'typeface' => :'Typeface',
+        :'font_size' => :'Float',
+        :'character_spacing' => :'Float',
+        :'color' => :'String',
+        :'background_color' => :'String',
+        :'bold' => :'Boolean',
+        :'uppercase' => :'Boolean',
+        :'alignment' => :'TextAlignment',
+        :'opacity' => :'Float',
+        :'date_format' => :'String',
+        :'date_time_format' => :'String',
+        :'check_color' => :'String',
+        :'check_character' => :'CheckCharacter',
+        :'check_background_color' => :'String',
+        :'required_field_background_color' => :'String',
+        :'true_text' => :'String',
+        :'false_text' => :'String',
+        :'shape_fill_color' => :'String',
+        :'shape_border_color' => :'String',
+        :'shape_border_width' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'typeface',
+        :'font_size',
+        :'character_spacing',
+        :'color',
+        :'background_color',
+        :'date_format',
+        :'date_time_format',
+        :'check_color',
+        :'check_character',
+        :'check_background_color',
+        :'required_field_background_color',
+        :'true_text',
+        :'false_text',
+        :'shape_fill_color',
+        :'shape_border_color',
+      ])
+    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::TemplateDefaults` 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::TemplateDefaults`. 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?(:'typeface')
+        self.typeface = attributes[:'typeface']
+      end
+
+      if attributes.key?(:'font_size')
+        self.font_size = attributes[:'font_size']
+      end
+
+      if attributes.key?(:'character_spacing')
+        self.character_spacing = attributes[:'character_spacing']
+      end
+
+      if attributes.key?(:'color')
+        self.color = attributes[:'color']
+      end
+
+      if attributes.key?(:'background_color')
+        self.background_color = attributes[:'background_color']
+      end
+
+      if attributes.key?(:'bold')
+        self.bold = attributes[:'bold']
+      end
+
+      if attributes.key?(:'uppercase')
+        self.uppercase = attributes[:'uppercase']
+      end
+
+      if attributes.key?(:'alignment')
+        self.alignment = attributes[:'alignment']
+      end
+
+      if attributes.key?(:'opacity')
+        self.opacity = attributes[:'opacity']
+      end
+
+      if attributes.key?(:'date_format')
+        self.date_format = attributes[:'date_format']
+      end
+
+      if attributes.key?(:'date_time_format')
+        self.date_time_format = attributes[:'date_time_format']
+      end
+
+      if attributes.key?(:'check_color')
+        self.check_color = attributes[:'check_color']
+      end
+
+      if attributes.key?(:'check_character')
+        self.check_character = attributes[:'check_character']
+      end
+
+      if attributes.key?(:'check_background_color')
+        self.check_background_color = attributes[:'check_background_color']
+      end
+
+      if attributes.key?(:'required_field_background_color')
+        self.required_field_background_color = attributes[:'required_field_background_color']
+      end
+
+      if attributes.key?(:'true_text')
+        self.true_text = attributes[:'true_text']
+      end
+
+      if attributes.key?(:'false_text')
+        self.false_text = attributes[:'false_text']
+      end
+
+      if attributes.key?(:'shape_fill_color')
+        self.shape_fill_color = attributes[:'shape_fill_color']
+      end
+
+      if attributes.key?(:'shape_border_color')
+        self.shape_border_color = attributes[:'shape_border_color']
+      end
+
+      if attributes.key?(:'shape_border_width')
+        self.shape_border_width = attributes[:'shape_border_width']
+      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 &&
+          typeface == o.typeface &&
+          font_size == o.font_size &&
+          character_spacing == o.character_spacing &&
+          color == o.color &&
+          background_color == o.background_color &&
+          bold == o.bold &&
+          uppercase == o.uppercase &&
+          alignment == o.alignment &&
+          opacity == o.opacity &&
+          date_format == o.date_format &&
+          date_time_format == o.date_time_format &&
+          check_color == o.check_color &&
+          check_character == o.check_character &&
+          check_background_color == o.check_background_color &&
+          required_field_background_color == o.required_field_background_color &&
+          true_text == o.true_text &&
+          false_text == o.false_text &&
+          shape_fill_color == o.shape_fill_color &&
+          shape_border_color == o.shape_border_color &&
+          shape_border_width == o.shape_border_width
+    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
+      [typeface, font_size, character_spacing, color, background_color, bold, uppercase, alignment, opacity, date_format, date_time_format, check_color, check_character, check_background_color, required_field_background_color, true_text, false_text, shape_fill_color, shape_border_color, shape_border_width].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