moov_ruby 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3701b836cb5c39e6223cb3b786d42d5c6fa7c899ed9bcfa8425435b37f3cfe5a
-  data.tar.gz: 9a7e50a1fa8c1a1ebce67515b3babd5b5f41e7d5459feb979e08ba2fc4c396fb
+  metadata.gz: e1ae20e590d12cbcc790b87bc9ebd887258645ae9398af70ac46f473b2eda448
+  data.tar.gz: 71c641cae7b6e5828dfdb247259dfe3dcc3c1bc56b41edcc1ed201261c719f62
 SHA512:
-  metadata.gz: c63453e1843a1ba20ef9ab446a90e93a50928a38df99d8f5fcda1998f2c846dab90471b1474c3b44efa7e06cfe01eba8b733bb853ff2bbec59ccc238e77eb0a3
-  data.tar.gz: a9fb90de99b11b972b303499541f8a3d626a951af8cb246ebbf251004230e34dfb19980a47b21fcd54c9ba8b0f8237a82d9be478ff00a253e15cb88507d830bd
+  metadata.gz: 91fc67db6ef374dd4bcf2b2043f3b6fb8384c87ce2ce863a2eff9bfee9e2a5d1c02f5b2d5d73e2f73ebdaf9c39fc089b583e3ed5cd9e390b6d825c24da4b18a5
+  data.tar.gz: 4ea7a3c3fe24878fbee884efd25f24579700fcb21dcfbcaa136ecf9d0f50a64d3dfb54f773f97d6bd5e103ac6ae48f8392f92ef819f83e9391e79d1352c2707a

data/lib/moov/fee_plans.rb

@@ -940,5 +940,365 @@ module Moov
 
       end
     end
