docspring 3.5.0 → 4.0.0

data/lib/docspring/models/submission_action.rb

@@ -1,12 +1,12 @@
 =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. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
+#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
+The version of the OpenAPI document: v2
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.16.0-DOCSPRING
+Generator version: 7.26.0-DOCSPRING
 
 =end
 
@@ -14,19 +14,24 @@ require 'date'
 require 'time'
 
 module DocSpring
-  class SubmissionAction
+  # An upload of a PDF to your storage, such as an S3 bucket.
+  class SubmissionAction < ApiModelBase
+    # The upload's ID.
     attr_accessor :id
 
+    # The ID of the account integration it used.
     attr_accessor :integration_id
 
+    # `pending` until the upload has run, then `processed`. `failed`: your storage rejected it. `error`: it failed in DocSpring.
     attr_accessor :state
 
+    # The kind of storage, such as `aws_s3_upload` for an S3 bucket.
     attr_accessor :action_type
 
-    attr_accessor :action_category
-
+    # Where the PDF was uploaded, such as the S3 bucket and key.
     attr_accessor :result_data
 
+    # Why the upload failed, when `state` is `failed` or `error`.
     attr_accessor :error_message
 
     class EnumAttributeValidator
@@ -58,7 +63,6 @@ module DocSpring
         :'integration_id' => :'integration_id',
         :'state' => :'state',
         :'action_type' => :'action_type',
-        :'action_category' => :'action_category',
         :'result_data' => :'result_data',
         :'error_message' => :'error_message'
       }
@@ -79,10 +83,9 @@ module DocSpring
       {
         :'id' => :'String',
         :'integration_id' => :'String',
-        :'state' => :'String',
-        :'action_type' => :'String',
-        :'action_category' => :'String',
-        :'result_data' => :'Object',
+        :'state' => :'SubmissionActionState',
+        :'action_type' => :'SubmissionActionType',
+        :'result_data' => :'Hash<String, Object>',
         :'error_message' => :'String'
       }
     end
@@ -90,12 +93,21 @@ module DocSpring
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'id',
         :'integration_id',
         :'error_message'
       ])
     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 = {})
@@ -136,14 +148,10 @@ module DocSpring
         self.action_type = nil
       end
 
-      if attributes.key?(:'action_category')
-        self.action_category = attributes[:'action_category']
-      else
-        self.action_category = nil
-      end
-
       if attributes.key?(:'result_data')
-        self.result_data = attributes[:'result_data']
+        if (value = attributes[:'result_data']).is_a?(Hash)
+          self.result_data = value
+        end
       else
         self.result_data = nil
       end
@@ -160,6 +168,10 @@ module DocSpring
     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 @state.nil?
         invalid_properties.push('invalid value for "state", state cannot be nil.')
       end
@@ -168,10 +180,6 @@ module DocSpring
         invalid_properties.push('invalid value for "action_type", action_type cannot be nil.')
       end
 
-      if @action_category.nil?
-        invalid_properties.push('invalid value for "action_category", action_category cannot be nil.')
-      end
-
       if @result_data.nil?
         invalid_properties.push('invalid value for "result_data", result_data cannot be nil.')
       end
@@ -183,50 +191,41 @@ module DocSpring
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
       return false if @state.nil?
-      state_validator = EnumAttributeValidator.new('String', ["pending", "processed", "failed", "error"])
-      return false unless state_validator.valid?(@state)
       return false if @action_type.nil?
-      action_type_validator = EnumAttributeValidator.new('String', ["webhook", "slack_webhook", "email", "aws_s3_upload"])
-      return false unless action_type_validator.valid?(@action_type)
-      return false if @action_category.nil?
-      action_category_validator = EnumAttributeValidator.new('String', ["notification", "file_upload"])
-      return false unless action_category_validator.valid?(@action_category)
       return false if @result_data.nil?
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] state Object to be assigned
+    # 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] state Value to be assigned
     def state=(state)
-      validator = EnumAttributeValidator.new('String', ["pending", "processed", "failed", "error"])
-      # build_from_hash accepts enum values this client doesn't know about yet
-      unless defined?(@_skip_enum_validation) || validator.valid?(state)
-        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
+      if state.nil?
+        fail ArgumentError, 'state cannot be nil'
       end
+
       @state = state
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] action_type Object to be assigned
+    # Custom attribute writer method with validation
+    # @param [Object] action_type Value to be assigned
     def action_type=(action_type)
-      validator = EnumAttributeValidator.new('String', ["webhook", "slack_webhook", "email", "aws_s3_upload"])
-      # build_from_hash accepts enum values this client doesn't know about yet
-      unless defined?(@_skip_enum_validation) || validator.valid?(action_type)
-        fail ArgumentError, "invalid value for \"action_type\", must be one of #{validator.allowable_values}."
+      if action_type.nil?
+        fail ArgumentError, 'action_type cannot be nil'
       end
-      @action_type = action_type
-    end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] action_category Object to be assigned
-    def action_category=(action_category)
-      validator = EnumAttributeValidator.new('String', ["notification", "file_upload"])
-      # build_from_hash accepts enum values this client doesn't know about yet
-      unless defined?(@_skip_enum_validation) || validator.valid?(action_category)
-        fail ArgumentError, "invalid value for \"action_category\", must be one of #{validator.allowable_values}."
-      end
-      @action_category = action_category
+      @action_type = action_type
     end
 
     # Custom attribute writer method with validation
@@ -248,7 +247,6 @@ module DocSpring
           integration_id == o.integration_id &&
           state == o.state &&
           action_type == o.action_type &&
-          action_category == o.action_category &&
           result_data == o.result_data &&
           error_message == o.error_message
     end
@@ -262,7 +260,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, integration_id, state, action_type, action_category, result_data, error_message].hash
+      [id, integration_id, state, action_type, result_data, error_message].hash
     end
 
     # Builds the object from hash
@@ -271,18 +269,20 @@ module DocSpring
     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 = {}
-      openapi_types.each_pair do |key, type|
-        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+      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[attribute_map[key]].is_a?(Array)
-            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          if attributes[map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
           end
-        elsif !attributes[attribute_map[key]].nil?
-          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        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
@@ -294,69 +294,15 @@ module DocSpring
       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|
+      # 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.openapi_nullable.include?(attr)
+          is_nullable = self.class.acceptable_openapi_nullable.include?(attr)
           next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
         end
 
@@ -365,24 +311,6 @@ module DocSpring
       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/models/submission_action_state.rb

@@ -0,0 +1,43 @@
+=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 SubmissionActionState
+    PENDING = "pending".freeze
+    PROCESSED = "processed".freeze
+    FAILED = "failed".freeze
+    ERROR = "error".freeze
+
+    def self.all_vars
+      @all_vars ||= [PENDING, PROCESSED, FAILED, ERROR].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/submission_action_type.rb

@@ -0,0 +1,46 @@
+=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 SubmissionActionType
+    WEBHOOK = "webhook".freeze
+    SLACK_WEBHOOK = "slack_webhook".freeze
+    EMAIL = "email".freeze
+    AWS_S3_UPLOAD = "aws_s3_upload".freeze
+    DROPBOX_UPLOAD = "dropbox_upload".freeze
+    GOOGLE_DRIVE_UPLOAD = "google_drive_upload".freeze
+    BOX_UPLOAD = "box_upload".freeze
+
+    def self.all_vars
+      @all_vars ||= [WEBHOOK, SLACK_WEBHOOK, EMAIL, AWS_S3_UPLOAD, DROPBOX_UPLOAD, GOOGLE_DRIVE_UPLOAD, BOX_UPLOAD].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