sendmux-management 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8f708b754f5bf79c8c450cbec76a5415147f4389b46ed535e997257ebd9f959
+  data.tar.gz: 722d48a034be11ba9462407627d128c7d63d43ffb2ed3b21797fcb3af0cf1319
+SHA512:
+  metadata.gz: d704c27c1802a4e1ad380670bfff60e4af71667638ced88288de0f51eb29a48d936cb7c231cd44959dcebc5003de23dbc68d0e7ebbf066624971fbc32a989d5e
+  data.tar.gz: c6fa21431a4bd6289722153d1bfd970f761e4e5f96ffca5eb847180aa21cdfc4619ea111582430d0997df9d934ec70530696c496a3edebd33a754504b5376251

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 Management API package.

data/README.md

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

data/lib/sendmux/management/client.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Sendmux
+  module Management
+    DEFAULT_BASE_URL = 'https://app.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 billing
+        @billing ||= Generated::BillingApi.new(@api_client)
+      end
+
+      def domain_filters
+        @domain_filters ||= Generated::DomainFiltersApi.new(@api_client)
+      end
+
+      def domains
+        @domains ||= Generated::DomainsApi.new(@api_client)
+      end
+
+      def emails
+        @emails ||= Generated::EmailsApi.new(@api_client)
+      end
+
+      def inboxes
+        @inboxes ||= Generated::InboxesApi.new(@api_client)
+      end
+
+      def mailbox_filters
+        @mailbox_filters ||= Generated::MailboxFiltersApi.new(@api_client)
+      end
+
+      def mailboxes
+        @mailboxes ||= Generated::MailboxesApi.new(@api_client)
+      end
+
+      def sending_accounts
+        @sending_accounts ||= Generated::SendingAccountsApi.new(@api_client)
+      end
+
+      def webhooks
+        @webhooks ||= Generated::WebhooksApi.new(@api_client)
+      end
+    end
+  end
+end

data/lib/sendmux/management/version.rb

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

data/lib/sendmux/management.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'sendmux/core'
+
+module Sendmux
+  module Management
+  end
+end
+
+require 'sendmux/management/version'
+require 'sendmux_management_generated'
+require 'sendmux/management/client'

data/lib/sendmux_management_generated/api/billing_api.rb

@@ -0,0 +1,221 @@
+=begin
+#Sendmux API
+
+#Programmatic access to your Sendmux email infrastructure.
+
+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::Management::Generated
+  class BillingApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get spend summary
+    # Returns a spend summary over a configurable lookback period.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :days
+    # @return [SpendSummaryResponse]
+    def management_get_spend_summary(opts = {})
+      data, _status_code, _headers = management_get_spend_summary_with_http_info(opts)
+      data
+    end
+
+    # Get spend summary
+    # Returns a spend summary over a configurable lookback period.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :days
+    # @return [Array<(SpendSummaryResponse, Integer, Hash)>] SpendSummaryResponse data, response status code and response headers
+    def management_get_spend_summary_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BillingApi.management_get_spend_summary ...'
+      end
+      allowable_values = ["7", "30", "90", "unknown_default_open_api"]
+      if @api_client.config.client_side_validation && opts[:'days'] && !allowable_values.include?(opts[:'days'])
+        fail ArgumentError, "invalid value for \"days\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/billing/summary'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
+
+      # 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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SpendSummaryResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"BillingApi.management_get_spend_summary",
+        :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: BillingApi#management_get_spend_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get current balance
+    # Returns the current team balance and auto top-up configuration.
+    # @param [Hash] opts the optional parameters
+    # @return [BalanceResponse]
+    def management_list_balance(opts = {})
+      data, _status_code, _headers = management_list_balance_with_http_info(opts)
+      data
+    end
+
+    # Get current balance
+    # Returns the current team balance and auto top-up configuration.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BalanceResponse, Integer, Hash)>] BalanceResponse data, response status code and response headers
+    def management_list_balance_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BillingApi.management_list_balance ...'
+      end
+      # resource path
+      local_var_path = '/billing/balance'
+
+      # 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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BalanceResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"BillingApi.management_list_balance",
+        :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: BillingApi#management_list_balance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List transactions
+    # Returns paginated credit transaction history with optional type filter. Uses cursor-based pagination ordered by created_at descending — pass `cursor=<next_cursor>` from the previous response to fetch the next page.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor
+    # @option opts [Integer] :limit
+    # @option opts [String] :type
+    # @return [TransactionCursorListResponse]
+    def management_list_transactions(opts = {})
+      data, _status_code, _headers = management_list_transactions_with_http_info(opts)
+      data
+    end
+
+    # List transactions
+    # Returns paginated credit transaction history with optional type filter. Uses cursor-based pagination ordered by created_at descending — pass &#x60;cursor&#x3D;&lt;next_cursor&gt;&#x60; from the previous response to fetch the next page.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor
+    # @option opts [Integer] :limit
+    # @option opts [String] :type
+    # @return [Array<(TransactionCursorListResponse, Integer, Hash)>] TransactionCursorListResponse data, response status code and response headers
+    def management_list_transactions_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BillingApi.management_list_transactions ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BillingApi.management_list_transactions, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BillingApi.management_list_transactions, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["PURCHASE", "USAGE", "AUTO_TOPUP", "REFUND", "ADJUSTMENT", "unknown_default_open_api"]
+      if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
+        fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/billing/transactions'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
+
+      # 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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TransactionCursorListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"BillingApi.management_list_transactions",
+        :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: BillingApi#management_list_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/sendmux_management_generated/api/domain_filters_api.rb

