sendmux-sending 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93f7898501dac6b038c2b64530535627dd8b3178f2434a5e48cf1b99c4473561
-  data.tar.gz: 4eeb6992dd17fef37619abfec88e608d9d58ab1766d66c959ddd8fb4fddfef4b
+  metadata.gz: 821d58d8a919591323d101d48bb9c4f53d14cb5085ac2d71f6ed5142a0273958
+  data.tar.gz: 742e3fe7e4a957c8eeca20f60e3905b58a242ccf862dd1e59046bfe753e7f1f9
 SHA512:
-  metadata.gz: 43ebf3cd892bbd8b1a0f888e91601f825c996792d4e0958574b70d0fcfc7f5879af8dcf6217f98b88c7758053c76d9e8e1ab31dcd47ab3229f5408d0df4012f6
-  data.tar.gz: 77cd109cdaa57e393ab4f607fa402cb2dc52c2cf7b1b4c51ca54e079c7f1116070ab5f6396947f173669494c69dfb70cb6c65aa79c5236ea147b024234345e47
+  metadata.gz: 48d0e04ccf42e9c2a5886621d42263688354f716886cf3df5b0d06f803e9321e472eb5035ba3ed7da07ebe1269e4db6a288d3925d2adcebe5e2f8c937421b8fd
+  data.tar.gz: b80609c92fb6144f7adcf1faf06de6adba24c7789ac7533df72fa20972c3c4a2c6a574d8c796582d013b5a493fffeaf012022008b52d6decc4b137bf3fe742f0

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+* Add one delivery group or a list of `delivery_group` IDs to email send requests.
+
+## [1.5.0](https://github.com/Sendmux/sendmux-sdk/compare/ruby-sending/v1.4.0...ruby-sending/v1.5.0) (2026-09-19)
+
+
+### Features
+
+* integrate combined provider variables and delivery routing ([81bbf22](https://github.com/Sendmux/sendmux-sdk/commit/81bbf221a357bf5d588eba654184ff34491473df))
+* **sdk:** add provider variables and delivery group routing ([94f52d4](https://github.com/Sendmux/sendmux-sdk/commit/94f52d4e9f6157e197308541cc5987517bac7a4a))
+
+## [1.4.0](https://github.com/Sendmux/sendmux-sdk/compare/ruby-sending/v1.3.0...ruby-sending/v1.4.0) (2026-09-10)
+
+
+### Features
+
+* add REST OAuth clients and CLI token lifecycle ([cc4a3aa](https://github.com/Sendmux/sendmux-sdk/commit/cc4a3aa6110378641418a94455ed5b9a986e65ff))
+
 ## [1.3.0](https://github.com/Sendmux/sendmux-sdk/compare/ruby-sending/v1.2.0...ruby-sending/v1.3.0) (2026-09-08)
 
 

data/README.md

@@ -18,6 +18,8 @@ Ruby SDK package for the Sendmux Sending API.
 - Ruby 3.1 or newer.
 - A send-capable `smx_mbx_` key or owner-approved Sending-resource `smx_agent_` token.
 
+For OAuth, use a REST access token with the scopes and mailbox access required by the operation. See [OAuth for REST APIs](https://sendmux.ai/docs/developer-tools/oauth).
+
 ## Installation
 
 ```sh
@@ -30,9 +32,21 @@ Or add it to your Gemfile:
 gem "sendmux-sending", "~> 1.0"
 ```
 
+## OAuth access tokens
+
+Pass either `api_key:` or `access_token:`. `access_token:` accepts a bare token string or a callable; the callable is evaluated once per authenticated request. Your application owns token storage, expiry checks and refresh coordination.
+
+```ruby
+require "sendmux/sending"
+
+client = Sendmux::Sending::Client.new(
+  access_token: -> { ENV.fetch("SENDMUX_ACCESS_TOKEN") }
+)
+```
+
 ## Usage
 
-Create a sending client with a send-capable key before calling generated operations.
+Create a sending client with a send-capable key for the API-key example below.
 
 ```ruby
 require "sendmux/sending"

data/lib/sendmux/sending/client.rb

@@ -5,6 +5,12 @@ module Sendmux
     DEFAULT_BASE_URL = 'https://smtp.sendmux.ai/api/v1'
 
     class ApiClient < Generated::ApiClient
+      def update_params_for_auth!(header_params, query_params, auth_names)
+        return super unless config.access_token_getter && !Array(auth_names).empty?
+
+        header_params['Authorization'] = "Bearer #{config.access_token_with_refresh}"
+      end
+
       def call_api(...)
         super
       rescue Generated::ApiError => e
@@ -15,12 +21,13 @@ module Sendmux
     class Client
       attr_reader :api_client, :configuration
 
-      def initialize(api_key:, base_url: DEFAULT_BASE_URL, retry_options: nil)
+      def initialize(api_key: nil, access_token: nil, base_url: DEFAULT_BASE_URL, retry_options: nil)
         @configuration = Sendmux::Core::Auth.configure_bearer(
           Generated::Configuration.new,
           api_key,
           Sendmux::Core::ApiKeySurface::SENDING,
-          base_url: base_url
+          base_url: base_url,
+          access_token: access_token
         )
         Sendmux::Core::Retry.configure(@configuration, retry_options)
         @api_client = ApiClient.new(@configuration)

data/lib/sendmux/sending/version.rb

@@ -2,6 +2,6 @@
 
 module Sendmux
   module Sending
-    VERSION = '1.3.0'
+    VERSION = '1.5.0'
   end
 end

data/lib/sendmux_sending_generated/api/attachments_api.rb

@@ -172,7 +172,7 @@ module Sendmux::Sending::Generated
       return_type = opts[:debug_return_type] || 'AttachmentUploadIntentResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+      auth_names = opts[:debug_auth_names] || ['OAuth2', 'BearerAuth']
 
       new_options = opts.merge(
         :operation => :"AttachmentsApi.sending_create_attachment_upload",
@@ -240,7 +240,7 @@ module Sendmux::Sending::Generated
       return_type = opts[:debug_return_type] || 'AttachmentUploadResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+      auth_names = opts[:debug_auth_names] || ['OAuth2', 'BearerAuth']
 
       new_options = opts.merge(
         :operation => :"AttachmentsApi.sending_get_attachment",
@@ -348,7 +348,7 @@ module Sendmux::Sending::Generated
       return_type = opts[:debug_return_type] || 'AttachmentUploadResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+      auth_names = opts[:debug_auth_names] || ['OAuth2', 'BearerAuth']
 
       new_options = opts.merge(
         :operation => :"AttachmentsApi.sending_upload_attachment",

data/lib/sendmux_sending_generated/api/emails_api.rb

@@ -75,7 +75,7 @@ module Sendmux::Sending::Generated
       return_type = opts[:debug_return_type] || 'SendSuccessResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+      auth_names = opts[:debug_auth_names] || ['OAuth2', 'BearerAuth']
 
       new_options = opts.merge(
         :operation => :"EmailsApi.sending_send_email",
@@ -150,7 +150,7 @@ module Sendmux::Sending::Generated
       return_type = opts[:debug_return_type] || 'BatchSendSuccessResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+      auth_names = opts[:debug_auth_names] || ['OAuth2', 'BearerAuth']
 
       new_options = opts.merge(
         :operation => :"EmailsApi.sending_send_email_batch",

data/lib/sendmux_sending_generated/api/meta_api.rb

@@ -60,7 +60,7 @@ module Sendmux::Sending::Generated
       return_type = opts[:debug_return_type] || 'ConnectionResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+      auth_names = opts[:debug_auth_names] || ['OAuth2', 'BearerAuth']
 
       new_options = opts.merge(
         :operation => :"MetaApi.sending_get_connection",

data/lib/sendmux_sending_generated/configuration.rb

@@ -255,6 +255,13 @@ module Sendmux::Sending::Generated
             key: 'Authorization',
             value: "Bearer #{access_token_with_refresh}"
           },
+        'OAuth2' =>
+          {
+            type: 'oauth2',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token_with_refresh}"
+          },
       }
     end
 

data/lib/sendmux_sending_generated/models/email_send_request.rb

@@ -27,6 +27,8 @@ module Sendmux::Sending::Generated
     # Custom X-* headers to include in the email
     attr_accessor :custom_headers
 
+    attr_accessor :delivery_group
+
     attr_accessor :from
 
     # HTML email content (max 25MB)
@@ -54,6 +56,7 @@ module Sendmux::Sending::Generated
         :'bcc' => :'bcc',
         :'cc' => :'cc',
         :'custom_headers' => :'custom_headers',
+        :'delivery_group' => :'delivery_group',
         :'from' => :'from',
         :'html_body' => :'html_body',
         :'reply_to' => :'reply_to',
@@ -81,6 +84,7 @@ module Sendmux::Sending::Generated
         :'bcc' => :'Array<Recipient>',
         :'cc' => :'Array<Recipient>',
         :'custom_headers' => :'Hash<String, String>',
+        :'delivery_group' => :'EmailSendRequestDeliveryGroup',
         :'from' => :'Address',
         :'html_body' => :'String',
         :'reply_to' => :'Address',
@@ -137,6 +141,10 @@ module Sendmux::Sending::Generated
         end
       end
 
+      if attributes.key?(:'delivery_group')
+        self.delivery_group = attributes[:'delivery_group']
+      end
+
       if attributes.key?(:'from')
         self.from = attributes[:'from']
       else
@@ -400,6 +408,7 @@ module Sendmux::Sending::Generated
           bcc == o.bcc &&
           cc == o.cc &&
           custom_headers == o.custom_headers &&
+          delivery_group == o.delivery_group &&
           from == o.from &&
           html_body == o.html_body &&
           reply_to == o.reply_to &&
@@ -418,7 +427,7 @@ module Sendmux::Sending::Generated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [attachments, bcc, cc, custom_headers, from, html_body, reply_to, return_path, subject, text_body, to].hash
+      [attachments, bcc, cc, custom_headers, delivery_group, from, html_body, reply_to, return_path, subject, text_body, to].hash
     end
 
     # Builds the object from hash

data/lib/sendmux_sending_generated/models/email_send_request_delivery_group.rb

@@ -0,0 +1,105 @@
+=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
+  # One delivery group public ID or a non-empty array of up to 50 IDs
+  module EmailSendRequestDeliveryGroup
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'Array<String>',
+          :'String'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            return find_and_cast_into_type(klass, data)
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_one_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.iso8601(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = Sendmux::Sending::Generated.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_one_of) # nested oneOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end

data/lib/sendmux_sending_generated.rb

@@ -36,6 +36,7 @@ require 'sendmux_sending_generated/models/connection_mailboxes_inner'
 require 'sendmux_sending_generated/models/connection_response'
 require 'sendmux_sending_generated/models/connection_team'
 require 'sendmux_sending_generated/models/email_send_request'
+require 'sendmux_sending_generated/models/email_send_request_delivery_group'
 require 'sendmux_sending_generated/models/error_detail'
 require 'sendmux_sending_generated/models/error_issue'
 require 'sendmux_sending_generated/models/error_response'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sendmux-sending
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Sendmux
 bindir: bin
 cert_chain: []
-date: 2026-09-08 00:00:00.000000000 Z
+date: 2026-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -77,7 +77,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -87,7 +87,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -129,6 +129,7 @@ files:
 - lib/sendmux_sending_generated/models/connection_response.rb
 - lib/sendmux_sending_generated/models/connection_team.rb
 - lib/sendmux_sending_generated/models/email_send_request.rb
+- lib/sendmux_sending_generated/models/email_send_request_delivery_group.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