sendmux-mailbox 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 185a1cf244f03c241ad489815c5775df280176f155933b4a7993d6e10a6b21e0
-  data.tar.gz: ac65eea0e636acb0c16ecf60a2e986dfcceff9fea7d6d8419438625932c13500
+  metadata.gz: c8e1b0e705f607337315096115ace9127a97f01d79aca0c2e5fecc48b4c7ed8e
+  data.tar.gz: 3a924f8fc35fd94b028d3a16ca97140e16b29aa2a680d92de07c0b4d7d6a81ab
 SHA512:
-  metadata.gz: c6c951a2c866d039d5553f3c4d97c8ee895d93422c252168912cb418a0e71092fcbcda468f8348cefb1fc2b9ce092a107c1eaab860ffb59d216817f1bb9b65f6
-  data.tar.gz: b97ee7501cc9ef8f72d09d7453036855e1a511d2dc77f421c4a9f1db895077e44142eff7853b1fa0ad165ad15a554fe88d2255681069c7492ce63015bd707326
+  metadata.gz: 5eab57ef617a7d08c59da74bbb0126cc1e30c2ffcb7316cd832e37e6ba6fb5b99658a44a3b7686c2e310722afdbba7988f67d74b1d2cfcf976ace33cb825ac65
+  data.tar.gz: cb889b2b515e98b60e826e4f3404effe59593ff0c83950ecd8e91ae2021312691ffe3cad4d86540e2e89b7c8bbfc972ffdaa294a257cc01474ee2c6856cd8fc5

data/CHANGELOG.md

@@ -1,10 +1,20 @@
 # Changelog
 
-## Unreleased
+## [1.4.0](https://github.com/Sendmux/sendmux-sdk/compare/ruby-mailbox/v1.3.0...ruby-mailbox/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-mailbox/v1.2.0...ruby-mailbox/v1.3.0) (2026-09-08)
+
 
 ### Features
 
 * regenerate mailbox models for short-lived attachment download URLs and upload intents
+* 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-mailbox/v1.1.0...ruby-mailbox/v1.2.0) (2026-07-08)
 

data/README.md

@@ -18,6 +18,8 @@ Ruby SDK package for the Sendmux Mailbox API.
 - Ruby 3.1 or newer.
 - A mailbox-scoped `smx_mbx_` key or scoped `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-mailbox", "~> 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/mailbox"
+
+client = Sendmux::Mailbox::Client.new(
+  access_token: -> { ENV.fetch("SENDMUX_ACCESS_TOKEN") }
+)
+```
+
 ## Usage
 
