sendmux-sending 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 918f45018116ebe842bcaf14f9c9c2508b341f06e1d7177640a669e5ca5cd4d2
+  data.tar.gz: cbc93b2be68a0b6b83421ff36b7c5123ef26b0df35a71726c7eb584c0f2fedf8
+SHA512:
+  metadata.gz: aad5e18355aca1dddc0d5ed536d8fa38ac97c1131bf2c17ee0faafa95a84ba5e90997ca970d6bce89131649cb2f685c47996d0428f8bc0d90120917a11977176
+  data.tar.gz: 0c308914b4d52a68b0eea4c7c69f78f7c15551b8bcb492677312bd18898786c0b35df705565ecbb5395c1b745afaed6354967dc62aefe645b7a6d3a2c6e3a5f6

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 1.0.0 (2026-06-02)
+
+
+### Features
+
+* **ruby:** add generated SDK packages ([f097fdf](https://github.com/Sendmux/sendmux-sdk/commit/f097fdf6afcbc2a048d9fdb1c9a669fff2a7ca4f))
+
+## 1.0.0
+
+- Initial generated Ruby Sending API package.

data/README.md

@@ -0,0 +1,3 @@
+# sendmux-sending
+
+Ruby SDK package for the Sendmux Sending API.

data/lib/sendmux/sending/client.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Sendmux
+  module Sending
+    DEFAULT_BASE_URL = 'https://smtp.sendmux.ai/api/v1'
+
+    class ApiClient < Generated::ApiClient
+      def call_api(...)
+        super
+      rescue Generated::ApiError => e
+        raise Sendmux::Core::ErrorMapper.map(e)
+      end
+    end
+
+    class Client
+      attr_reader :api_client, :configuration
+
+      def initialize(api_key:, base_url: DEFAULT_BASE_URL, retry_options: nil)
+        @configuration = Sendmux::Core::Auth.configure_bearer(
+          Generated::Configuration.new,
+          api_key,
+          Sendmux::Core::ApiKeySurface::ROOT,
+          base_url: base_url
+        )
+        Sendmux::Core::Retry.configure(@configuration, retry_options)
+        @api_client = ApiClient.new(@configuration)
+      end
+
+      def emails
+        @emails ||= Generated::EmailsApi.new(@api_client)
+      end
+    end
+  end
+end

data/lib/sendmux/sending/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sendmux
+  module Sending
+    VERSION = '1.0.0'
+  end
+end

data/lib/sendmux/sending.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'sendmux/core'
+
+module Sendmux
+  module Sending
+  end
+end
+
+require 'sendmux/sending/version'
+require 'sendmux_sending_generated'
+require 'sendmux/sending/client'

data/lib/sendmux_sending_generated/api/emails_api.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 'cgi'
+
+module Sendmux::Sending::Generated
+  class EmailsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Send a single email
+    # Queue a single email for delivery. Requires `email.send` permission.
+    # @param email_send_request [EmailSendRequest]
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Optional client-generated key to make the request idempotent for 24 hours. Replays under the same key return the cached response; a reused key with a different body returns 409 idempotency_conflict.
+    # @return [SendSuccessResponse]
+    def sending_send_email(email_send_request, opts = {})
+      data, _status_code, _headers = sending_send_email_with_http_info(email_send_request, opts)
+      data
+    end
+
+    # Send a single email
+    # Queue a single email for delivery. Requires `email.send` permission.
+    # @param email_send_request [EmailSendRequest]
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Optional client-generated key to make the request idempotent for 24 hours. Replays under the same key return the cached response; a reused key with a different body returns 409 idempotency_conflict.
+    # @return [Array<(SendSuccessResponse, Integer, Hash)>] SendSuccessResponse data, response status code and response headers
+    def sending_send_email_with_http_info(email_send_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailsApi.sending_send_email ...'
+      end
+      # verify the required parameter 'email_send_request' is set
+      if @api_client.config.client_side_validation && email_send_request.nil?
+        fail ArgumentError, "Missing the required parameter 'email_send_request' when calling EmailsApi.sending_send_email"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmailsApi.sending_send_email, the character length must be smaller than or equal to 255.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmailsApi.sending_send_email, the character length must be greater than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"idempotency_key\"]' when calling EmailsApi.sending_send_email, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/emails/send'
+
+      # 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']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(email_send_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SendSuccessResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"EmailsApi.sending_send_email",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EmailsApi#sending_send_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send a batch of emails
+    # Queue up to 100 emails for delivery in a single request. Uses partial success model — individual message failures do not fail the entire batch. Requires `email.send` permission.
+    # @param batch_send_request [BatchSendRequest]
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Optional client-generated key to make the request idempotent for 24 hours. Replays under the same key return the cached response; a reused key with a different body returns 409 idempotency_conflict.
+    # @return [BatchSendSuccessResponse]
+    def sending_send_email_batch(batch_send_request, opts = {})
+      data, _status_code, _headers = sending_send_email_batch_with_http_info(batch_send_request, opts)
+      data
+    end
+
+    # Send a batch of emails
+    # Queue up to 100 emails for delivery in a single request. Uses partial success model — individual message failures do not fail the entire batch. Requires &#x60;email.send&#x60; permission.
+    # @param batch_send_request [BatchSendRequest]
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Optional client-generated key to make the request idempotent for 24 hours. Replays under the same key return the cached response; a reused key with a different body returns 409 idempotency_conflict.
+    # @return [Array<(BatchSendSuccessResponse, Integer, Hash)>] BatchSendSuccessResponse data, response status code and response headers
+    def sending_send_email_batch_with_http_info(batch_send_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailsApi.sending_send_email_batch ...'
+      end
+      # verify the required parameter 'batch_send_request' is set
+      if @api_client.config.client_side_validation && batch_send_request.nil?
+        fail ArgumentError, "Missing the required parameter 'batch_send_request' when calling EmailsApi.sending_send_email_batch"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmailsApi.sending_send_email_batch, the character length must be smaller than or equal to 255.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmailsApi.sending_send_email_batch, the character length must be greater than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"idempotency_key\"]' when calling EmailsApi.sending_send_email_batch, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/emails/send/batch'
+
+      # 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']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_send_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BatchSendSuccessResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"EmailsApi.sending_send_email_batch",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EmailsApi#sending_send_email_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end