docspring 3.5.0 → 4.1.0

data/lib/docspring/models/update_webhook_request.rb

@@ -0,0 +1,344 @@
+=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 settings to change. Properties left out keep their values.
+  class UpdateWebhookRequest < ApiModelBase
+    # A name for the webhook, shown in the dashboard.
+    attr_accessor :name
+
+    # The endpoint that receives webhook POST requests.
+    attr_accessor :url
+
+    # Whether DocSpring sends events to the webhook. Webhooks are disabled after repeated failures.
+    attr_accessor :enabled
+
+    # The events the webhook subscribes to. A webhook made in the dashboard can also subscribe to API token, account integration and user events, which are listed with their own names.
+    attr_accessor :event_types
+
+    # Only send events for test or live submissions. Null sends both.
+    attr_accessor :mode
+
+    # Only send events from these API tokens. Combined with the other scope lists using OR. Applies to submission, signature request, combined PDF, submission batch and custom file events.
+    attr_accessor :api_token_ids
+
+    # Only send events for these templates. Combined with the other scope lists using OR. Applies to submission, signature request and template events.
+    attr_accessor :template_ids
+
+    # Only send events for templates in these folders, including their subfolders. Combined with the other scope lists using OR. Applies to submission, signature request, template and folder events.
+    attr_accessor :folder_ids
+
+    # Include the submission's field data in the payload. When false, the submission's data and truncated_text, and each signature request's data, ip_address and user_agent, are null.
+    attr_accessor :include_submission_data
+
+    # Dot-separated paths to remove from the event's data object. Form fields live under `data` (`data.ssn` removes the ssn field). A bare name removes a top-level key (`metadata` removes the whole metadata object).
+    attr_accessor :strip_fields
+
+    # Headers to send with each request.
+    attr_accessor :headers
+
+    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',
+        :'url' => :'url',
+        :'enabled' => :'enabled',
+        :'event_types' => :'event_types',
+        :'mode' => :'mode',
+        :'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'
+      }
+    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',
+        :'url' => :'String',
+        :'enabled' => :'Boolean',
+        :'event_types' => :'Array<WebhookEventType>',
+        :'mode' => :'WebhookMode',
+        :'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>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'name',
+        :'mode',
+      ])
+    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::UpdateWebhookRequest` 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::UpdateWebhookRequest`. 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?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      end
+
+      if attributes.key?(:'event_types')
+        if (value = attributes[:'event_types']).is_a?(Array)
+          self.event_types = value
+        end
+      end
+
+      if attributes.key?(:'mode')
+        self.mode = attributes[:'mode']
+      end
+
+      if attributes.key?(:'api_token_ids')
+        if (value = attributes[:'api_token_ids']).is_a?(Array)
+          self.api_token_ids = value
+        end
+      end
+
+      if attributes.key?(:'template_ids')
+        if (value = attributes[:'template_ids']).is_a?(Array)
+          self.template_ids = value
+        end
+      end
+
+      if attributes.key?(:'folder_ids')
+        if (value = attributes[:'folder_ids']).is_a?(Array)
+          self.folder_ids = value
+        end
+      end
+
+      if attributes.key?(:'include_submission_data')
+        self.include_submission_data = attributes[:'include_submission_data']
+      end
+
+      if attributes.key?(:'strip_fields')
+        if (value = attributes[:'strip_fields']).is_a?(Array)
+          self.strip_fields = value
+        end
+      end
+
+      if attributes.key?(:'headers')
+        if (value = attributes[:'headers']).is_a?(Hash)
+          self.headers = value
+        end
+      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
+
+    # 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 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
+
+    # 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 &&
+          url == o.url &&
+          enabled == o.enabled &&
+          event_types == o.event_types &&
+          mode == o.mode &&
+          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
+    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, url, enabled, event_types, mode, api_token_ids, template_ids, folder_ids, include_submission_data, strip_fields, headers].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/upload_method.rb

@@ -0,0 +1,40 @@
+=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 UploadMethod
+    POST = "post".freeze
+
+    def self.all_vars
+      @all_vars ||= [POST].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