sendmux-sending 1.0.0

data/lib/sendmux_sending_generated/models/success_envelope.rb

@@ -0,0 +1,190 @@
+=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 SuccessEnvelope < ApiModelBase
+    attr_accessor :meta
+
+    attr_accessor :ok
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'meta' => :'meta',
+        :'ok' => :'ok'
+      }
+    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
+      {
+        :'meta' => :'Meta',
+        :'ok' => :'Boolean'
+      }
+    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::SuccessEnvelope` 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::SuccessEnvelope`. 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?(:'meta')
+        self.meta = attributes[:'meta']
+      else
+        self.meta = nil
+      end
+
+      if attributes.key?(:'ok')
+        self.ok = attributes[:'ok']
+      else
+        self.ok = 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 @meta.nil?
+        invalid_properties.push('invalid value for "meta", meta cannot be nil.')
+      end
+
+      if @ok.nil?
+        invalid_properties.push('invalid value for "ok", ok 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 @meta.nil?
+      return false if @ok.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] meta Value to be assigned
+    def meta=(meta)
+      if meta.nil?
+        fail ArgumentError, 'meta cannot be nil'
+      end
+
+      @meta = meta
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ok Value to be assigned
+    def ok=(ok)
+      if ok.nil?
+        fail ArgumentError, 'ok cannot be nil'
+      end
+
+      @ok = ok
+    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 &&
+          meta == o.meta &&
+          ok == o.ok
+    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
+      [meta, ok].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/version.rb

@@ -0,0 +1,15 @@
+=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
+
+module Sendmux::Sending::Generated
+  VERSION = '1.0.0'
+end

data/lib/sendmux_sending_generated.rb

@@ -0,0 +1,57 @@
+=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
+
+# Common files
+require 'sendmux_sending_generated/api_client'
+require 'sendmux_sending_generated/api_error'
+require 'sendmux_sending_generated/api_model_base'
+require 'sendmux_sending_generated/version'
+require 'sendmux_sending_generated/configuration'
+
+# Models
+require 'sendmux_sending_generated/models/address'
+require 'sendmux_sending_generated/models/attachment'
+require 'sendmux_sending_generated/models/batch_result_item'
+require 'sendmux_sending_generated/models/batch_send_request'
+require 'sendmux_sending_generated/models/batch_send_success_data'
+require 'sendmux_sending_generated/models/batch_send_success_response'
+require 'sendmux_sending_generated/models/batch_summary'
+require 'sendmux_sending_generated/models/email_send_request'
+require 'sendmux_sending_generated/models/error_detail'
+require 'sendmux_sending_generated/models/error_issue'
+require 'sendmux_sending_generated/models/error_response'
+require 'sendmux_sending_generated/models/meta'
+require 'sendmux_sending_generated/models/recipient'
+require 'sendmux_sending_generated/models/send_success_data'
+require 'sendmux_sending_generated/models/send_success_response'
+require 'sendmux_sending_generated/models/success_envelope'
+
+# APIs
+require 'sendmux_sending_generated/api/emails_api'
+
+module Sendmux::Sending::Generated
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Sendmux::Sending::Generated.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: sendmux-sending
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sendmux
+bindir: bin
+cert_chain: []
+date: 2026-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: marcel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sendmux-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+email:
+- contact@sendmux.ai
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/sendmux/sending.rb
+- lib/sendmux/sending/client.rb
+- lib/sendmux/sending/version.rb
+- lib/sendmux_sending_generated.rb
+- lib/sendmux_sending_generated/api/emails_api.rb
+- lib/sendmux_sending_generated/api_client.rb
+- lib/sendmux_sending_generated/api_error.rb
+- lib/sendmux_sending_generated/api_model_base.rb
+- lib/sendmux_sending_generated/configuration.rb
+- lib/sendmux_sending_generated/models/address.rb
+- lib/sendmux_sending_generated/models/attachment.rb
+- lib/sendmux_sending_generated/models/batch_result_item.rb
+- lib/sendmux_sending_generated/models/batch_send_request.rb
+- lib/sendmux_sending_generated/models/batch_send_success_data.rb
+- lib/sendmux_sending_generated/models/batch_send_success_response.rb
+- lib/sendmux_sending_generated/models/batch_summary.rb
+- lib/sendmux_sending_generated/models/email_send_request.rb
+- lib/sendmux_sending_generated/models/error_detail.rb
+- lib/sendmux_sending_generated/models/error_issue.rb
+- lib/sendmux_sending_generated/models/error_response.rb
+- lib/sendmux_sending_generated/models/meta.rb
+- lib/sendmux_sending_generated/models/recipient.rb
+- lib/sendmux_sending_generated/models/send_success_data.rb
+- lib/sendmux_sending_generated/models/send_success_response.rb
+- lib/sendmux_sending_generated/models/success_envelope.rb
+- lib/sendmux_sending_generated/version.rb
+homepage: https://github.com/Sendmux/sendmux-sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Sendmux/sendmux-sdk
+  source_code_uri: https://github.com/Sendmux/sendmux-sdk/tree/main/packages/ruby/sending
+  changelog_uri: https://github.com/Sendmux/sendmux-sdk/blob/main/packages/ruby/sending/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Ruby SDK for the Sendmux Sending API.
+test_files: []