@@ -0,0 +1,161 @@
+=begin
+#Sendmux API
+
+#Programmatic access to your Sendmux email infrastructure.
+
+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::Management::Generated
+  class DomainFiltersApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get domain-wide sender filters
+    # Returns the current sender-filter mode and rule set applied to every mailbox under this domain. Per-mailbox rules take precedence at match time.  Responses carry a weak `ETag` — send it as `If-None-Match` to skip the body when the filter set has not changed (returns `304 Not Modified`). The same ETag is the value to use in `If-Match` on the corresponding PUT for optimistic concurrency.
+    # @param public_id [String]
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_none_match
+    # @return [FilterStateResponse]
+    def management_get_domain_filters(public_id, opts = {})
+      data, _status_code, _headers = management_get_domain_filters_with_http_info(public_id, opts)
+      data
+    end
+
+    # Get domain-wide sender filters
+    # Returns the current sender-filter mode and rule set applied to every mailbox under this domain. Per-mailbox rules take precedence at match time.  Responses carry a weak `ETag` — send it as `If-None-Match` to skip the body when the filter set has not changed (returns `304 Not Modified`). The same ETag is the value to use in `If-Match` on the corresponding PUT for optimistic concurrency.
+    # @param public_id [String]
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_none_match
+    # @return [Array<(FilterStateResponse, Integer, Hash)>] FilterStateResponse data, response status code and response headers
+    def management_get_domain_filters_with_http_info(public_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DomainFiltersApi.management_get_domain_filters ...'
+      end
+      # verify the required parameter 'public_id' is set
+      if @api_client.config.client_side_validation && public_id.nil?
+        fail ArgumentError, "Missing the required parameter 'public_id' when calling DomainFiltersApi.management_get_domain_filters"
+      end
+      # resource path
+      local_var_path = '/domains/{public_id}/filters'.sub('{public_id}', CGI.escape(public_id.to_s))
+
+      # 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] || 'FilterStateResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DomainFiltersApi.management_get_domain_filters",
+        :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: DomainFiltersApi#management_get_domain_filters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Replace domain-wide sender filters
+    # Atomically replaces the sender-filter mode and rule set for an entire domain. Applies to every mailbox under the domain unless that mailbox has its own per-mailbox rules (which take precedence). Maximum 1000 rules per request.  For optimistic concurrency, send `If-Match: <etag>` using the ETag from a prior GET. A mismatched `If-Match` returns `409 conflict` (the server's ETag is echoed back so you can decide whether to re-fetch). Responses carry the new ETag so chained edits can pipeline without a re-GET.
+    # @param public_id [String]
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_match
+    # @option opts [SetFilterStateBody] :set_filter_state_body
+    # @return [FilterStateResponse]
+    def management_set_domain_filters(public_id, opts = {})
+      data, _status_code, _headers = management_set_domain_filters_with_http_info(public_id, opts)
+      data
+    end
+
+    # Replace domain-wide sender filters
+    # Atomically replaces the sender-filter mode and rule set for an entire domain. Applies to every mailbox under the domain unless that mailbox has its own per-mailbox rules (which take precedence). Maximum 1000 rules per request.  For optimistic concurrency, send &#x60;If-Match: &lt;etag&gt;&#x60; using the ETag from a prior GET. A mismatched &#x60;If-Match&#x60; returns &#x60;409 conflict&#x60; (the server&#39;s ETag is echoed back so you can decide whether to re-fetch). Responses carry the new ETag so chained edits can pipeline without a re-GET.
+    # @param public_id [String]
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_match
+    # @option opts [SetFilterStateBody] :set_filter_state_body
+    # @return [Array<(FilterStateResponse, Integer, Hash)>] FilterStateResponse data, response status code and response headers
+    def management_set_domain_filters_with_http_info(public_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DomainFiltersApi.management_set_domain_filters ...'
+      end
+      # verify the required parameter 'public_id' is set
+      if @api_client.config.client_side_validation && public_id.nil?
+        fail ArgumentError, "Missing the required parameter 'public_id' when calling DomainFiltersApi.management_set_domain_filters"
+      end
+      # resource path
+      local_var_path = '/domains/{public_id}/filters'.sub('{public_id}', CGI.escape(public_id.to_s))
+
+      # 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[:'If-Match'] = opts[:'if_match'] if !opts[:'if_match'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'set_filter_state_body'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FilterStateResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"DomainFiltersApi.management_set_domain_filters",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DomainFiltersApi#management_set_domain_filters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end