-Create a mailbox client with a mailbox key or scoped agent token before calling generated operations.
+Create a mailbox client with a mailbox key or scoped agent token for the API-key example below.
 
 ```ruby
 require "sendmux/mailbox"

data/lib/sendmux/mailbox/client.rb

@@ -5,6 +5,12 @@ module Sendmux
     DEFAULT_BASE_URL = 'https://app.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::MAILBOX,
-          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/mailbox/version.rb

@@ -2,6 +2,6 @@
 
 module Sendmux
   module Mailbox
-    VERSION = '1.2.0'
+    VERSION = '1.4.0'
   end
 end

data/lib/sendmux_mailbox_generated/api/mailbox_api_api.rb

@@ -67,7 +67,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxBatchDeleteMessagesResultResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_batch_delete_messages",
@@ -134,7 +134,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxBatchGetResultResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_batch_get_messages",
@@ -201,7 +201,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxBatchUpdateMessagesResultResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_batch_update_messages",
@@ -326,7 +326,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxMessageCountResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_count_messages",
@@ -346,7 +346,7 @@ module Sendmux::Mailbox::Generated
     end
 
     # Create a presigned mailbox attachment upload
-    # Creates a short-lived signed PUT URL for one attachment. The caller must be authenticated to mint the URL; the later PUT uses the signed URL, exact Content-Type, and exact Content-Length without sending an API key. The PUT returns a blob ID that can be supplied to `POST /mailbox/messages/send`.
+    # Creates a short-lived signed PUT URL for one attachment. The caller must be authenticated to mint the URL; the later PUT uses the signed URL, exact Content-Type, and exact Content-Length without sending a bearer token. The PUT returns a blob ID that can be supplied to `POST /mailbox/messages/send`.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
     # @option opts [MailboxAttachmentUploadIntentBody] :mailbox_attachment_upload_intent_body
@@ -357,7 +357,7 @@ module Sendmux::Mailbox::Generated
     end
 
     # Create a presigned mailbox attachment upload
-    # Creates a short-lived signed PUT URL for one attachment. The caller must be authenticated to mint the URL; the later PUT uses the signed URL, exact Content-Type, and exact Content-Length without sending an API key. The PUT returns a blob ID that can be supplied to `POST /mailbox/messages/send`.
+    # Creates a short-lived signed PUT URL for one attachment. The caller must be authenticated to mint the URL; the later PUT uses the signed URL, exact Content-Type, and exact Content-Length without sending a bearer token. The PUT returns a blob ID that can be supplied to `POST /mailbox/messages/send`.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
     # @option opts [MailboxAttachmentUploadIntentBody] :mailbox_attachment_upload_intent_body
@@ -393,7 +393,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxAttachmentUploadIntentResultResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_create_attachment_upload",
@@ -460,7 +460,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxFolderResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_create_folder",
@@ -529,7 +529,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxFolderDeletedResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_delete_folder",
@@ -601,7 +601,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxMessageDeletedResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_delete_message",
@@ -696,7 +696,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxGetChanges200Response'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_get_changes",
@@ -715,6 +715,66 @@ module Sendmux::Mailbox::Generated
       return data, status_code, headers
     end
 
+    # Get Mailbox connection
+    # Validate this credential and return its team, connection label, permissions and authorised mailboxes. No additional read permission or mailbox selection is required. Mailbox storage and sending availability are not checked. No user profile or secrets are returned.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_none_match ETag from a previous response. A match returns 304 with no body after rechecking authentication.
+    # @return [ConnectionResponse]
+    def mailbox_get_connection(opts = {})
+      data, _status_code, _headers = mailbox_get_connection_with_http_info(opts)
+      data
+    end
+
+    # Get Mailbox connection
+    # Validate this credential and return its team, connection label, permissions and authorised mailboxes. No additional read permission or mailbox selection is required. Mailbox storage and sending availability are not checked. No user profile or secrets are returned.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_none_match ETag from a previous response. A match returns 304 with no body after rechecking authentication.
+    # @return [Array<(ConnectionResponse, Integer, Hash)>] ConnectionResponse data, response status code and response headers
+    def mailbox_get_connection_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MailboxAPIApi.mailbox_get_connection ...'
+      end
+      # resource path
+      local_var_path = '/mailbox/connection'
+
+      # 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 => :"MailboxAPIApi.mailbox_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: MailboxAPIApi#mailbox_get_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a mailbox folder
     # Returns one folder from the authenticated mailbox. Responses include a weak `ETag` header.
     # @param folder_id [String]
@@ -765,7 +825,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxFolderResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_get_folder",
@@ -839,7 +899,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxChangesResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_get_folder_changes",
@@ -899,7 +959,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxIdentityResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_get_identity",
@@ -919,7 +979,7 @@ module Sendmux::Mailbox::Generated
     end
 
     # Self-introspect the calling mailbox
-    # Returns the mailbox the bearer token is scoped to, including live storage usage. Intended for SDK auto-discovery — call once on startup to resolve the mailbox ID. Requires a mailbox-scoped API key; root keys receive 403.  Responses carry a weak `ETag` header — send it back as `If-None-Match` on the next request and the server will return `304 Not Modified` (no body) when the mailbox state has not changed.
+    # Returns the selected mailbox, including live storage usage. Requires a mailbox credential or OAuth grant with Mailbox API access. For credential validation without selecting a mailbox or checking storage, use GET /mailbox/connection.  Responses carry a weak `ETag` header — send it back as `If-None-Match` on the next request and the server will return `304 Not Modified` (no body) when the mailbox state has not changed.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :if_none_match
     # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
@@ -930,7 +990,7 @@ module Sendmux::Mailbox::Generated
     end
 
     # Self-introspect the calling mailbox
-    # Returns the mailbox the bearer token is scoped to, including live storage usage. Intended for SDK auto-discovery — call once on startup to resolve the mailbox ID. Requires a mailbox-scoped API key; root keys receive 403.  Responses carry a weak &#x60;ETag&#x60; header — send it back as &#x60;If-None-Match&#x60; on the next request and the server will return &#x60;304 Not Modified&#x60; (no body) when the mailbox state has not changed.
+    # Returns the selected mailbox, including live storage usage. Requires a mailbox credential or OAuth grant with Mailbox API access. For credential validation without selecting a mailbox or checking storage, use GET /mailbox/connection.  Responses carry a weak &#x60;ETag&#x60; header — send it back as &#x60;If-None-Match&#x60; on the next request and the server will return &#x60;304 Not Modified&#x60; (no body) when the mailbox state has not changed.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :if_none_match
     # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
@@ -962,7 +1022,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxMeItemResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_get_me",
@@ -1031,7 +1091,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxMessageDetailResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_get_message",
@@ -1109,7 +1169,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_get_message_attachment",
@@ -1183,7 +1243,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxChangesResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_get_quota_changes",
@@ -1246,7 +1306,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxSessionResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_get_session",
@@ -1315,7 +1375,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxSubmissionResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_get_submission",
@@ -1389,7 +1449,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxChangesResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_get_submission_changes",
@@ -1458,7 +1518,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxThreadDetailResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_get_thread",
@@ -1592,7 +1652,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxThreadContentResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_get_thread_content",
@@ -1679,7 +1739,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxRawBodyResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_list_body",
@@ -1792,7 +1852,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxMessageContentResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_list_content",
@@ -1866,7 +1926,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxFolderCursorListResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_list_folders",
@@ -1940,7 +2000,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'GrantedMailboxListResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_list_granted_mailboxes",
@@ -2014,7 +2074,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxIdentityCursorListResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_list_identities",
@@ -2034,7 +2094,7 @@ module Sendmux::Mailbox::Generated
     end
 
     # List mailbox messages
-    # Returns a cursor-paginated list of messages for the authenticated mailbox. Requires a mailbox API key.
+    # Returns a cursor-paginated list of messages for the authenticated mailbox. Requires Mailbox API access.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :cursor
     # @option opts [Integer] :limit
@@ -2067,7 +2127,7 @@ module Sendmux::Mailbox::Generated
     end
 
     # List mailbox messages
-    # Returns a cursor-paginated list of messages for the authenticated mailbox. Requires a mailbox API key.
+    # Returns a cursor-paginated list of messages for the authenticated mailbox. Requires Mailbox API access.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :cursor
     # @option opts [Integer] :limit
@@ -2167,7 +2227,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxMessageSummaryCursorListResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_list_messages",
@@ -2275,7 +2335,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxQuotaCursorListResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_list_quotas",
@@ -2385,7 +2445,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxSubmissionCursorListResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_list_submissions",
@@ -2472,7 +2532,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxMessageSummaryCursorListResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_list_thread_messages",
@@ -2574,7 +2634,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxThreadSummaryCursorListResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_list_threads",
@@ -2637,7 +2697,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxUsageResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_list_usage",
@@ -2711,7 +2771,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxFolderQueryChangesResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_query_folder_changes",
@@ -2867,7 +2927,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxMessageQueryChangesResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_query_message_changes",
@@ -3007,7 +3067,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxSearchSnippetsResultResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_search_message_snippets",
@@ -3081,7 +3141,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxSendResultResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_send_message",
@@ -3103,12 +3163,12 @@ module Sendmux::Mailbox::Generated
     # Stream mailbox events
     # Streams bounded rich mailbox events for connected clients. Each received-message event includes subject, participants, preview, attachment metadata, and a capped body snapshot; use the message endpoints for full content or attachment bytes.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :mailbox_id
     # @option opts [String] :event_types
     # @option opts [String] :last_event_id
     # @option opts [Integer] :ping
     # @option opts [Integer] :close_after
     # @option opts [String] :last_event_id2
-    # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
     # @return [MailboxRealtimeEvent]
     def mailbox_stream_events(opts = {})
       data, _status_code, _headers = mailbox_stream_events_with_http_info(opts)
@@ -3118,12 +3178,12 @@ module Sendmux::Mailbox::Generated
     # Stream mailbox events
     # Streams bounded rich mailbox events for connected clients. Each received-message event includes subject, participants, preview, attachment metadata, and a capped body snapshot; use the message endpoints for full content or attachment bytes.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :mailbox_id
     # @option opts [String] :event_types
     # @option opts [String] :last_event_id
     # @option opts [Integer] :ping
     # @option opts [Integer] :close_after
     # @option opts [String] :last_event_id2
-    # @option opts [String] :mailbox_id Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.
     # @return [Array<(MailboxRealtimeEvent, Integer, Hash)>] MailboxRealtimeEvent data, response status code and response headers
     def mailbox_stream_events_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -3150,11 +3210,11 @@ module Sendmux::Mailbox::Generated
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
       query_params[:'event_types'] = opts[:'event_types'] if !opts[:'event_types'].nil?
       query_params[:'last_event_id'] = opts[:'last_event_id'] if !opts[:'last_event_id'].nil?
       query_params[:'ping'] = opts[:'ping'] if !opts[:'ping'].nil?
       query_params[:'close_after'] = opts[:'close_after'] if !opts[:'close_after'].nil?
-      query_params[:'mailbox_id'] = opts[:'mailbox_id'] if !opts[:'mailbox_id'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -3172,7 +3232,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxRealtimeEvent'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_stream_events",
@@ -3248,7 +3308,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxFolderResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_update_folder",
@@ -3315,7 +3375,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxIdentityResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_update_identity",
@@ -3391,7 +3451,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxMessageDetailResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_update_message",
@@ -3465,7 +3525,7 @@ module Sendmux::Mailbox::Generated
       return_type = opts[:debug_return_type] || 'MailboxAttachmentUploadResultResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+      auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
 
       new_options = opts.merge(
         :operation => :"MailboxAPIApi.mailbox_upload_attachment",

data/lib/sendmux_mailbox_generated/configuration.rb

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