+
+
+    sig { params(request: Models::Operations::ListResidualsRequest, timeout_ms: T.nilable(Integer)).returns(Models::Operations::ListResidualsResponse) }
+    def list_residuals(request:, timeout_ms: nil)
+      # list_residuals - List all residuals associated with an account.
+      # 
+      # To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 
+      # you'll need to specify the `/accounts/{accountID}/profile.read` scope.
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = Utils.generate_url(
+        Models::Operations::ListResidualsRequest,
+        base_url,
+        '/accounts/{accountID}/residuals',
+        request,
+        @sdk_configuration.globals
+      )
+      headers = Utils.get_headers(request, @sdk_configuration.globals)
+      headers = T.cast(headers, T::Hash[String, String])
+      query_params = Utils.get_query_params(Models::Operations::ListResidualsRequest, request, nil, @sdk_configuration.globals)
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      security = @sdk_configuration.security_source&.call
+
+      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      timeout ||= @sdk_configuration.timeout
+      
+
+      connection = @sdk_configuration.client
+
+      hook_ctx = SDKHooks::HookContext.new(
+        config: @sdk_configuration,
+        base_url: base_url,
+        oauth2_scopes: nil,
+        operation_id: 'listResiduals',
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = T.let(nil, T.nilable(StandardError))
+      http_response = T.let(nil, T.nilable(Faraday::Response))
+      
+      
+      begin
+        http_response = T.must(connection).get(url) do |req|
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          req.params = query_params
+          Utils.configure_request_security(req, security)
+
+          @sdk_configuration.hooks.before_request(
+            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            request: req
+          )
+        end
+      rescue StandardError => e
+        error = e
+      ensure
+        if http_response.nil? || Utils.error_status?(http_response.status)
+          http_response = @sdk_configuration.hooks.after_error(
+            error: error,
+            hook_ctx: SDKHooks::AfterErrorHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        else
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        end
+        
+        if http_response.nil?
+          raise error if !error.nil?
+          raise 'no response'
+        end
+      end
+      
+      content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
+      if Utils.match_status_code(http_response.status, ['200'])
+        if Utils.match_content_type(content_type, 'application/json')
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+          response_data = http_response.env.response_body
+          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Crystalline::Array.new(Models::Components::Residual))
+          response = Models::Operations::ListResidualsResponse.new(
+            status_code: http_response.status,
+            content_type: content_type,
+            raw_response: http_response,
+            headers: http_response.headers,
+            residuals: T.unsafe(obj)
+          )
+
+          return response
+        else
+          raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
+        end
+      elsif Utils.match_status_code(http_response.status, ['401', '403', '429'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['500', '504'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['4XX'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['5XX'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      else
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'
+
+      end
+    end
+
+
+    sig { params(account_id: ::String, residual_id: ::String, x_moov_version: T.nilable(::String), timeout_ms: T.nilable(Integer)).returns(Models::Operations::GetResidualResponse) }
+    def get_residual(account_id:, residual_id:, x_moov_version: nil, timeout_ms: nil)
+      # get_residual - Get a residual associated with an account.
+      # 
+      # To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 
+      # you'll need to specify the `/accounts/{accountID}/profile.read` scope.
+      request = Models::Operations::GetResidualRequest.new(
+        account_id: account_id,
+        residual_id: residual_id,
+        x_moov_version: x_moov_version
+      )
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = Utils.generate_url(
+        Models::Operations::GetResidualRequest,
+        base_url,
+        '/accounts/{accountID}/residuals/{residualID}',
+        request,
+        @sdk_configuration.globals
+      )
+      headers = Utils.get_headers(request, @sdk_configuration.globals)
+      headers = T.cast(headers, T::Hash[String, String])
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      security = @sdk_configuration.security_source&.call
+
+      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      timeout ||= @sdk_configuration.timeout
+      
+
+      connection = @sdk_configuration.client
+
+      hook_ctx = SDKHooks::HookContext.new(
+        config: @sdk_configuration,
+        base_url: base_url,
+        oauth2_scopes: nil,
+        operation_id: 'getResidual',
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = T.let(nil, T.nilable(StandardError))
+      http_response = T.let(nil, T.nilable(Faraday::Response))
+      
+      
+      begin
+        http_response = T.must(connection).get(url) do |req|
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          Utils.configure_request_security(req, security)
+
+          @sdk_configuration.hooks.before_request(
+            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            request: req
+          )
+        end
+      rescue StandardError => e
+        error = e
+      ensure
+        if http_response.nil? || Utils.error_status?(http_response.status)
+          http_response = @sdk_configuration.hooks.after_error(
+            error: error,
+            hook_ctx: SDKHooks::AfterErrorHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        else
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        end
+        
+        if http_response.nil?
+          raise error if !error.nil?
+          raise 'no response'
+        end
+      end
+      
+      content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
+      if Utils.match_status_code(http_response.status, ['200'])
+        if Utils.match_content_type(content_type, 'application/json')
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+          response_data = http_response.env.response_body
+          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Components::Residual)
+          response = Models::Operations::GetResidualResponse.new(
+            status_code: http_response.status,
+            content_type: content_type,
+            raw_response: http_response,
+            headers: http_response.headers,
+            residual: T.unsafe(obj)
+          )
+
+          return response
+        else
+          raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
+        end
+      elsif Utils.match_status_code(http_response.status, ['401', '403', '404', '429'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['500', '504'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['4XX'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['5XX'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      else
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'
+
+      end
+    end
+
+
+    sig { params(request: Models::Operations::ListResidualFeesRequest, timeout_ms: T.nilable(Integer)).returns(Models::Operations::ListResidualFeesResponse) }
+    def list_residual_fees(request:, timeout_ms: nil)
+      # list_residual_fees - List all fees associated with a residual.
+      # 
+      # To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 
+      # you'll need to specify the `/accounts/{accountID}/profile.read` scope.
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = Utils.generate_url(
+        Models::Operations::ListResidualFeesRequest,
+        base_url,
+        '/accounts/{accountID}/residuals/{residualID}/fees',
+        request,
+        @sdk_configuration.globals
+      )
+      headers = Utils.get_headers(request, @sdk_configuration.globals)
+      headers = T.cast(headers, T::Hash[String, String])
+      query_params = Utils.get_query_params(Models::Operations::ListResidualFeesRequest, request, nil, @sdk_configuration.globals)
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      security = @sdk_configuration.security_source&.call
+
+      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      timeout ||= @sdk_configuration.timeout
+      
+
+      connection = @sdk_configuration.client
+
+      hook_ctx = SDKHooks::HookContext.new(
+        config: @sdk_configuration,
+        base_url: base_url,
+        oauth2_scopes: nil,
+        operation_id: 'listResidualFees',
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = T.let(nil, T.nilable(StandardError))
+      http_response = T.let(nil, T.nilable(Faraday::Response))
+      
+      
+      begin
+        http_response = T.must(connection).get(url) do |req|
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          req.params = query_params
+          Utils.configure_request_security(req, security)
+
+          @sdk_configuration.hooks.before_request(
+            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            request: req
+          )
+        end
+      rescue StandardError => e
+        error = e
+      ensure
+        if http_response.nil? || Utils.error_status?(http_response.status)
+          http_response = @sdk_configuration.hooks.after_error(
+            error: error,
+            hook_ctx: SDKHooks::AfterErrorHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        else
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        end
+        
+        if http_response.nil?
+          raise error if !error.nil?
+          raise 'no response'
+        end
+      end
+      
+      content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
+      if Utils.match_status_code(http_response.status, ['200'])
+        if Utils.match_content_type(content_type, 'application/json')
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+          response_data = http_response.env.response_body
+          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Crystalline::Array.new(Models::Components::IncurredFee))
+          response = Models::Operations::ListResidualFeesResponse.new(
+            status_code: http_response.status,
+            content_type: content_type,
+            raw_response: http_response,
+            headers: http_response.headers,
+            incurred_fees: T.unsafe(obj)
+          )
+
+          return response
+        else
+          raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
+        end
+      elsif Utils.match_status_code(http_response.status, ['401', '403', '429'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['500', '504'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['4XX'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      elsif Utils.match_status_code(http_response.status, ['5XX'])
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
+      else
+        raise ::Moov::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'
+
+      end
+    end
   end
 end

data/lib/moov/models/components/residual.rb

@@ -0,0 +1,79 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Moov
+  module Models
+    module Components
+    
+
+      class Residual
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+
+        field :residual_id, ::String, { 'format_json': { 'letter_case': ::Moov::Utils.field_name('residualID'), required: true } }
+
+        field :partner_account_id, ::String, { 'format_json': { 'letter_case': ::Moov::Utils.field_name('partnerAccountID'), required: true } }
+
+        field :period_start, ::DateTime, { 'format_json': { 'letter_case': ::Moov::Utils.field_name('periodStart'), required: true, 'decoder': Utils.datetime_from_iso_format(false) } }
+
+        field :period_end, ::DateTime, { 'format_json': { 'letter_case': ::Moov::Utils.field_name('periodEnd'), required: true, 'decoder': Utils.datetime_from_iso_format(false) } }
+
+        field :merchant_fees, Models::Components::AmountDecimal, { 'format_json': { 'letter_case': ::Moov::Utils.field_name('merchantFees'), required: true } }
+
+        field :partner_cost, Models::Components::AmountDecimal, { 'format_json': { 'letter_case': ::Moov::Utils.field_name('partnerCost'), required: true } }
+
+        field :net_income, Models::Components::AmountDecimal, { 'format_json': { 'letter_case': ::Moov::Utils.field_name('netIncome'), required: true } }
+        #   The decimal-formatted numerical string of the revenue split for partner.
+        #   
+        #   For example, 2.25% is '2.25'.
+        field :revenue_share, ::String, { 'format_json': { 'letter_case': ::Moov::Utils.field_name('revenueShare'), required: true } }
+
+        field :residual_amount, Models::Components::AmountDecimal, { 'format_json': { 'letter_case': ::Moov::Utils.field_name('residualAmount'), required: true } }
+
+        field :moov_share, Models::Components::AmountDecimal, { 'format_json': { 'letter_case': ::Moov::Utils.field_name('moovShare'), required: true } }
+
+        field :created_on, ::DateTime, { 'format_json': { 'letter_case': ::Moov::Utils.field_name('createdOn'), required: true, 'decoder': Utils.datetime_from_iso_format(false) } }
+
+        field :updated_on, ::DateTime, { 'format_json': { 'letter_case': ::Moov::Utils.field_name('updatedOn'), required: true, 'decoder': Utils.datetime_from_iso_format(false) } }
+
+        sig { params(residual_id: ::String, partner_account_id: ::String, period_start: ::DateTime, period_end: ::DateTime, merchant_fees: Models::Components::AmountDecimal, partner_cost: Models::Components::AmountDecimal, net_income: Models::Components::AmountDecimal, revenue_share: ::String, residual_amount: Models::Components::AmountDecimal, moov_share: Models::Components::AmountDecimal, created_on: ::DateTime, updated_on: ::DateTime).void }
+        def initialize(residual_id:, partner_account_id:, period_start:, period_end:, merchant_fees:, partner_cost:, net_income:, revenue_share:, residual_amount:, moov_share:, created_on:, updated_on:)
+          @residual_id = residual_id
+          @partner_account_id = partner_account_id
+          @period_start = period_start
+          @period_end = period_end
+          @merchant_fees = merchant_fees
+          @partner_cost = partner_cost
+          @net_income = net_income
+          @revenue_share = revenue_share
+          @residual_amount = residual_amount
+          @moov_share = moov_share
+          @created_on = created_on
+          @updated_on = updated_on
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @residual_id == other.residual_id
+          return false unless @partner_account_id == other.partner_account_id
+          return false unless @period_start == other.period_start
+          return false unless @period_end == other.period_end
+          return false unless @merchant_fees == other.merchant_fees
+          return false unless @partner_cost == other.partner_cost
+          return false unless @net_income == other.net_income
+          return false unless @revenue_share == other.revenue_share
+          return false unless @residual_amount == other.residual_amount
+          return false unless @moov_share == other.moov_share
+          return false unless @created_on == other.created_on
+          return false unless @updated_on == other.updated_on
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moov/models/components/residual.rbi

@@ -0,0 +1,35 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Moov::Models::Components::Residual
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Moov::Models::Components::Residual
+  def residual_id(); end
+  def residual_id=(str_); end
+  def partner_account_id(); end
+  def partner_account_id=(str_); end
+  def period_start(); end
+  def period_start=(str_); end
+  def period_end(); end
+  def period_end=(str_); end
+  def merchant_fees(); end
+  def merchant_fees=(str_); end
+  def partner_cost(); end
+  def partner_cost=(str_); end
+  def net_income(); end
+  def net_income=(str_); end
+  def revenue_share(); end
+  def revenue_share=(str_); end
+  def residual_amount(); end
+  def residual_amount=(str_); end
+  def moov_share(); end
+  def moov_share=(str_); end
+  def created_on(); end
+  def created_on=(str_); end
+  def updated_on(); end
+  def updated_on=(str_); end
+end

data/lib/moov/models/components.rb

@@ -388,6 +388,7 @@ module Moov
       autoload :RequirementError, 'moov/models/components/requirementerror.rb'
       autoload :RequirementErrorCode, 'moov/models/components/requirementerrorcode.rb'
       autoload :RequirementID, 'moov/models/components/requirementid.rb'
+      autoload :Residual, 'moov/models/components/residual.rb'
       autoload :ReturnPolicyType, 'moov/models/components/returnpolicytype.rb'
       autoload :Reversal, 'moov/models/components/reversal.rb'
       autoload :ReversedWithCancellation, 'moov/models/components/reversedwithcancellation.rb'

data/lib/moov/models/operations/getresidual_request.rb

@@ -0,0 +1,49 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Moov
+  module Models
+    module Operations
+    
+
+      class GetResidualRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+
+        field :account_id, ::String, { 'path_param': { 'field_name': 'accountID', 'style': 'simple', 'explode': false } }
+
+        field :residual_id, ::String, { 'path_param': { 'field_name': 'residualID', 'style': 'simple', 'explode': false } }
+        # Specify an API version.
+        # 
+        # API versioning follows the format `vYYYY.QQ.BB`, where 
+        #   - `YYYY` is the year
+        #   - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
+        #   - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. 
+        #     - For example, `v2024.01.00` is the initial release of the first quarter of 2024.
+        # 
+        # The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
+        field :x_moov_version, Crystalline::Nilable.new(::String), { 'header': { 'field_name': 'X-Moov-Version', 'style': 'simple', 'explode': false } }
+
+        sig { params(account_id: ::String, residual_id: ::String, x_moov_version: T.nilable(::String)).void }
+        def initialize(account_id:, residual_id:, x_moov_version: 'v2024.01.00')
+          @account_id = account_id
+          @residual_id = residual_id
+          @x_moov_version = x_moov_version
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @account_id == other.account_id
+          return false unless @residual_id == other.residual_id
+          return false unless @x_moov_version == other.x_moov_version
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moov/models/operations/getresidual_request.rbi

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Moov::Models::Operations::GetResidualRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Moov::Models::Operations::GetResidualRequest
+  def account_id(); end
+  def account_id=(str_); end
+  def residual_id(); end
+  def residual_id=(str_); end
+  def x_moov_version(); end
+  def x_moov_version=(str_); end
+end

data/lib/moov/models/operations/getresidual_response.rb

@@ -0,0 +1,49 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Moov
+  module Models
+    module Operations
+    
+
+      class GetResidualResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # HTTP response content type for this operation
+        field :content_type, ::String
+        # HTTP response status code for this operation
+        field :status_code, ::Integer
+        # Raw HTTP response; suitable for custom response parsing
+        field :raw_response, ::Faraday::Response
+
+        field :headers, Crystalline::Hash.new(Symbol, Crystalline::Array.new(::String))
+        # The request completed successfully.
+        field :residual, Crystalline::Nilable.new(Models::Components::Residual)
+
+        sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, headers: T::Hash[Symbol, T::Array[::String]], residual: T.nilable(Models::Components::Residual)).void }
+        def initialize(content_type:, status_code:, raw_response:, headers:, residual: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @headers = headers
+          @residual = residual
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @content_type == other.content_type
+          return false unless @status_code == other.status_code
+          return false unless @raw_response == other.raw_response
+          return false unless @headers == other.headers
+          return false unless @residual == other.residual
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moov/models/operations/getresidual_response.rbi

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Moov::Models::Operations::GetResidualResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Moov::Models::Operations::GetResidualResponse
+  def content_type(); end
+  def content_type=(str_); end
+  def status_code(); end
+  def status_code=(str_); end
+  def raw_response(); end
+  def raw_response=(str_); end
+  def headers(); end
+  def headers=(str_); end
+  def residual(); end
+  def residual=(str_); end
+end

data/lib/moov/models/operations/listresidualfees_request.rb

@@ -0,0 +1,65 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Moov
+  module Models
+    module Operations
+    
+
+      class ListResidualFeesRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+
+        field :account_id, ::String, { 'path_param': { 'field_name': 'accountID', 'style': 'simple', 'explode': false } }
+
+        field :residual_id, ::String, { 'path_param': { 'field_name': 'residualID', 'style': 'simple', 'explode': false } }
+
+        field :skip, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'skip', 'style': 'form', 'explode': false } }
+
+        field :count, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'count', 'style': 'form', 'explode': false } }
+        # Optional date-time to inclusively filter all fees created after this date-time.
+        field :start_date_time, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'startDateTime', 'style': 'form', 'explode': false } }
+        # Optional date-time to exclusively filter all fees created before this date-time.
+        field :end_date_time, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'endDateTime', 'style': 'form', 'explode': false } }
+        # Specify an API version.
+        # 
+        # API versioning follows the format `vYYYY.QQ.BB`, where 
+        #   - `YYYY` is the year
+        #   - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
+        #   - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. 
+        #     - For example, `v2024.01.00` is the initial release of the first quarter of 2024.
+        # 
+        # The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
+        field :x_moov_version, Crystalline::Nilable.new(::String), { 'header': { 'field_name': 'X-Moov-Version', 'style': 'simple', 'explode': false } }
+
+        sig { params(account_id: ::String, residual_id: ::String, skip: T.nilable(::Integer), count: T.nilable(::Integer), start_date_time: T.nilable(::String), end_date_time: T.nilable(::String), x_moov_version: T.nilable(::String)).void }
+        def initialize(account_id:, residual_id:, skip: nil, count: nil, start_date_time: nil, end_date_time: nil, x_moov_version: 'v2024.01.00')
+          @account_id = account_id
+          @residual_id = residual_id
+          @skip = skip
+          @count = count
+          @start_date_time = start_date_time
+          @end_date_time = end_date_time
+          @x_moov_version = x_moov_version
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @account_id == other.account_id
+          return false unless @residual_id == other.residual_id
+          return false unless @skip == other.skip
+          return false unless @count == other.count
+          return false unless @start_date_time == other.start_date_time
+          return false unless @end_date_time == other.end_date_time
+          return false unless @x_moov_version == other.x_moov_version
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moov/models/operations/listresidualfees_request.rbi

@@ -0,0 +1,25 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Moov::Models::Operations::ListResidualFeesRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Moov::Models::Operations::ListResidualFeesRequest
+  def account_id(); end
+  def account_id=(str_); end
+  def residual_id(); end
+  def residual_id=(str_); end
+  def skip(); end
+  def skip=(str_); end
+  def count(); end
+  def count=(str_); end
+  def start_date_time(); end
+  def start_date_time=(str_); end
+  def end_date_time(); end
+  def end_date_time=(str_); end
+  def x_moov_version(); end
+  def x_moov_version=(str_); end
+end

data/lib/moov/models/operations/listresidualfees_response.rb

@@ -0,0 +1,49 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Moov
+  module Models
+    module Operations
+    
+
+      class ListResidualFeesResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # HTTP response content type for this operation
+        field :content_type, ::String
+        # HTTP response status code for this operation
+        field :status_code, ::Integer
+        # Raw HTTP response; suitable for custom response parsing
+        field :raw_response, ::Faraday::Response
+
+        field :headers, Crystalline::Hash.new(Symbol, Crystalline::Array.new(::String))
+        # The request completed successfully.
+        field :incurred_fees, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::IncurredFee))
+
+        sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, headers: T::Hash[Symbol, T::Array[::String]], incurred_fees: T.nilable(T::Array[Models::Components::IncurredFee])).void }
+        def initialize(content_type:, status_code:, raw_response:, headers:, incurred_fees: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @headers = headers
+          @incurred_fees = incurred_fees
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @content_type == other.content_type
+          return false unless @status_code == other.status_code
+          return false unless @raw_response == other.raw_response
+          return false unless @headers == other.headers
+          return false unless @incurred_fees == other.incurred_fees
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moov/models/operations/listresidualfees_response.rbi

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Moov::Models::Operations::ListResidualFeesResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Moov::Models::Operations::ListResidualFeesResponse
+  def content_type(); end
+  def content_type=(str_); end
+  def status_code(); end
+  def status_code=(str_); end
+  def raw_response(); end
+  def raw_response=(str_); end
+  def headers(); end
+  def headers=(str_); end
+  def incurred_fees(); end
+  def incurred_fees=(str_); end
+end

data/lib/moov/models/operations/listresiduals_request.rb

@@ -0,0 +1,61 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Moov
+  module Models
+    module Operations
+    
+
+      class ListResidualsRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+
+        field :account_id, ::String, { 'path_param': { 'field_name': 'accountID', 'style': 'simple', 'explode': false } }
+
+        field :skip, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'skip', 'style': 'form', 'explode': false } }
+
+        field :count, Crystalline::Nilable.new(::Integer), { 'query_param': { 'field_name': 'count', 'style': 'form', 'explode': false } }
+        # Optional date-time to inclusively filter all residuals with a period start after this date-time.
+        field :start_date_time, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'startDateTime', 'style': 'form', 'explode': false } }
+        # Optional date-time to exclusively filter all residuals with a period end before this date-time.
+        field :end_date_time, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'endDateTime', 'style': 'form', 'explode': false } }
+        # Specify an API version.
+        # 
+        # API versioning follows the format `vYYYY.QQ.BB`, where 
+        #   - `YYYY` is the year
+        #   - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
+        #   - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. 
+        #     - For example, `v2024.01.00` is the initial release of the first quarter of 2024.
+        # 
+        # The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
+        field :x_moov_version, Crystalline::Nilable.new(::String), { 'header': { 'field_name': 'X-Moov-Version', 'style': 'simple', 'explode': false } }
+
+        sig { params(account_id: ::String, skip: T.nilable(::Integer), count: T.nilable(::Integer), start_date_time: T.nilable(::String), end_date_time: T.nilable(::String), x_moov_version: T.nilable(::String)).void }
+        def initialize(account_id:, skip: nil, count: nil, start_date_time: nil, end_date_time: nil, x_moov_version: 'v2024.01.00')
+          @account_id = account_id
+          @skip = skip
+          @count = count
+          @start_date_time = start_date_time
+          @end_date_time = end_date_time
+          @x_moov_version = x_moov_version
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @account_id == other.account_id
+          return false unless @skip == other.skip
+          return false unless @count == other.count
+          return false unless @start_date_time == other.start_date_time
+          return false unless @end_date_time == other.end_date_time
+          return false unless @x_moov_version == other.x_moov_version
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moov/models/operations/listresiduals_request.rbi

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Moov::Models::Operations::ListResidualsRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Moov::Models::Operations::ListResidualsRequest
+  def account_id(); end
+  def account_id=(str_); end
+  def skip(); end
+  def skip=(str_); end
+  def count(); end
+  def count=(str_); end
+  def start_date_time(); end
+  def start_date_time=(str_); end
+  def end_date_time(); end
+  def end_date_time=(str_); end
+  def x_moov_version(); end
+  def x_moov_version=(str_); end
+end

