sendmux-sending 1.1.0 → 1.2.0

data/lib/sendmux_sending_generated/models/attachment_upload_intent_data.rb

@@ -0,0 +1,337 @@
+=begin
+#Sendmux Sending API
+
+#Send emails programmatically via the Sendmux email infrastructure. Every response carries an `X-Request-Id` header; errors include a `retryable` flag. 429 and 503 responses include `Retry-After`. Mutating endpoints accept an `Idempotency-Key` header for safe retries.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Sendmux::Sending::Generated
+  class AttachmentUploadIntentData < ApiModelBase
+    # ISO timestamp when the upload URL expires.
+    attr_accessor :expires_at
+
+    # Headers that must be sent with the PUT upload request.
+    attr_accessor :headers
+
+    # Maximum upload size in bytes
+    attr_accessor :max_size_bytes
+
+    # HTTP method for upload_url
+    attr_accessor :method
+
+    # Temporary upload intent ID.
+    attr_accessor :upload_id
+
+    # Short-lived URL that accepts a binary PUT with the returned headers.
+    attr_accessor :upload_url
+
+    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
+      {
+        :'expires_at' => :'expires_at',
+        :'headers' => :'headers',
+        :'max_size_bytes' => :'max_size_bytes',
+        :'method' => :'method',
+        :'upload_id' => :'upload_id',
+        :'upload_url' => :'upload_url'
+      }
+    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
+      {
+        :'expires_at' => :'Time',
+        :'headers' => :'Hash<String, String>',
+        :'max_size_bytes' => :'Integer',
+        :'method' => :'String',
+        :'upload_id' => :'String',
+        :'upload_url' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `Sendmux::Sending::Generated::AttachmentUploadIntentData` 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 `Sendmux::Sending::Generated::AttachmentUploadIntentData`. 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?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
+      else
+        self.expires_at = 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?(:'max_size_bytes')
+        self.max_size_bytes = attributes[:'max_size_bytes']
+      else
+        self.max_size_bytes = nil
+      end
+
+      if attributes.key?(:'method')
+        self.method = attributes[:'method']
+      else
+        self.method = nil
+      end
+
+      if attributes.key?(:'upload_id')
+        self.upload_id = attributes[:'upload_id']
+      else
+        self.upload_id = nil
+      end
+
+      if attributes.key?(:'upload_url')
+        self.upload_url = attributes[:'upload_url']
+      else
+        self.upload_url = 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 @expires_at.nil?
+        invalid_properties.push('invalid value for "expires_at", expires_at cannot be nil.')
+      end
+
+      if @headers.nil?
+        invalid_properties.push('invalid value for "headers", headers cannot be nil.')
+      end
+
+      if @max_size_bytes.nil?
+        invalid_properties.push('invalid value for "max_size_bytes", max_size_bytes cannot be nil.')
+      end
+
+      if @method.nil?
+        invalid_properties.push('invalid value for "method", method cannot be nil.')
+      end
+
+      if @upload_id.nil?
+        invalid_properties.push('invalid value for "upload_id", upload_id cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^upl_[a-z0-9]{24}$/)
+      if @upload_id !~ pattern
+        invalid_properties.push("invalid value for \"upload_id\", must conform to the pattern #{pattern}.")
+      end
+
+      if @upload_url.nil?
+        invalid_properties.push('invalid value for "upload_url", upload_url 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 @expires_at.nil?
+      return false if @headers.nil?
+      return false if @max_size_bytes.nil?
+      return false if @method.nil?
+      method_validator = EnumAttributeValidator.new('String', ["PUT", "unknown_default_open_api"])
+      return false unless method_validator.valid?(@method)
+      return false if @upload_id.nil?
+      return false if @upload_id !~ Regexp.new(/^upl_[a-z0-9]{24}$/)
+      return false if @upload_url.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] expires_at Value to be assigned
+    def expires_at=(expires_at)
+      if expires_at.nil?
+        fail ArgumentError, 'expires_at cannot be nil'
+      end
+
+      @expires_at = expires_at
+    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] max_size_bytes Value to be assigned
+    def max_size_bytes=(max_size_bytes)
+      if max_size_bytes.nil?
+        fail ArgumentError, 'max_size_bytes cannot be nil'
+      end
+
+      @max_size_bytes = max_size_bytes
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] method Object to be assigned
+    def method=(method)
+      validator = EnumAttributeValidator.new('String', ["PUT", "unknown_default_open_api"])
+      unless validator.valid?(method)
+        fail ArgumentError, "invalid value for \"method\", must be one of #{validator.allowable_values}."
+      end
+      @method = method
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] upload_id Value to be assigned
+    def upload_id=(upload_id)
+      if upload_id.nil?
+        fail ArgumentError, 'upload_id cannot be nil'
+      end
+
+      pattern = Regexp.new(/^upl_[a-z0-9]{24}$/)
+      if upload_id !~ pattern
+        fail ArgumentError, "invalid value for \"upload_id\", must conform to the pattern #{pattern}."
+      end
+
+      @upload_id = upload_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] upload_url Value to be assigned
+    def upload_url=(upload_url)
+      if upload_url.nil?
+        fail ArgumentError, 'upload_url cannot be nil'
+      end
+
+      @upload_url = upload_url
+    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 &&
+          expires_at == o.expires_at &&
+          headers == o.headers &&
+          max_size_bytes == o.max_size_bytes &&
+          method == o.method &&
+          upload_id == o.upload_id &&
+          upload_url == o.upload_url
+    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
+      [expires_at, headers, max_size_bytes, method, upload_id, upload_url].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
+      new(transformed_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
+
+  end
+
+end

data/lib/sendmux_sending_generated/models/attachment_upload_intent_request.rb

@@ -0,0 +1,279 @@
+=begin
+#Sendmux Sending API
+
+#Send emails programmatically via the Sendmux email infrastructure. Every response carries an `X-Request-Id` header; errors include a `retryable` flag. 429 and 503 responses include `Retry-After`. Mutating endpoints accept an `Idempotency-Key` header for safe retries.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Sendmux::Sending::Generated
+  class AttachmentUploadIntentRequest < ApiModelBase
+    # MIME type expected for the upload.
+    attr_accessor :content_type
+
+    # Filename to associate with the uploaded attachment.
+    attr_accessor :filename
+
+    # Optional SHA-256 hex digest for the upload bytes.
+    attr_accessor :sha256
+
+    # Exact byte size that will be uploaded.
+    attr_accessor :size_bytes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'content_type' => :'content_type',
+        :'filename' => :'filename',
+        :'sha256' => :'sha256',
+        :'size_bytes' => :'size_bytes'
+      }
+    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
+      {
+        :'content_type' => :'String',
+        :'filename' => :'String',
+        :'sha256' => :'String',
+        :'size_bytes' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `Sendmux::Sending::Generated::AttachmentUploadIntentRequest` 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 `Sendmux::Sending::Generated::AttachmentUploadIntentRequest`. 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?(:'content_type')
+        self.content_type = attributes[:'content_type']
+      end
+
+      if attributes.key?(:'filename')
+        self.filename = attributes[:'filename']
+      else
+        self.filename = nil
+      end
+
+      if attributes.key?(:'sha256')
+        self.sha256 = attributes[:'sha256']
+      end
+
+      if attributes.key?(:'size_bytes')
+        self.size_bytes = attributes[:'size_bytes']
+      else
+        self.size_bytes = 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 !@content_type.nil? && @content_type.to_s.length > 255
+        invalid_properties.push('invalid value for "content_type", the character length must be smaller than or equal to 255.')
+      end
+
+      if @filename.nil?
+        invalid_properties.push('invalid value for "filename", filename cannot be nil.')
+      end
+
+      if @filename.to_s.length > 255
+        invalid_properties.push('invalid value for "filename", the character length must be smaller than or equal to 255.')
+      end
+
+      if @filename.to_s.length < 1
+        invalid_properties.push('invalid value for "filename", the character length must be greater than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/^[a-f0-9]{64}$/)
+      if !@sha256.nil? && @sha256 !~ pattern
+        invalid_properties.push("invalid value for \"sha256\", must conform to the pattern #{pattern}.")
+      end
+
+      if @size_bytes.nil?
+        invalid_properties.push('invalid value for "size_bytes", size_bytes cannot be nil.')
+      end
+
+      if @size_bytes <= 0
+        invalid_properties.push('invalid value for "size_bytes", must be greater than 0.')
+      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 !@content_type.nil? && @content_type.to_s.length > 255
+      return false if @filename.nil?
+      return false if @filename.to_s.length > 255
+      return false if @filename.to_s.length < 1
+      return false if !@sha256.nil? && @sha256 !~ Regexp.new(/^[a-f0-9]{64}$/)
+      return false if @size_bytes.nil?
+      return false if @size_bytes <= 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] content_type Value to be assigned
+    def content_type=(content_type)
+      if content_type.nil?
+        fail ArgumentError, 'content_type cannot be nil'
+      end
+
+      if content_type.to_s.length > 255
+        fail ArgumentError, 'invalid value for "content_type", the character length must be smaller than or equal to 255.'
+      end
+
+      @content_type = content_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] filename Value to be assigned
+    def filename=(filename)
+      if filename.nil?
+        fail ArgumentError, 'filename cannot be nil'
+      end
+
+      if filename.to_s.length > 255
+        fail ArgumentError, 'invalid value for "filename", the character length must be smaller than or equal to 255.'
+      end
+
+      if filename.to_s.length < 1
+        fail ArgumentError, 'invalid value for "filename", the character length must be greater than or equal to 1.'
+      end
+
+      @filename = filename
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sha256 Value to be assigned
+    def sha256=(sha256)
+      if sha256.nil?
+        fail ArgumentError, 'sha256 cannot be nil'
+      end
+
+      pattern = Regexp.new(/^[a-f0-9]{64}$/)
+      if sha256 !~ pattern
+        fail ArgumentError, "invalid value for \"sha256\", must conform to the pattern #{pattern}."
+      end
+
+      @sha256 = sha256
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] size_bytes Value to be assigned
+    def size_bytes=(size_bytes)
+      if size_bytes.nil?
+        fail ArgumentError, 'size_bytes cannot be nil'
+      end
+
+      if size_bytes <= 0
+        fail ArgumentError, 'invalid value for "size_bytes", must be greater than 0.'
+      end
+
+      @size_bytes = size_bytes
+    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 &&
+          content_type == o.content_type &&
+          filename == o.filename &&
+          sha256 == o.sha256 &&
+          size_bytes == o.size_bytes
+    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
+      [content_type, filename, sha256, size_bytes].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
+      new(transformed_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
+
+  end
+
+end