docspring 4.3.0 → 4.4.0

data/lib/docspring/models/email_action_customization.rb

@@ -0,0 +1,360 @@
+=begin
+#DocSpring API
+
+#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and 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 template's changes to an account email action.
+  class EmailActionCustomization < ApiModelBase
+    # Whether the account email action sends for this template. It also needs to be on itself (`enabled`).
+    attr_accessor :enabled
+
+    # The settings this template changes. The others follow the account email action.
+    attr_accessor :customized
+
+    # How many of this template's emails in a row have failed because of a setting it changes.
+    attr_accessor :consecutive_failures
+
+    # When the current run of those failures started.
+    attr_accessor :failing_since
+
+    # When one of those emails last failed.
+    attr_accessor :last_failure_at
+
+    # Why it failed.
+    attr_accessor :last_failure_message
+
+    # When DocSpring turned the email action off for this template, such as when an address the template added bounced.
+    attr_accessor :disabled_at
+
+    # Why DocSpring turned it off for this template.
+    attr_accessor :disabled_reason
+
+    # When the template first changed the email action.
+    attr_accessor :created_at
+
+    # When the template's changes last changed.
+    attr_accessor :updated_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'enabled' => :'enabled',
+        :'customized' => :'customized',
+        :'consecutive_failures' => :'consecutive_failures',
+        :'failing_since' => :'failing_since',
+        :'last_failure_at' => :'last_failure_at',
+        :'last_failure_message' => :'last_failure_message',
+        :'disabled_at' => :'disabled_at',
+        :'disabled_reason' => :'disabled_reason',
+        :'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
+      {
+        :'enabled' => :'Boolean',
+        :'customized' => :'Array<EmailActionSetting>',
+        :'consecutive_failures' => :'Integer',
+        :'failing_since' => :'Time',
+        :'last_failure_at' => :'Time',
+        :'last_failure_message' => :'String',
+        :'disabled_at' => :'Time',
+        :'disabled_reason' => :'String',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'failing_since',
+        :'last_failure_at',
+        :'last_failure_message',
+        :'disabled_at',
+        :'disabled_reason',
+      ])
+    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::EmailActionCustomization` 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::EmailActionCustomization`. 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?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      else
+        self.enabled = nil
+      end
+
+      if attributes.key?(:'customized')
+        if (value = attributes[:'customized']).is_a?(Array)
+          self.customized = value
+        end
+      else
+        self.customized = nil
+      end
+
+      if attributes.key?(:'consecutive_failures')
+        self.consecutive_failures = attributes[:'consecutive_failures']
+      else
+        self.consecutive_failures = nil
+      end
+
+      if attributes.key?(:'failing_since')
+        self.failing_since = attributes[:'failing_since']
+      else
+        self.failing_since = 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?(:'last_failure_message')
+        self.last_failure_message = attributes[:'last_failure_message']
+      else
+        self.last_failure_message = 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?(:'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 @enabled.nil?
+        invalid_properties.push('invalid value for "enabled", enabled cannot be nil.')
+      end
+
+      if @customized.nil?
+        invalid_properties.push('invalid value for "customized", customized cannot be nil.')
+      end
+
+      if @consecutive_failures.nil?
+        invalid_properties.push('invalid value for "consecutive_failures", consecutive_failures cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at 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 @enabled.nil?
+      return false if @customized.nil?
+      return false if @consecutive_failures.nil?
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
+      true
+    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] customized Value to be assigned
+    def customized=(customized)
+      if customized.nil?
+        fail ArgumentError, 'customized cannot be nil'
+      end
+
+      @customized = customized
+    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
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        fail ArgumentError, 'updated_at cannot be nil'
+      end
+
+      @updated_at = updated_at
+    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 &&
+          enabled == o.enabled &&
+          customized == o.customized &&
+          consecutive_failures == o.consecutive_failures &&
+          failing_since == o.failing_since &&
+          last_failure_at == o.last_failure_at &&
+          last_failure_message == o.last_failure_message &&
+          disabled_at == o.disabled_at &&
+          disabled_reason == o.disabled_reason &&
+          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
+      [enabled, customized, consecutive_failures, failing_since, last_failure_at, last_failure_message, disabled_at, disabled_reason, 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)
+      # 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/email_action_delivery.rb

@@ -0,0 +1,41 @@
+=begin
+#DocSpring API
+
+#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and 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 EmailActionDelivery
+    ATTACHMENT = "attachment".freeze
+    LINK = "link".freeze
+
+    def self.all_vars
+      @all_vars ||= [ATTACHMENT, LINK].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/email_action_file_formats.rb

@@ -0,0 +1,43 @@
+=begin
+#DocSpring API
+
+#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and 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 EmailActionFileFormats
+    DOCX = "docx".freeze
+    ODT = "odt".freeze
+    PDF = "pdf".freeze
+    ALL = "all".freeze
+
+    def self.all_vars
+      @all_vars ||= [DOCX, ODT, PDF, ALL].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/email_action_list.rb

@@ -0,0 +1,200 @@
+=begin
+#DocSpring API
+
+#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and 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 page of a template's email actions, newest first.
+  class EmailActionList < ApiModelBase
+    # The items on this page.
+    attr_accessor :data
+
+    # Pass it as `cursor` to get the next page. Null on the last page.
+    attr_accessor :next_cursor
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'next_cursor' => :'next_cursor'
+      }
+    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
+      {
+        :'data' => :'Array<EmailAction>',
+        :'next_cursor' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'next_cursor'
+      ])
+    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::EmailActionList` 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::EmailActionList`. 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?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      else
+        self.data = nil
+      end
+
+      if attributes.key?(:'next_cursor')
+        self.next_cursor = attributes[:'next_cursor']
+      else
+        self.next_cursor = 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 @data.nil?
+        invalid_properties.push('invalid value for "data", data 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 @data.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'data cannot be nil'
+      end
+
+      @data = data
+    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 &&
+          data == o.data &&
+          next_cursor == o.next_cursor
+    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
+      [data, next_cursor].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/email_action_setting.rb

@@ -0,0 +1,53 @@
+=begin
+#DocSpring API
+
+#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and 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 EmailActionSetting
+    TO = "to".freeze
+    CC = "cc".freeze
+    BCC = "bcc".freeze
+    FROM_NAME = "from_name".freeze
+    FROM_ADDRESS = "from_address".freeze
+    REPLY_TO = "reply_to".freeze
+    SUBJECT = "subject".freeze
+    MESSAGE = "message".freeze
+    FILE_NAME = "file_name".freeze
+    FILE_FORMATS = "file_formats".freeze
+    DELIVERY = "delivery".freeze
+    MAX_ATTACHMENT_MB = "max_attachment_mb".freeze
+    SUBMISSION_TYPE = "submission_type".freeze
+    SEND_WHEN = "send_when".freeze
+
+    def self.all_vars
+      @all_vars ||= [TO, CC, BCC, FROM_NAME, FROM_ADDRESS, REPLY_TO, SUBJECT, MESSAGE, FILE_NAME, FILE_FORMATS, DELIVERY, MAX_ATTACHMENT_MB, SUBMISSION_TYPE, SEND_WHEN].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