data/lib/moov/models/operations/listresiduals_response.rb

@@ -0,0 +1,49 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module Moov
+  module Models
+    module Operations
+    
+
+      class ListResidualsResponse
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # HTTP response content type for this operation
+        field :content_type, ::String
+        # HTTP response status code for this operation
+        field :status_code, ::Integer
+        # Raw HTTP response; suitable for custom response parsing
+        field :raw_response, ::Faraday::Response
+
+        field :headers, Crystalline::Hash.new(Symbol, Crystalline::Array.new(::String))
+        # The request completed successfully.
+        field :residuals, Crystalline::Nilable.new(Crystalline::Array.new(Models::Components::Residual))
+
+        sig { params(content_type: ::String, status_code: ::Integer, raw_response: ::Faraday::Response, headers: T::Hash[Symbol, T::Array[::String]], residuals: T.nilable(T::Array[Models::Components::Residual])).void }
+        def initialize(content_type:, status_code:, raw_response:, headers:, residuals: nil)
+          @content_type = content_type
+          @status_code = status_code
+          @raw_response = raw_response
+          @headers = headers
+          @residuals = residuals
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @content_type == other.content_type
+          return false unless @status_code == other.status_code
+          return false unless @raw_response == other.raw_response
+          return false unless @headers == other.headers
+          return false unless @residuals == other.residuals
+          true
+        end
+      end
+    end
+  end
+end

