docspring 3.2.0 → 3.3.0

data/lib/docspring/models/webhook.rb

@@ -0,0 +1,658 @@
+=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: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.16.0-DOCSPRING
+
+=end
+
+require 'date'
+require 'time'
+
+module DocSpring
+  class Webhook
+    attr_accessor :id
+
+    attr_accessor :name
+
+    attr_accessor :url
+
+    attr_accessor :enabled
+
+    attr_accessor :event_types
+
+    attr_accessor :mode
+
+    attr_accessor :version
+
+    attr_accessor :api_token_ids
+
+    attr_accessor :template_ids
+
+    attr_accessor :folder_ids
+
+    attr_accessor :include_submission_data
+
+    attr_accessor :strip_fields
+
+    attr_accessor :headers
+
+    attr_accessor :consecutive_failures
+
+    attr_accessor :last_failure_at
+
+    attr_accessor :disabled_at
+
+    attr_accessor :disabled_reason
+
+    attr_accessor :secret
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    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
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'url' => :'url',
+        :'enabled' => :'enabled',
+        :'event_types' => :'event_types',
+        :'mode' => :'mode',
+        :'version' => :'version',
+        :'api_token_ids' => :'api_token_ids',
+        :'template_ids' => :'template_ids',
+        :'folder_ids' => :'folder_ids',
+        :'include_submission_data' => :'include_submission_data',
+        :'strip_fields' => :'strip_fields',
+        :'headers' => :'headers',
+        :'consecutive_failures' => :'consecutive_failures',
+        :'last_failure_at' => :'last_failure_at',
+        :'disabled_at' => :'disabled_at',
+        :'disabled_reason' => :'disabled_reason',
+        :'secret' => :'secret',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'url' => :'String',
+        :'enabled' => :'Boolean',
+        :'event_types' => :'Array<String>',
+        :'mode' => :'String',
+        :'version' => :'Integer',
+        :'api_token_ids' => :'Array<String>',
+        :'template_ids' => :'Array<String>',
+        :'folder_ids' => :'Array<String>',
+        :'include_submission_data' => :'Boolean',
+        :'strip_fields' => :'Array<String>',
+        :'headers' => :'Hash<String, String>',
+        :'consecutive_failures' => :'Integer',
+        :'last_failure_at' => :'String',
+        :'disabled_at' => :'String',
+        :'disabled_reason' => :'String',
+        :'secret' => :'String',
+        :'created_at' => :'String',
+        :'updated_at' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'name',
+        :'url',
+        :'mode',
+        :'last_failure_at',
+        :'disabled_at',
+        :'disabled_reason',
+        :'secret',
+        :'created_at',
+        :'updated_at'
+      ])
+    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::Webhook` 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::Webhook`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      else
+        self.url = nil
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      else
+        self.enabled = nil
+      end
+
+      if attributes.key?(:'event_types')
+        if (value = attributes[:'event_types']).is_a?(Array)
+          self.event_types = value
+        end
+      else
+        self.event_types = nil
+      end
+
+      if attributes.key?(:'mode')
+        self.mode = attributes[:'mode']
+      else
+        self.mode = nil
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      else
+        self.version = nil
+      end
+
+      if attributes.key?(:'api_token_ids')
+        if (value = attributes[:'api_token_ids']).is_a?(Array)
+          self.api_token_ids = value
+        end
+      else
+        self.api_token_ids = nil
+      end
+
+      if attributes.key?(:'template_ids')
+        if (value = attributes[:'template_ids']).is_a?(Array)
+          self.template_ids = value
+        end
+      else
+        self.template_ids = nil
+      end
+
+      if attributes.key?(:'folder_ids')
+        if (value = attributes[:'folder_ids']).is_a?(Array)
+          self.folder_ids = value
+        end
+      else
+        self.folder_ids = nil
+      end
+
+      if attributes.key?(:'include_submission_data')
+        self.include_submission_data = attributes[:'include_submission_data']
+      else
+        self.include_submission_data = nil
+      end
+
+      if attributes.key?(:'strip_fields')
+        if (value = attributes[:'strip_fields']).is_a?(Array)
+          self.strip_fields = value
+        end
+      else
+        self.strip_fields = nil
+      end
+
+      if attributes.key?(:'headers')
+        if (value = attributes[:'headers']).is_a?(Hash)
+          self.headers = value
+        end
+      else
+        self.headers = nil
+      end
+
+      if attributes.key?(:'consecutive_failures')
+        self.consecutive_failures = attributes[:'consecutive_failures']
+      else
+        self.consecutive_failures = nil
+      end
+
+      if attributes.key?(:'last_failure_at')
+        self.last_failure_at = attributes[:'last_failure_at']
+      else
+        self.last_failure_at = nil
+      end
+
+      if attributes.key?(:'disabled_at')
+        self.disabled_at = attributes[:'disabled_at']
+      else
+        self.disabled_at = nil
+      end
+
+      if attributes.key?(:'disabled_reason')
+        self.disabled_reason = attributes[:'disabled_reason']
+      else
+        self.disabled_reason = nil
+      end
+
+      if attributes.key?(:'secret')
+        self.secret = attributes[:'secret']
+      else
+        self.secret = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = 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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @enabled.nil?
+        invalid_properties.push('invalid value for "enabled", enabled cannot be nil.')
+      end
+
+      if @event_types.nil?
+        invalid_properties.push('invalid value for "event_types", event_types cannot be nil.')
+      end
+
+      if @version.nil?
+        invalid_properties.push('invalid value for "version", version cannot be nil.')
+      end
+
+      if @api_token_ids.nil?
+        invalid_properties.push('invalid value for "api_token_ids", api_token_ids cannot be nil.')
+      end
+
+      if @template_ids.nil?
+        invalid_properties.push('invalid value for "template_ids", template_ids cannot be nil.')
+      end
+
+      if @folder_ids.nil?
+        invalid_properties.push('invalid value for "folder_ids", folder_ids cannot be nil.')
+      end
+
+      if @include_submission_data.nil?
+        invalid_properties.push('invalid value for "include_submission_data", include_submission_data cannot be nil.')
+      end
+
+      if @strip_fields.nil?
+        invalid_properties.push('invalid value for "strip_fields", strip_fields cannot be nil.')
+      end
+
+      if @headers.nil?
+        invalid_properties.push('invalid value for "headers", headers cannot be nil.')
+      end
+
+      if @consecutive_failures.nil?
+        invalid_properties.push('invalid value for "consecutive_failures", consecutive_failures 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 @id.nil?
+      return false if @enabled.nil?
+      return false if @event_types.nil?
+      mode_validator = EnumAttributeValidator.new('String', ["test", "live"])
+      return false unless mode_validator.valid?(@mode)
+      return false if @version.nil?
+      return false if @api_token_ids.nil?
+      return false if @template_ids.nil?
+      return false if @folder_ids.nil?
+      return false if @include_submission_data.nil?
+      return false if @strip_fields.nil?
+      return false if @headers.nil?
+      return false if @consecutive_failures.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] enabled Value to be assigned
+    def enabled=(enabled)
+      if enabled.nil?
+        fail ArgumentError, 'enabled cannot be nil'
+      end
+
+      @enabled = enabled
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] event_types Value to be assigned
+    def event_types=(event_types)
+      if event_types.nil?
+        fail ArgumentError, 'event_types cannot be nil'
+      end
+
+      @event_types = event_types
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] mode Object to be assigned
+    def mode=(mode)
+      validator = EnumAttributeValidator.new('String', ["test", "live"])
+      # build_from_hash accepts enum values this client doesn't know about yet
+      unless defined?(@_skip_enum_validation) || validator.valid?(mode)
+        fail ArgumentError, "invalid value for \"mode\", must be one of #{validator.allowable_values}."
+      end
+      @mode = mode
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] version Value to be assigned
+    def version=(version)
+      if version.nil?
+        fail ArgumentError, 'version cannot be nil'
+      end
+
+      @version = version
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] api_token_ids Value to be assigned
+    def api_token_ids=(api_token_ids)
+      if api_token_ids.nil?
+        fail ArgumentError, 'api_token_ids cannot be nil'
+      end
+
+      @api_token_ids = api_token_ids
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] template_ids Value to be assigned
+    def template_ids=(template_ids)
+      if template_ids.nil?
+        fail ArgumentError, 'template_ids cannot be nil'
+      end
+
+      @template_ids = template_ids
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] folder_ids Value to be assigned
+    def folder_ids=(folder_ids)
+      if folder_ids.nil?
+        fail ArgumentError, 'folder_ids cannot be nil'
+      end
+
+      @folder_ids = folder_ids
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] include_submission_data Value to be assigned
+    def include_submission_data=(include_submission_data)
+      if include_submission_data.nil?
+        fail ArgumentError, 'include_submission_data cannot be nil'
+      end
+
+      @include_submission_data = include_submission_data
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] strip_fields Value to be assigned
+    def strip_fields=(strip_fields)
+      if strip_fields.nil?
+        fail ArgumentError, 'strip_fields cannot be nil'
+      end
+
+      @strip_fields = strip_fields
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] headers Value to be assigned
+    def headers=(headers)
+      if headers.nil?
+        fail ArgumentError, 'headers cannot be nil'
+      end
+
+      @headers = headers
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] consecutive_failures Value to be assigned
+    def consecutive_failures=(consecutive_failures)
+      if consecutive_failures.nil?
+        fail ArgumentError, 'consecutive_failures cannot be nil'
+      end
+
+      @consecutive_failures = consecutive_failures
+    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 &&
+          id == o.id &&
+          name == o.name &&
+          url == o.url &&
+          enabled == o.enabled &&
+          event_types == o.event_types &&
+          mode == o.mode &&
+          version == o.version &&
+          api_token_ids == o.api_token_ids &&
+          template_ids == o.template_ids &&
+          folder_ids == o.folder_ids &&
+          include_submission_data == o.include_submission_data &&
+          strip_fields == o.strip_fields &&
+          headers == o.headers &&
+          consecutive_failures == o.consecutive_failures &&
+          last_failure_at == o.last_failure_at &&
+          disabled_at == o.disabled_at &&
+          disabled_reason == o.disabled_reason &&
+          secret == o.secret &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    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
+      [id, name, url, enabled, event_types, mode, version, api_token_ids, template_ids, folder_ids, include_submission_data, strip_fields, headers, consecutive_failures, last_failure_at, disabled_at, disabled_reason, secret, created_at, updated_at].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)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = DocSpring.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/docspring/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.16.0-DOCSPRING
 =end
 
 module DocSpring
-  VERSION = '3.2.0'
+  VERSION = '3.3.0'
 end

data/lib/docspring.rb

@@ -36,6 +36,7 @@ require 'docspring/models/create_submission_data_request_event_response'
 require 'docspring/models/create_submission_data_request_response'
 require 'docspring/models/create_submission_data_request_token_response'
 require 'docspring/models/create_submission_response'
+require 'docspring/models/create_webhook_data'
 require 'docspring/models/custom_file'
 require 'docspring/models/error_or_multiple_errors_response'
 require 'docspring/models/error_response'
@@ -64,12 +65,15 @@ require 'docspring/models/success_multiple_errors_response'
 require 'docspring/models/template'
 require 'docspring/models/template_add_fields_response'
 require 'docspring/models/template_delete_response'
+require 'docspring/models/template_model_code_response'
 require 'docspring/models/template_preview'
 require 'docspring/models/template_publish_version_response'
 require 'docspring/models/update_html_template'
 require 'docspring/models/update_pdf_template'
 require 'docspring/models/update_submission_data_request_data'
+require 'docspring/models/update_webhook_data'
 require 'docspring/models/upload_presign_response'
+require 'docspring/models/webhook'
 
 # APIs
 require 'docspring/api/client'