sendmux-sending 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dbfe224c407947d8b0b69e3c8ac663c5d2e6af75b820ef775971f40fb659545
-  data.tar.gz: d73c320e4b15a22d56b28a82e96076780c5b77009e185f0a4e7fcc517785ea40
+  metadata.gz: 195959762d9b4fe1a794ad4b40bde49927733d5bf6bbbe751ff7975a74a3be4b
+  data.tar.gz: 0b4e725dd8a434917954bd0d0bddc0232e58f7596c6e3fada3ff404f98a017d0
 SHA512:
-  metadata.gz: 20b08ea90472135d92dcf0e346790489cd219c2f64c8004b0dbc3881cc01746eb8b0b98862bb27e9bd55999fd771098116f69dda0373916bce80e9979780e65c
-  data.tar.gz: a05947636992ca4e2b71d35cc73219a008c53000d83eb4a954bda632bbd3ccbc6e6924c2810ef510eb5b7506c8762d257bf6c631da7e8aa21c6681ce0bdf45fb
+  metadata.gz: d14fc7657e5a681d1624acf5fa069f04d795435c6f6422662d0e4e25f2a2598d7dfe049c35deda0262ab0fca4e1f15a6610fe06bc737d7090aa8d657c5bbd377
+  data.tar.gz: 0d415c60df2619d31805dbc5b9aebe0580feaa47b12d6ae9e3e81826e3f5044054fb46423489f2f18f39473207cbf2c89556eb3ec7a66651c4893b231f577c02

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [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)
+
+
+### Features
+
+* add connection checks across SDKs, CLI and MCP ([77f449e](https://github.com/Sendmux/sendmux-sdk/commit/77f449e2c8cba49bc8bc84c49c35baa61120866a))
+* **sdk:** add connection checks across clients, CLI and MCP ([3e02c67](https://github.com/Sendmux/sendmux-sdk/commit/3e02c67dcab45e37dad7abbdd4c4e1bd0b1fbbe6))
+
 ## [1.2.0](https://github.com/Sendmux/sendmux-sdk/compare/ruby-sending/v1.1.0...ruby-sending/v1.2.0) (2026-07-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.2.0'
+    VERSION = '1.4.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

@@ -19,6 +19,66 @@ module Sendmux::Sending::Generated
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Get Sending connection
+    # Validate this Sending credential and return its team, connection label, permissions and authorised mailboxes. Requires email.send. Credits, provider readiness and mailbox storage are not checked. No user profile or secrets are returned.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_none_match Weak ETag from a previous response. When it matches the current resource, the server returns 304 Not Modified with no body.
+    # @return [ConnectionResponse]
+    def sending_get_connection(opts = {})
+      data, _status_code, _headers = sending_get_connection_with_http_info(opts)
+      data
+    end
+
+    # Get Sending connection
+    # Validate this Sending credential and return its team, connection label, permissions and authorised mailboxes. Requires email.send. Credits, provider readiness and mailbox storage are not checked. No user profile or secrets are returned.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_none_match Weak ETag from a previous response. When it matches the current resource, the server returns 304 Not Modified with no body.
+    # @return [Array<(ConnectionResponse, Integer, Hash)>] ConnectionResponse data, response status code and response headers
+    def sending_get_connection_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MetaApi.sending_get_connection ...'
+      end
+      # resource path
+      local_var_path = '/me'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConnectionResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2', 'BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"MetaApi.sending_get_connection",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MetaApi#sending_get_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # OpenAPI 3.1 specification
     # Auto-generated OpenAPI 3.1 spec for the Sendmux Sending API. Public endpoint (no authentication). Emits a weak ETag; clients may send `If-None-Match` to receive 304 Not Modified.
     # @param [Hash] opts the optional parameters

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/connection.rb

@@ -0,0 +1,273 @@
+=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 Connection < ApiModelBase
+    attr_accessor :credential
+
+    # Display label for this connection.
+    attr_accessor :label
+
+    attr_accessor :mailboxes
+
+    attr_accessor :permissions
+
+    attr_accessor :team
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'credential' => :'credential',
+        :'label' => :'label',
+        :'mailboxes' => :'mailboxes',
+        :'permissions' => :'permissions',
+        :'team' => :'team'
+      }
+    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
+      {
+        :'credential' => :'ConnectionCredential',
+        :'label' => :'String',
+        :'mailboxes' => :'Array<ConnectionMailboxesInner>',
+        :'permissions' => :'Array<String>',
+        :'team' => :'ConnectionTeam'
+      }
+    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::Connection` 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::Connection`. 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?(:'credential')
+        self.credential = attributes[:'credential']
+      else
+        self.credential = nil
+      end
+
+      if attributes.key?(:'label')
+        self.label = attributes[:'label']
+      else
+        self.label = nil
+      end
+
+      if attributes.key?(:'mailboxes')
+        if (value = attributes[:'mailboxes']).is_a?(Array)
+          self.mailboxes = value
+        end
+      else
+        self.mailboxes = nil
+      end
+
+      if attributes.key?(:'permissions')
+        if (value = attributes[:'permissions']).is_a?(Array)
+          self.permissions = value
+        end
+      else
+        self.permissions = nil
+      end
+
+      if attributes.key?(:'team')
+        self.team = attributes[:'team']
+      else
+        self.team = 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 @credential.nil?
+        invalid_properties.push('invalid value for "credential", credential cannot be nil.')
+      end
+
+      if @label.nil?
+        invalid_properties.push('invalid value for "label", label cannot be nil.')
+      end
+
+      if @mailboxes.nil?
+        invalid_properties.push('invalid value for "mailboxes", mailboxes cannot be nil.')
+      end
+
+      if @permissions.nil?
+        invalid_properties.push('invalid value for "permissions", permissions cannot be nil.')
+      end
+
+      if @team.nil?
+        invalid_properties.push('invalid value for "team", team 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 @credential.nil?
+      return false if @label.nil?
+      return false if @mailboxes.nil?
+      return false if @permissions.nil?
+      return false if @team.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] credential Value to be assigned
+    def credential=(credential)
+      if credential.nil?
+        fail ArgumentError, 'credential cannot be nil'
+      end
+
+      @credential = credential
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] label Value to be assigned
+    def label=(label)
+      if label.nil?
+        fail ArgumentError, 'label cannot be nil'
+      end
+
+      @label = label
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mailboxes Value to be assigned
+    def mailboxes=(mailboxes)
+      if mailboxes.nil?
+        fail ArgumentError, 'mailboxes cannot be nil'
+      end
+
+      @mailboxes = mailboxes
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] permissions Value to be assigned
+    def permissions=(permissions)
+      if permissions.nil?
+        fail ArgumentError, 'permissions cannot be nil'
+      end
+
+      @permissions = permissions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] team Value to be assigned
+    def team=(team)
+      if team.nil?
+        fail ArgumentError, 'team cannot be nil'
+      end
+
+      @team = team
+    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 &&
+          credential == o.credential &&
+          label == o.label &&
+          mailboxes == o.mailboxes &&
+          permissions == o.permissions &&
+          team == o.team
+    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
+      [credential, label, mailboxes, permissions, team].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