data/lib/moov/models/operations/listresiduals_response.rbi

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class Moov::Models::Operations::ListResidualsResponse
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class Moov::Models::Operations::ListResidualsResponse
+  def content_type(); end
+  def content_type=(str_); end
+  def status_code(); end
+  def status_code=(str_); end
+  def raw_response(); end
+  def raw_response=(str_); end
+  def headers(); end
+  def headers=(str_); end
+  def residuals(); end
+  def residuals=(str_); end
+end

data/lib/moov/models/operations.rb

@@ -142,6 +142,8 @@ module Moov
       autoload :GetRefundResponse, 'moov/models/operations/getrefund_response.rb'
       autoload :GetRepresentativeRequest, 'moov/models/operations/getrepresentative_request.rb'
       autoload :GetRepresentativeResponse, 'moov/models/operations/getrepresentative_response.rb'
+      autoload :GetResidualRequest, 'moov/models/operations/getresidual_request.rb'
+      autoload :GetResidualResponse, 'moov/models/operations/getresidual_response.rb'
       autoload :GetScheduledOccurrenceRequest, 'moov/models/operations/getscheduledoccurrence_request.rb'
       autoload :GetScheduledOccurrenceResponse, 'moov/models/operations/getscheduledoccurrence_response.rb'
       autoload :GetSchedulesRequest, 'moov/models/operations/getschedules_request.rb'
