sendmux-mailbox 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8e1b0e705f607337315096115ace9127a97f01d79aca0c2e5fecc48b4c7ed8e
-  data.tar.gz: 3a924f8fc35fd94b028d3a16ca97140e16b29aa2a680d92de07c0b4d7d6a81ab
+  metadata.gz: 68c9526f6b5a337fbca544020f422373d3b8a3f2f5297cc46a5dd89fc56e8178
+  data.tar.gz: ba40867ae0335bfecac6c6fa72734ae1ab9fc7f709a24fe4092eb11451be2536
 SHA512:
-  metadata.gz: 5eab57ef617a7d08c59da74bbb0126cc1e30c2ffcb7316cd832e37e6ba6fb5b99658a44a3b7686c2e310722afdbba7988f67d74b1d2cfcf976ace33cb825ac65
-  data.tar.gz: cb889b2b515e98b60e826e4f3404effe59593ff0c83950ecd8e91ae2021312691ffe3cad4d86540e2e89b7c8bbfc972ffdaa294a257cc01474ee2c6856cd8fc5
+  metadata.gz: 99f90042244c3f8438a6dd761a92e9b06a17dd2a84d689bf1b98c88d9706ff21f245f082152f1fa3601a3c671de9d94d52716772bafaa1b42edbcc99fccd72c5
+  data.tar.gz: e648e591dce5ef866b33dde9b23325dbfb707b19af956bcee415d8b0bb80d67b04d74855c1f171a3c5c8f2d4fc88d326e86877d6d0e12d437a18f88063289904

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [2.0.0](https://github.com/Sendmux/sendmux-sdk/compare/ruby-mailbox/v1.4.0...ruby-mailbox/v2.0.0) (2026-09-19)
+
+### Changed
+
+* **Breaking:** `mailbox_list_thread_messages` returns `MailboxThreadMessageSummaryCursorListResponse`, whose `meta.thread_id` is required and whose optional `meta.sync_state` is typed; thread-message results you construct (fixtures, mocks, wrappers) must now supply `thread_id`, while reading results is unaffected. `mailbox_list_messages` keeps `MailboxMessageSummaryCursorListResponse`; message, identity, submission, quota, and thread list responses replace the generic `ResponseMeta` with `MailboxSyncMeta`, `MailboxIdentityListMeta`, or `MailboxQueryMeta`, which add optional typed state metadata (`sync_state`, `identity_state`, `query_state`) ([87f54eb](https://github.com/Sendmux/sendmux-sdk/commit/87f54eb1679994ddcbdd68ad25d674ad6978f57f)). See [Migrate from 1.x to 2.0](README.md#migrate-from-1x-to-20).
+
+### Bug Fixes
+
+* prepare mailbox SDK major releases ([dc01472](https://github.com/Sendmux/sendmux-sdk/commit/dc014724f7f6eb6b93293e6acbcc1a36c5060ebb))
+* **sdk:** preserve streaming arguments and prepare PHP OAuth release ([#207](https://github.com/Sendmux/sendmux-sdk/issues/207)) ([c534588](https://github.com/Sendmux/sendmux-sdk/commit/c53458875cef0bbd601c982308d84bc4e87c961c))
+
 ## [1.4.0](https://github.com/Sendmux/sendmux-sdk/compare/ruby-mailbox/v1.3.0...ruby-mailbox/v1.4.0) (2026-09-10)
 
 

data/README.md

@@ -29,9 +29,68 @@ gem install sendmux-mailbox
 Or add it to your Gemfile:
 
 ```ruby
-gem "sendmux-mailbox", "~> 1.0"
+gem "sendmux-mailbox", "~> 2.0"
 ```
 
+## Migrate from 1.x to 2.0
+
+If you check thread-message result classes or build thread-message fixtures by
+hand, update them when upgrading to 2.0. `mailbox_list_thread_messages` returns
+`MailboxThreadMessageSummaryCursorListResponse` instead of
+`MailboxMessageSummaryCursorListResponse`: its `meta` is
+`MailboxThreadMessagesMeta`, whose `thread_id` is required and whose
+`sync_state` is an optional string. Code that only reads thread-message results
+keeps working.
+
+1. Update thread-message class checks to use the class loaded by the public
+   entry point:
+
+   ```ruby
+   require "sendmux/mailbox"
+
+   def thread_message_list?(response)
+     # Before: response.is_a?(Sendmux::Mailbox::Generated::MailboxMessageSummaryCursorListResponse)
+     response.is_a?(Sendmux::Mailbox::Generated::MailboxThreadMessageSummaryCursorListResponse)
+   end
+   ```
+
+2. Add the thread identity to every thread-message result you construct. Pass
+   the thread's `id` as the `thread_id` argument when you read one from the
+   public client:
+
+   ```ruby
+   def thread_message_fixture(thread_id)
+     # Before: meta: { request_id: "req_fixture" }
+     Sendmux::Mailbox::Generated::MailboxThreadMessageSummaryCursorListResponse.build_from_hash(
+       ok: true,
+       meta: { request_id: "req_fixture", thread_id: thread_id },
+       data: [],
+       pagination: { has_more: false }
+     )
+   end
+
+   def thread_sync_state(client, thread_id)
+     response = client.mailbox_api.mailbox_list_thread_messages(thread_id, limit: 50)
+     [response.meta.thread_id, response.meta.sync_state]
+   end
+   ```
+
+   Ordinary `mailbox_list_messages` results remain
+   `MailboxMessageSummaryCursorListResponse`: they have no thread identity and
+   expose an optional typed `meta.sync_state`. Identity, submission, quota, and
+   thread list responses likewise replace the generic `ResponseMeta` with
+   `MailboxIdentityListMeta` or `MailboxQueryMeta`, which add optional
+   `identity_state` or `query_state`; `meta.request_id` is unchanged everywhere
+   and no new field is required there.
+
+3. Run your application's tests with the updated bundle. A constructed
+   thread-message result without `meta.thread_id` fails with
+   `ArgumentError: thread_id cannot be nil`.
+
+Update `sendmux-mailbox`, the bundle lock, and affected call sites or fixtures
+together. To roll back, restore those gem requirement, lock, and call-site
+changes together.
+
 ## 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.

data/lib/sendmux/mailbox/version.rb

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

data/lib/sendmux_mailbox_generated/api/mailbox_api_api.rb

@@ -2472,7 +2472,7 @@ module Sendmux::Mailbox::Generated
     # @option opts [Integer] :limit
     # @option opts [String] :sort
     # @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 [MailboxMessageSummaryCursorListResponse]
+    # @return [MailboxThreadMessageSummaryCursorListResponse]
     def mailbox_list_thread_messages(thread_id, opts = {})
       data, _status_code, _headers = mailbox_list_thread_messages_with_http_info(thread_id, opts)
       data
@@ -2486,7 +2486,7 @@ module Sendmux::Mailbox::Generated
     # @option opts [Integer] :limit
     # @option opts [String] :sort
     # @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<(MailboxMessageSummaryCursorListResponse, Integer, Hash)>] MailboxMessageSummaryCursorListResponse data, response status code and response headers
+    # @return [Array<(MailboxThreadMessageSummaryCursorListResponse, Integer, Hash)>] MailboxThreadMessageSummaryCursorListResponse data, response status code and response headers
     def mailbox_list_thread_messages_with_http_info(thread_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MailboxAPIApi.mailbox_list_thread_messages ...'
@@ -2529,7 +2529,7 @@ module Sendmux::Mailbox::Generated
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'MailboxMessageSummaryCursorListResponse'
+      return_type = opts[:debug_return_type] || 'MailboxThreadMessageSummaryCursorListResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['oauth2', 'bearerAuth']
@@ -3163,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
     # @return [MailboxRealtimeEvent]
     def mailbox_stream_events(opts = {})
       data, _status_code, _headers = mailbox_stream_events_with_http_info(opts)
@@ -3178,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
     # @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
@@ -3210,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] || {}

data/lib/sendmux_mailbox_generated/models/mailbox_identity_cursor_list_response.rb

@@ -46,7 +46,7 @@ module Sendmux::Mailbox::Generated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'meta' => :'ResponseMeta',
+        :'meta' => :'MailboxIdentityListMeta',
         :'ok' => :'Boolean',
         :'data' => :'Array<MailboxIdentity>',
         :'pagination' => :'CursorPagination'

data/lib/sendmux_mailbox_generated/models/mailbox_identity_list_meta.rb

@@ -0,0 +1,173 @@
+=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 'date'
+require 'time'
+
+module Sendmux::Mailbox::Generated
+  class MailboxIdentityListMeta < ApiModelBase
+    attr_accessor :identity_state
+
+    attr_accessor :request_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'identity_state' => :'identity_state',
+        :'request_id' => :'request_id'
+      }
+    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
+      {
+        :'identity_state' => :'String',
+        :'request_id' => :'String'
+      }
+    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::Mailbox::Generated::MailboxIdentityListMeta` 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::Mailbox::Generated::MailboxIdentityListMeta`. 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?(:'identity_state')
+        self.identity_state = attributes[:'identity_state']
+      end
+
+      if attributes.key?(:'request_id')
+        self.request_id = attributes[:'request_id']
+      else
+        self.request_id = 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 @request_id.nil?
+        invalid_properties.push('invalid value for "request_id", request_id 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 @request_id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] request_id Value to be assigned
+    def request_id=(request_id)
+      if request_id.nil?
+        fail ArgumentError, 'request_id cannot be nil'
+      end
+
+      @request_id = request_id
+    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 &&
+          identity_state == o.identity_state &&
+          request_id == o.request_id
+    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
+      [identity_state, request_id].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

data/lib/sendmux_mailbox_generated/models/mailbox_message_summary_cursor_list_response.rb

@@ -46,7 +46,7 @@ module Sendmux::Mailbox::Generated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'meta' => :'ResponseMeta',
+        :'meta' => :'MailboxSyncMeta',
         :'ok' => :'Boolean',
         :'data' => :'Array<MailboxMessageSummary>',
         :'pagination' => :'CursorPagination'

data/lib/sendmux_mailbox_generated/models/mailbox_query_meta.rb

@@ -0,0 +1,173 @@
+=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 'date'
+require 'time'
+
+module Sendmux::Mailbox::Generated
+  class MailboxQueryMeta < ApiModelBase
+    attr_accessor :query_state
+
+    attr_accessor :request_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'query_state' => :'query_state',
+        :'request_id' => :'request_id'
+      }
+    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
+      {
+        :'query_state' => :'String',
+        :'request_id' => :'String'
+      }
+    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::Mailbox::Generated::MailboxQueryMeta` 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::Mailbox::Generated::MailboxQueryMeta`. 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?(:'query_state')
+        self.query_state = attributes[:'query_state']
+      end
+
+      if attributes.key?(:'request_id')
+        self.request_id = attributes[:'request_id']
+      else
+        self.request_id = 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 @request_id.nil?
+        invalid_properties.push('invalid value for "request_id", request_id 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 @request_id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] request_id Value to be assigned
+    def request_id=(request_id)
+      if request_id.nil?
+        fail ArgumentError, 'request_id cannot be nil'
+      end
+
+      @request_id = request_id
+    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 &&
+          query_state == o.query_state &&
+          request_id == o.request_id
+    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
+      [query_state, request_id].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

data/lib/sendmux_mailbox_generated/models/mailbox_quota_cursor_list_response.rb

@@ -46,7 +46,7 @@ module Sendmux::Mailbox::Generated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'meta' => :'ResponseMeta',
+        :'meta' => :'MailboxQueryMeta',
         :'ok' => :'Boolean',
         :'data' => :'Array<MailboxQuota>',
         :'pagination' => :'CursorPagination'

data/lib/sendmux_mailbox_generated/models/mailbox_submission_cursor_list_response.rb

@@ -46,7 +46,7 @@ module Sendmux::Mailbox::Generated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'meta' => :'ResponseMeta',
+        :'meta' => :'MailboxQueryMeta',
         :'ok' => :'Boolean',
         :'data' => :'Array<MailboxSubmission>',
         :'pagination' => :'CursorPagination'

data/lib/sendmux_mailbox_generated/models/mailbox_sync_meta.rb

@@ -0,0 +1,173 @@
+=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 'date'
+require 'time'
+
+module Sendmux::Mailbox::Generated
+  class MailboxSyncMeta < ApiModelBase
+    attr_accessor :request_id
+
+    attr_accessor :sync_state
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'request_id' => :'request_id',
+        :'sync_state' => :'sync_state'
+      }
+    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
+      {
+        :'request_id' => :'String',
+        :'sync_state' => :'String'
+      }
+    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::Mailbox::Generated::MailboxSyncMeta` 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::Mailbox::Generated::MailboxSyncMeta`. 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?(:'request_id')
+        self.request_id = attributes[:'request_id']
+      else
+        self.request_id = nil
+      end
+
+      if attributes.key?(:'sync_state')
+        self.sync_state = attributes[:'sync_state']
+      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 @request_id.nil?
+        invalid_properties.push('invalid value for "request_id", request_id 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 @request_id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] request_id Value to be assigned
+    def request_id=(request_id)
+      if request_id.nil?
+        fail ArgumentError, 'request_id cannot be nil'
+      end
+
+      @request_id = request_id
+    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 &&
+          request_id == o.request_id &&
+          sync_state == o.sync_state
+    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
+      [request_id, sync_state].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

data/lib/sendmux_mailbox_generated/models/mailbox_thread_message_summary_cursor_list_response.rb

@@ -0,0 +1,251 @@
+=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 'date'
+require 'time'
+
+module Sendmux::Mailbox::Generated
+  class MailboxThreadMessageSummaryCursorListResponse < ApiModelBase
+    attr_accessor :meta
+
+    attr_accessor :ok
+
+    attr_accessor :data
+
+    attr_accessor :pagination
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'meta' => :'meta',
+        :'ok' => :'ok',
+        :'data' => :'data',
+        :'pagination' => :'pagination'
+      }
+    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
+      {
+        :'meta' => :'MailboxThreadMessagesMeta',
+        :'ok' => :'Boolean',
+        :'data' => :'Array<MailboxMessageSummary>',
+        :'pagination' => :'CursorPagination'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'SuccessEnvelope'
+      ]
+    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::Mailbox::Generated::MailboxThreadMessageSummaryCursorListResponse` 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::Mailbox::Generated::MailboxThreadMessageSummaryCursorListResponse`. 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?(:'meta')
+        self.meta = attributes[:'meta']
+      else
+        self.meta = nil
+      end
+
+      if attributes.key?(:'ok')
+        self.ok = attributes[:'ok']
+      else
+        self.ok = nil
+      end
+
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      else
+        self.data = nil
+      end
+
+      if attributes.key?(:'pagination')
+        self.pagination = attributes[:'pagination']
+      else
+        self.pagination = 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 @meta.nil?
+        invalid_properties.push('invalid value for "meta", meta cannot be nil.')
+      end
+
+      if @ok.nil?
+        invalid_properties.push('invalid value for "ok", ok cannot be nil.')
+      end
+
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      end
+
+      if @pagination.nil?
+        invalid_properties.push('invalid value for "pagination", pagination 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 @meta.nil?
+      return false if @ok.nil?
+      return false if @data.nil?
+      return false if @pagination.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] meta Value to be assigned
+    def meta=(meta)
+      if meta.nil?
+        fail ArgumentError, 'meta cannot be nil'
+      end
+
+      @meta = meta
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ok Value to be assigned
+    def ok=(ok)
+      if ok.nil?
+        fail ArgumentError, 'ok cannot be nil'
+      end
+
+      @ok = ok
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'data cannot be nil'
+      end
+
+      @data = data
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pagination Value to be assigned
+    def pagination=(pagination)
+      if pagination.nil?
+        fail ArgumentError, 'pagination cannot be nil'
+      end
+
+      @pagination = pagination
+    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 &&
+          meta == o.meta &&
+          ok == o.ok &&
+          data == o.data &&
+          pagination == o.pagination
+    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
+      [meta, ok, data, pagination].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

data/lib/sendmux_mailbox_generated/models/mailbox_thread_messages_meta.rb

@@ -0,0 +1,199 @@
+=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 'date'
+require 'time'
+
+module Sendmux::Mailbox::Generated
+  class MailboxThreadMessagesMeta < ApiModelBase
+    attr_accessor :request_id
+
+    attr_accessor :sync_state
+
+    attr_accessor :thread_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'request_id' => :'request_id',
+        :'sync_state' => :'sync_state',
+        :'thread_id' => :'thread_id'
+      }
+    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
+      {
+        :'request_id' => :'String',
+        :'sync_state' => :'String',
+        :'thread_id' => :'String'
+      }
+    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::Mailbox::Generated::MailboxThreadMessagesMeta` 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::Mailbox::Generated::MailboxThreadMessagesMeta`. 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?(:'request_id')
+        self.request_id = attributes[:'request_id']
+      else
+        self.request_id = nil
+      end
+
+      if attributes.key?(:'sync_state')
+        self.sync_state = attributes[:'sync_state']
+      end
+
+      if attributes.key?(:'thread_id')
+        self.thread_id = attributes[:'thread_id']
+      else
+        self.thread_id = 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 @request_id.nil?
+        invalid_properties.push('invalid value for "request_id", request_id cannot be nil.')
+      end
+
+      if @thread_id.nil?
+        invalid_properties.push('invalid value for "thread_id", thread_id 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 @request_id.nil?
+      return false if @thread_id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] request_id Value to be assigned
+    def request_id=(request_id)
+      if request_id.nil?
+        fail ArgumentError, 'request_id cannot be nil'
+      end
+
+      @request_id = request_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] thread_id Value to be assigned
+    def thread_id=(thread_id)
+      if thread_id.nil?
+        fail ArgumentError, 'thread_id cannot be nil'
+      end
+
+      @thread_id = thread_id
+    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 &&
+          request_id == o.request_id &&
+          sync_state == o.sync_state &&
+          thread_id == o.thread_id
+    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
+      [request_id, sync_state, thread_id].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

data/lib/sendmux_mailbox_generated/models/mailbox_thread_summary_cursor_list_response.rb

@@ -46,7 +46,7 @@ module Sendmux::Mailbox::Generated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'meta' => :'ResponseMeta',
+        :'meta' => :'MailboxQueryMeta',
         :'ok' => :'Boolean',
         :'data' => :'Array<MailboxThreadSummary>',
         :'pagination' => :'CursorPagination'

data/lib/sendmux_mailbox_generated.rb

@@ -69,6 +69,7 @@ require 'sendmux_mailbox_generated/models/mailbox_folder_response'
 require 'sendmux_mailbox_generated/models/mailbox_get_changes200_response'
 require 'sendmux_mailbox_generated/models/mailbox_identity'
 require 'sendmux_mailbox_generated/models/mailbox_identity_cursor_list_response'
+require 'sendmux_mailbox_generated/models/mailbox_identity_list_meta'
 require 'sendmux_mailbox_generated/models/mailbox_identity_response'
 require 'sendmux_mailbox_generated/models/mailbox_me'
 require 'sendmux_mailbox_generated/models/mailbox_me_item_response'
@@ -89,6 +90,7 @@ require 'sendmux_mailbox_generated/models/mailbox_message_query_changes'
 require 'sendmux_mailbox_generated/models/mailbox_message_query_changes_response'
 require 'sendmux_mailbox_generated/models/mailbox_message_summary'
 require 'sendmux_mailbox_generated/models/mailbox_message_summary_cursor_list_response'
+require 'sendmux_mailbox_generated/models/mailbox_query_meta'
 require 'sendmux_mailbox_generated/models/mailbox_quota'
 require 'sendmux_mailbox_generated/models/mailbox_quota_cursor_list_response'
 require 'sendmux_mailbox_generated/models/mailbox_raw_body'
@@ -126,12 +128,15 @@ require 'sendmux_mailbox_generated/models/mailbox_submission_envelope'
 require 'sendmux_mailbox_generated/models/mailbox_submission_envelope_address'
 require 'sendmux_mailbox_generated/models/mailbox_submission_envelope_rcpt_to_inner'
 require 'sendmux_mailbox_generated/models/mailbox_submission_response'
+require 'sendmux_mailbox_generated/models/mailbox_sync_meta'
 require 'sendmux_mailbox_generated/models/mailbox_thread'
 require 'sendmux_mailbox_generated/models/mailbox_thread_content_meta'
 require 'sendmux_mailbox_generated/models/mailbox_thread_content_meta_states'
 require 'sendmux_mailbox_generated/models/mailbox_thread_content_response'
 require 'sendmux_mailbox_generated/models/mailbox_thread_content_response_all_of_data'
 require 'sendmux_mailbox_generated/models/mailbox_thread_detail_response'
+require 'sendmux_mailbox_generated/models/mailbox_thread_message_summary_cursor_list_response'
+require 'sendmux_mailbox_generated/models/mailbox_thread_messages_meta'
 require 'sendmux_mailbox_generated/models/mailbox_thread_summary'
 require 'sendmux_mailbox_generated/models/mailbox_thread_summary_cursor_list_response'
 require 'sendmux_mailbox_generated/models/mailbox_thread_summary_states'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sendmux-mailbox
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Sendmux
 bindir: bin
 cert_chain: []
-date: 2026-09-10 00:00:00.000000000 Z
+date: 2026-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -160,6 +160,7 @@ files:
 - lib/sendmux_mailbox_generated/models/mailbox_get_changes200_response.rb
 - lib/sendmux_mailbox_generated/models/mailbox_identity.rb
 - lib/sendmux_mailbox_generated/models/mailbox_identity_cursor_list_response.rb
+- lib/sendmux_mailbox_generated/models/mailbox_identity_list_meta.rb
 - lib/sendmux_mailbox_generated/models/mailbox_identity_response.rb
 - lib/sendmux_mailbox_generated/models/mailbox_me.rb
 - lib/sendmux_mailbox_generated/models/mailbox_me_item_response.rb
@@ -180,6 +181,7 @@ files:
 - lib/sendmux_mailbox_generated/models/mailbox_message_query_changes_response.rb
 - lib/sendmux_mailbox_generated/models/mailbox_message_summary.rb
 - lib/sendmux_mailbox_generated/models/mailbox_message_summary_cursor_list_response.rb
+- lib/sendmux_mailbox_generated/models/mailbox_query_meta.rb
 - lib/sendmux_mailbox_generated/models/mailbox_quota.rb
 - lib/sendmux_mailbox_generated/models/mailbox_quota_cursor_list_response.rb
 - lib/sendmux_mailbox_generated/models/mailbox_raw_body.rb
@@ -217,12 +219,15 @@ files:
 - lib/sendmux_mailbox_generated/models/mailbox_submission_envelope_address.rb
 - lib/sendmux_mailbox_generated/models/mailbox_submission_envelope_rcpt_to_inner.rb
 - lib/sendmux_mailbox_generated/models/mailbox_submission_response.rb
+- lib/sendmux_mailbox_generated/models/mailbox_sync_meta.rb
 - lib/sendmux_mailbox_generated/models/mailbox_thread.rb
 - lib/sendmux_mailbox_generated/models/mailbox_thread_content_meta.rb
 - lib/sendmux_mailbox_generated/models/mailbox_thread_content_meta_states.rb
 - lib/sendmux_mailbox_generated/models/mailbox_thread_content_response.rb
 - lib/sendmux_mailbox_generated/models/mailbox_thread_content_response_all_of_data.rb
 - lib/sendmux_mailbox_generated/models/mailbox_thread_detail_response.rb
+- lib/sendmux_mailbox_generated/models/mailbox_thread_message_summary_cursor_list_response.rb
+- lib/sendmux_mailbox_generated/models/mailbox_thread_messages_meta.rb
 - lib/sendmux_mailbox_generated/models/mailbox_thread_summary.rb
 - lib/sendmux_mailbox_generated/models/mailbox_thread_summary_cursor_list_response.rb
 - lib/sendmux_mailbox_generated/models/mailbox_thread_summary_states.rb