@@ -239,6 +241,10 @@ module Moov
       autoload :ListRefundsResponse, 'moov/models/operations/listrefunds_response.rb'
       autoload :ListRepresentativesRequest, 'moov/models/operations/listrepresentatives_request.rb'
       autoload :ListRepresentativesResponse, 'moov/models/operations/listrepresentatives_response.rb'
+      autoload :ListResidualFeesRequest, 'moov/models/operations/listresidualfees_request.rb'
+      autoload :ListResidualFeesResponse, 'moov/models/operations/listresidualfees_response.rb'
+      autoload :ListResidualsRequest, 'moov/models/operations/listresiduals_request.rb'
+      autoload :ListResidualsResponse, 'moov/models/operations/listresiduals_response.rb'
       autoload :ListSchedulesRequest, 'moov/models/operations/listschedules_request.rb'
       autoload :ListSchedulesResponse, 'moov/models/operations/listschedules_response.rb'
       autoload :ListStatementsRequest, 'moov/models/operations/liststatements_request.rb'

data/lib/moov/sdkconfiguration.rb

@@ -95,9 +95,9 @@ module Moov
       @globals = globals.nil? ? {} : globals
       @language = 'ruby'
       @openapi_doc_version = 'latest'
-      @sdk_version = '0.2.6'
-      @gen_version = '2.731.6'
-      @user_agent = 'speakeasy-sdk/ruby 0.2.6 2.731.6 latest moov_ruby'
+      @sdk_version = '0.3.0'
+      @gen_version = '2.735.1'
+      @user_agent = 'speakeasy-sdk/ruby 0.3.0 2.735.1 latest moov_ruby'
     end
 
     sig { returns([String, T::Hash[Symbol, String]]) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moov_ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Speakeasy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-10-30 00:00:00.000000000 Z
+date: 2025-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -1003,6 +1003,8 @@ files:
 - lib/moov/models/components/requirementerrorcode.rbi
 - lib/moov/models/components/requirementid.rb
 - lib/moov/models/components/requirementid.rbi
+- lib/moov/models/components/residual.rb
+- lib/moov/models/components/residual.rbi
 - lib/moov/models/components/responsibilities.rb
 - lib/moov/models/components/responsibilities.rbi
 - lib/moov/models/components/returnpolicytype.rb
@@ -1685,6 +1687,10 @@ files:
 - lib/moov/models/operations/getrepresentative_request.rbi
 - lib/moov/models/operations/getrepresentative_response.rb
 - lib/moov/models/operations/getrepresentative_response.rbi
+- lib/moov/models/operations/getresidual_request.rb
+- lib/moov/models/operations/getresidual_request.rbi
+- lib/moov/models/operations/getresidual_response.rb
+- lib/moov/models/operations/getresidual_response.rbi
 - lib/moov/models/operations/getscheduledoccurrence_request.rb
 - lib/moov/models/operations/getscheduledoccurrence_request.rbi
 - lib/moov/models/operations/getscheduledoccurrence_response.rb
@@ -1879,6 +1885,14 @@ files:
 - lib/moov/models/operations/listrepresentatives_request.rbi
 - lib/moov/models/operations/listrepresentatives_response.rb
 - lib/moov/models/operations/listrepresentatives_response.rbi
+- lib/moov/models/operations/listresidualfees_request.rb
+- lib/moov/models/operations/listresidualfees_request.rbi
+- lib/moov/models/operations/listresidualfees_response.rb
+- lib/moov/models/operations/listresidualfees_response.rbi
+- lib/moov/models/operations/listresiduals_request.rb
+- lib/moov/models/operations/listresiduals_request.rbi
+- lib/moov/models/operations/listresiduals_response.rb
+- lib/moov/models/operations/listresiduals_response.rbi
 - lib/moov/models/operations/listschedules_request.rb
 - lib/moov/models/operations/listschedules_request.rbi
 - lib/moov/models/operations/listschedules_response.rb