deepl-rb 3.3.0 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce04c17b4585b9813713f61db8fe35e3a61b777c48ec22011f81b7febe106527
-  data.tar.gz: 3c4432516a14b2fb0e8886f2ff3e6d31c5ba5c88590d4e28a9631fc0a233f724
+  metadata.gz: 4c41f4e48cdf057f165925df1ba47e6fa2748d49816a16e137e4ed8acaed7000
+  data.tar.gz: b169350c8f173e15bc502d7eaa26c6b9b4b255961224a6508ac41eaa0d7466c3
 SHA512:
-  metadata.gz: 8a736f2b2cc257c26cd47e67bdbdcbc89afbb6de444176f0dab5b0a470fe2c713e3c32396391a05c007ddfbfbbc80953b0f6c6afb1fdf9b138c0eca97ae02a52
-  data.tar.gz: 1828bdede7c38bec246302645e39ec7f01950096f3c52fb1b119766bbdf11b6c2b6d3ab881ebdf2875f736ab8f47778e87abcb5f107ca2ef6f4848c66d11d680
+  metadata.gz: 0d260ad680a40b28865127fd0eaccd469c7dc5fed1203424c3737077b6d5b6a7dc6116b3d458633f8c3d4835159b5deb1e49bafa43409a1255abd3f11ccbbba6
+  data.tar.gz: 1d684b486e4286f02d6bbc194bcf983ee7e5555d263d52cc5b41d68abba2fbafe79bae96f014b1db841b9fb893b173dc66f12365b7734bbd3bfb9a891ff97b41

data/CHANGELOG.md

@@ -4,7 +4,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [3.4.1] - 2025-12-19
+### Fixed
+- Fixed broken 3.4.0 release
+
+## [3.4.0] - 2025-11-17
+### Added
+- Added support for the `GET /v3/style_rules` endpoint in the client library, the
+  implementation can be found in the `StyleRuleApi` class. Please refer to the
+  README for usage instructions
+- Added `style_id` option to `translate()` which allows text translation with
+  style rules.
+
+### Fixed
+- Send correct library version in user-agent. Expose library version in the module as a variable.
 
 ## [3.3.0] - 2025-11-04
 ### Added
@@ -62,7 +75,8 @@ The change in major version is only due to the change in maintainership, there i
 ### Fixed
 - Make RequestEntityTooLarge error message more clear
 
-[Unreleased]: https://github.com/DeepLcom/deepl-rb/compare/v3.3.0...HEAD
+[3.4.1]: https://github.com/DeepLcom/deepl-rb/compare/v3.4.0...v3.4.1
+[3.4.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.3.0...v3.4.0
 [3.3.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.2.0...v3.3.0
 [3.2.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.1.0...v3.2.0
 [3.1.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.0.2...v3.1.0

data/README.md

@@ -166,6 +166,8 @@ The following parameters will be automatically converted:
 | `ignore_tags`         | Converts arrays to strings joining by commas
 | `formality`           | No conversion applied
 | `glossary_id`         | No conversion applied
+| `style_id`            | No conversion applied
+| `style_rule`          | No conversion applied (can be a string ID or a StyleRule object)
 | `context`             | No conversion applied
 | `extra_body_parameters` | Hash of extra parameters to pass in the body of the HTTP request. Can be used to access beta features, or to override built-in parameters for testing purposes. Extra parameters can override keys explicitly set by the client.
 
@@ -294,6 +296,62 @@ puts language_pairs.first.target_lang
 # => de
 ```
 
+### Style Rules
+
+Style rules allow you to customize your translations using a managed, shared list
+of rules for style, formatting, and more. Multiple style rules can be stored with
+your account, each with a user-specified name and a uniquely-assigned ID.
+
+#### Creating and managing style rules
+
+Currently style rules must be created and managed in the DeepL UI via
+https://www.deepl.com/en/custom-rules. Full CRUD functionality via the APIs will
+come shortly.
+
+#### Listing all style rules
+
+`style_rules.list` returns a list of `StyleRule` objects
+corresponding to all of your stored style rules. The method accepts optional
+parameters: `page` (page number for pagination, 0-indexed), `page_size` (number
+of items per page), and `detailed` (whether to include detailed configuration
+rules in the `configured_rules` property).
+
+```rb
+# Get all style rules
+style_rules = DeepL.style_rules.list
+style_rules.each do |rule|
+  puts "#{rule.name} (#{rule.style_id})"
+end
+
+# Get style rules with detailed configuration
+style_rules = DeepL.style_rules.list(detailed: true)
+style_rules.each do |rule|
+  if rule.configured_rules
+    puts "  Number formatting: #{rule.configured_rules.numbers.keys.join(', ')}"
+  end
+end
+```
+
+Created style rules can be used in the `translate` method by specifying the `style_id` option:
+
+```rb
+translation = DeepL.translate 'Hello World', 'EN', 'ES', style_id: 'dca2e053-8ae5-45e6-a0d2-881156e7f4e4'
+
+puts translation.class
+# => DeepL::Resources::Text
+puts translation.text
+# => 'Hola Mundo'
+```
+
+You can also pass a `StyleRule` object directly:
+
+```rb
+style_rules = DeepL.style_rules.list
+style_rule = style_rules.first
+
+translation = DeepL.translate 'Hello World', 'EN', 'ES', style_rule: style_rule
+```
+
 ### Monitor usage
 
 To check current API usage, use:

data/Rakefile

@@ -13,6 +13,7 @@ end
 
 require 'rake'
 require 'juwelier'
+require_relative 'lib/version'
 
 Juwelier::Tasks.new do |gem|
   gem.name = 'deepl-rb'
@@ -22,6 +23,7 @@ Juwelier::Tasks.new do |gem|
   gem.description =
     'Official Ruby library for the DeepL language translation API (v2). ' \
     'For more information, check this: https://www.deepl.com/docs/api-reference.html'
+  gem.version = DeepL::VERSION
 
   gem.email = 'open-source@deepl.com'
   gem.authors = ['DeepL SE']

data/VERSION

@@ -1 +1 @@
-3.3.0
+3.4.1

data/deepl-rb.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: deepl-rb 3.3.0 ruby lib
+# stub: deepl-rb 3.4.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "deepl-rb".freeze
-  s.version = "3.3.0"
+  s.version = "3.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.metadata = { "bug_tracker_uri" => "https://github.com/DeepLcom/deepl-rb/issues", "changelog_uri" => "https://github.com/DeepLcom/deepl-rb/blob/main/CHANGELOG.md", "documentation_uri" => "https://github.com/DeepLcom/deepl-rb/blob/main/README.md", "homepage_uri" => "https://github.com/DeepLcom/deepl-rb" } if s.respond_to? :metadata=
   s.require_paths = ["lib".freeze]
   s.authors = ["DeepL SE".freeze]
-  s.date = "2025-11-04"
+  s.date = "2025-12-19"
   s.description = "Official Ruby library for the DeepL language translation API (v2). For more information, check this: https://www.deepl.com/docs/api-reference.html".freeze
   s.email = "open-source@deepl.com".freeze
   s.extra_rdoc_files = [
@@ -71,6 +71,7 @@ Gem::Specification.new do |s|
     "lib/deepl/requests/glossary/list.rb",
     "lib/deepl/requests/languages.rb",
     "lib/deepl/requests/rephrase.rb",
+    "lib/deepl/requests/style_rule/list.rb",
     "lib/deepl/requests/translate.rb",
     "lib/deepl/requests/usage.rb",
     "lib/deepl/resources/base.rb",
@@ -79,11 +80,14 @@ Gem::Specification.new do |s|
     "lib/deepl/resources/glossary.rb",
     "lib/deepl/resources/language.rb",
     "lib/deepl/resources/language_pair.rb",
+    "lib/deepl/resources/style_rule.rb",
     "lib/deepl/resources/text.rb",
     "lib/deepl/resources/usage.rb",
+    "lib/deepl/style_rule_api.rb",
     "lib/deepl/utils/backoff_timer.rb",
     "lib/deepl/utils/exception_builder.rb",
     "lib/http_client_options.rb",
+    "lib/version.rb",
     "license_checker.sh",
     "spec/api/api_spec.rb",
     "spec/api/configuration_spec.rb",
@@ -99,10 +103,12 @@ Gem::Specification.new do |s|
     "spec/fixtures/vcr_cassettes/glossaries.yml",
     "spec/fixtures/vcr_cassettes/languages.yml",
     "spec/fixtures/vcr_cassettes/rephrase_texts.yml",
+    "spec/fixtures/vcr_cassettes/style_rules.yml",
     "spec/fixtures/vcr_cassettes/translate_texts.yml",
     "spec/fixtures/vcr_cassettes/usage.yml",
     "spec/integration_tests/document_api_spec.rb",
     "spec/integration_tests/integration_test_utils.rb",
+    "spec/integration_tests/style_rule_api_spec.rb",
     "spec/requests/glossary/create_spec.rb",
     "spec/requests/glossary/destroy_spec.rb",
     "spec/requests/glossary/entries_spec.rb",

data/lib/deepl/configuration.rb

@@ -46,7 +46,7 @@ module DeepL
     end
 
     def construct_user_agent(send_platform_info, app_info_name, app_info_version)
-      library_info_str = 'deepl-ruby/3.0.2'
+      library_info_str = "deepl-ruby/#{DeepL::VERSION}"
       if send_platform_info
         library_info_str += " (#{RbConfig::CONFIG['host_os']}) ruby/#{RUBY_VERSION}"
       end

data/lib/deepl/requests/style_rule/list.rb

@@ -0,0 +1,59 @@
+# Copyright 2025 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+module DeepL
+  module Requests
+    module StyleRule
+      class List < Base
+        def initialize(api, options = {})
+          super
+        end
+
+        def request
+          build_style_rule_list(*execute_request_with_retries(get_request))
+        end
+
+        def to_s
+          "GET #{uri.request_uri}"
+        end
+
+        private
+
+        def get_request # rubocop:disable Naming/AccessorMethodName
+          http_headers = add_json_content_type(headers)
+          Net::HTTP::Get.new(uri.request_uri, http_headers)
+        end
+
+        def build_style_rule_list(request, response)
+          data = JSON.parse(response.body)
+          data['style_rules'].map do |style_rule|
+            Resources::StyleRule.new(style_rule, request, response)
+          end
+        end
+
+        def uri
+          @uri ||= begin
+            base_uri = URI("#{host}/v3/#{path}")
+            query_string = build_query_string
+            base_uri.query = query_string unless query_string.empty?
+            base_uri
+          end
+        end
+
+        def build_query_string
+          params = {}
+          params['page'] = option(:page).to_s if option?(:page)
+          params['page_size'] = option(:page_size).to_s if option?(:page_size)
+          params['detailed'] = option(:detailed).to_s.downcase if option?(:detailed)
+          URI.encode_www_form(params)
+        end
+
+        def path
+          'style_rules'
+        end
+      end
+    end
+  end
+end

data/lib/deepl/requests/translate.rb

@@ -38,9 +38,19 @@ module DeepL
         tweak_parameters!
       end
 
-      def request
+      def request # rubocop:disable Metrics/MethodLength
         text_arrayified = text.is_a?(Array) ? text : [text]
         payload = { text: text_arrayified, source_lang: source_lang, target_lang: target_lang }
+
+        if option?(:style_rule)
+          style_rule = option(:style_rule)
+          payload[:style_id] = if style_rule.is_a?(DeepL::Resources::StyleRule)
+                                 style_rule.style_id
+                               else
+                                 style_rule.to_s
+                               end
+        end
+
         build_texts(*execute_request_with_retries(post_request(payload)))
       end
 

data/lib/deepl/resources/style_rule.rb

@@ -0,0 +1,85 @@
+# Copyright 2025 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+require 'time'
+
+module DeepL
+  module Resources
+    class ConfiguredRules
+      attr_reader :dates_and_times, :formatting, :numbers, :punctuation,
+                  :spelling_and_grammar, :style_and_tone, :vocabulary
+
+      def initialize(configured_rules_data)
+        @dates_and_times = extract_rule(configured_rules_data, 'dates_and_times')
+        @formatting = extract_rule(configured_rules_data, 'formatting')
+        @numbers = extract_rule(configured_rules_data, 'numbers')
+        @punctuation = extract_rule(configured_rules_data, 'punctuation')
+        @spelling_and_grammar = extract_rule(configured_rules_data, 'spelling_and_grammar')
+        @style_and_tone = extract_rule(configured_rules_data, 'style_and_tone')
+        @vocabulary = extract_rule(configured_rules_data, 'vocabulary')
+      end
+
+      private
+
+      def extract_rule(data, key)
+        data[key] || {}
+      end
+    end
+
+    class CustomInstruction
+      attr_reader :label, :prompt, :source_language
+
+      def initialize(custom_instruction_data)
+        @label = custom_instruction_data['label']
+        @prompt = custom_instruction_data['prompt']
+        @source_language = custom_instruction_data['source_language']
+      end
+    end
+
+    class StyleRule < Base
+      attr_reader :style_id, :name, :creation_time, :updated_time, :language, :version,
+                  :configured_rules, :custom_instructions
+
+      def initialize(style_rule, *args)
+        super(*args)
+        extract_basic_fields(style_rule)
+        extract_configured_rules(style_rule)
+        extract_custom_instructions(style_rule)
+      end
+
+      private
+
+      def extract_basic_fields(style_rule)
+        @style_id = style_rule['style_id']
+        @name = style_rule['name']
+        @creation_time = parse_time(style_rule['creation_time'])
+        @updated_time = parse_time(style_rule['updated_time'])
+        @language = style_rule['language']
+        @version = style_rule['version']
+      end
+
+      def extract_configured_rules(style_rule)
+        configured_rules_data = style_rule['configured_rules']
+        @configured_rules = configured_rules_data ? ConfiguredRules.new(configured_rules_data) : nil
+      end
+
+      def extract_custom_instructions(style_rule)
+        @custom_instructions = style_rule['custom_instructions']&.map do |ci|
+          CustomInstruction.new(ci)
+        end
+      end
+
+      def to_s
+        "#{style_id} - #{name}"
+      end
+
+      def parse_time(time_string)
+        return nil unless time_string
+
+        Time.parse(time_string)
+      end
+    end
+  end
+end

data/lib/deepl/style_rule_api.rb

@@ -0,0 +1,17 @@
+# Copyright 2025 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+module DeepL
+  class StyleRuleApi
+    def initialize(api, options = {})
+      @api = api
+      @options = options
+    end
+
+    def list(options = {})
+      DeepL::Requests::StyleRule::List.new(@api, options).request
+    end
+  end
+end

data/lib/deepl.rb

@@ -31,6 +31,7 @@ require 'deepl/requests/glossary/entries'
 require 'deepl/requests/glossary/find'
 require 'deepl/requests/glossary/language_pairs'
 require 'deepl/requests/glossary/list'
+require 'deepl/requests/style_rule/list'
 require 'deepl/requests/languages'
 require 'deepl/requests/translate'
 require 'deepl/requests/usage'
@@ -41,6 +42,7 @@ require 'deepl/resources/base'
 require 'deepl/resources/document_handle'
 require 'deepl/resources/document_translation_status'
 require 'deepl/resources/glossary'
+require 'deepl/resources/style_rule'
 require 'deepl/resources/language'
 require 'deepl/resources/language_pair'
 require 'deepl/resources/text'
@@ -62,11 +64,15 @@ require 'deepl/constants/writing_style'
 # -- HTTP Utils
 require 'http_client_options'
 
+# -- Version
+require 'version'
+
 # -- Other wrappers
 require 'deepl/api'
 require 'deepl/configuration'
 require 'deepl/document_api'
 require 'deepl/glossary_api'
+require 'deepl/style_rule_api'
 
 # -- Gem interface
 module DeepL
@@ -97,6 +103,11 @@ module DeepL
     GlossaryApi.new(api, options)
   end
 
+  def style_rules(options = {})
+    configure if @configuration.nil?
+    StyleRuleApi.new(api, options)
+  end
+
   def rephrase(text, target_lang = nil, writing_style = nil, tone = nil, options = {}) # rubocop:disable Metrics/ParameterLists
     configure if @configuration.nil?
     Requests::Rephrase.new(api, text, target_lang, writing_style, tone, options).request

data/lib/version.rb

@@ -0,0 +1,8 @@
+# Copyright 2025 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+module DeepL
+  VERSION = '3.4.1'
+end

data/spec/fixtures/vcr_cassettes/style_rules.yml

@@ -0,0 +1,92 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.deepl.com/v3/style_rules
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin24) ruby/3.2.2
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 11 Nov 2025 21:41:34 GMT
+      X-Trace-Id:
+      - 91581bb49e774db3a0521e222a037333
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      Server-Timing:
+      - l7_lb_tls;dur=135, l7_lb_idle;dur=0, l7_lb_receive;dur=0, l7_lb_total;dur=880
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: '{"style_rules":[{"style_id":"a4dfe768-8f34-41e3-8b22-9b832d39294c","name":"Korean
+        style rule","creation_time":"2025-11-04T16:59:14.940077Z","updated_time":"2025-11-04T16:59:14.940077Z","language":"ko","version":1},{"style_id":"d9c60f20-3e6a-4d62-bc44-3ce89b981ebe","name":"ZH
+        Style rule","creation_time":"2025-11-04T03:47:14.03409Z","updated_time":"2025-11-04T03:47:28.75149Z","language":"zh","version":3},{"style_id":"8e694a65-da89-4d30-911d-dcacbe7c962b","name":"Japanese
+        style rule","creation_time":"2025-11-04T03:46:45.90662Z","updated_time":"2025-11-04T03:46:49.288723Z","language":"ja","version":2},{"style_id":"5874b9c5-e353-4576-886d-0f6af62c9f02","name":"Talk
+        like a pirate","creation_time":"2025-10-31T12:44:26.679757Z","updated_time":"2025-10-31T12:46:20.102929Z","language":"en","version":3},{"style_id":"4f987ba6-80d1-41a3-a4aa-037c4f2a6fce","name":"My
+        style rule","creation_time":"2025-08-28T19:42:37.841254Z","updated_time":"2025-10-31T12:39:07.919025Z","language":"en","version":8},{"style_id":"1df39d69-d278-4353-b206-9f0d347146d0","name":"Style
+        Rule with Custom Instruction","creation_time":"2025-08-20T17:46:58.90728Z","updated_time":"2025-10-22T20:44:46.532386Z","language":"en","version":8}]}'
+  recorded_at: Tue, 11 Nov 2025 21:41:35 GMT
+- request:
+    method: get
+    uri: https://api.deepl.com/v3/style_rules
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - DeepL-Auth-Key invalid
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin24) ruby/3.2.2
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 11 Nov 2025 21:41:35 GMT
+      X-Trace-Id:
+      - e170bd92638c4c6db4e8c4d89fd4316d
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      Server-Timing:
+      - l7_lb_tls;dur=135, l7_lb_idle;dur=0, l7_lb_receive;dur=0, l7_lb_total;dur=136
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"message":"Authentication failed, provided API key is invalid. You
+        can find more info in our docs: https://developers.deepl.com/docs/getting-started/auth"}'
+  recorded_at: Tue, 11 Nov 2025 21:41:35 GMT
+recorded_with: VCR 6.3.1

data/spec/integration_tests/document_api_spec.rb

@@ -16,9 +16,10 @@ describe DeepL::DocumentApi do
     WebMock.disable_net_connect!
   end
 
-  default_lang_args = { source_lang: 'EN', target_lang: 'DE' }
   include_context 'with temp dir'
 
+  let(:default_lang_args) { { source_lang: 'EN', target_lang: 'DE' } }
+
   describe '#translate_document' do
     it 'Translates a document from a filepath' do
       File.unlink(output_document_path)

data/spec/integration_tests/style_rule_api_spec.rb

@@ -0,0 +1,79 @@
+# Copyright 2025 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE file.
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DeepL::StyleRuleApi do
+  before do
+    VCR.turn_off!
+    WebMock.allow_net_connect!
+  end
+
+  after do
+    VCR.turn_on!
+    WebMock.disable_net_connect!
+  end
+
+  describe '#translate_with_style_rules' do
+    it 'when performing a request with style_id' do
+      skip 'Only runs on mock server' if real_server?
+
+      source_lang = 'DE'
+      target_lang = 'EN-US'
+      text = 'Hallo, Welt!'
+      style_id = 'dca2e053-8ae5-45e6-a0d2-881156e7f4e4'
+
+      result = DeepL.translate(text, source_lang, target_lang, { style_rule: style_id })
+      expect(result).to be_a(DeepL::Resources::Text)
+    end
+
+    it 'when performing a request with style_rule object' do
+      skip 'Only runs on mock server' if real_server?
+
+      source_lang = 'DE'
+      target_lang = 'EN-US'
+      text = 'Hallo, Welt!'
+      style_rule = build_test_style_rule
+
+      result = DeepL.translate(text, source_lang, target_lang, { style_rule: style_rule })
+      expect(result).to be_a(DeepL::Resources::Text)
+    end
+  end
+
+  describe '#list_style_rules' do
+    it 'when requesting a list of all style rules' do
+      skip 'Only runs on mock server' if real_server?
+      style_rules = DeepL.style_rules.list(page: 0, page_size: 10, detailed: true)
+      expect(style_rules).to be_an(Array)
+      expect(style_rules.length).to eq(1)
+      expect(style_rules[0].style_id).to eq('dca2e053-8ae5-45e6-a0d2-881156e7f4e4')
+      expect(style_rules[0].name).to eq('Default Style Rule')
+      expect(style_rules[0].configured_rules).to be_a(DeepL::Resources::ConfiguredRules)
+      expect(style_rules[0].custom_instructions).to be_an(Array)
+    end
+
+    it 'when requesting a list of all style rules without detailed' do
+      skip 'Only runs on mock server' if real_server?
+      style_rules = DeepL.style_rules.list
+      expect(style_rules).to be_an(Array)
+      expect(style_rules.length).to eq(1)
+      expect(style_rules[0].style_id).to eq('dca2e053-8ae5-45e6-a0d2-881156e7f4e4')
+      expect(style_rules[0].configured_rules).to be_nil
+      expect(style_rules[0].custom_instructions).to be_nil
+    end
+  end
+
+  def build_test_style_rule
+    style_rule_data = {
+      'style_id' => 'dca2e053-8ae5-45e6-a0d2-881156e7f4e4',
+      'name' => 'Default Style Rule',
+      'creation_time' => '2025-01-01T00:00:00Z',
+      'updated_time' => '2025-01-01T00:00:00Z',
+      'language' => 'en',
+      'version' => 1
+    }
+    DeepL::Resources::StyleRule.new(style_rule_data, nil, nil)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.1
 platform: ruby
 authors:
 - DeepL SE
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-04 00:00:00.000000000 Z
+date: 2025-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier
@@ -98,6 +98,7 @@ files:
 - lib/deepl/requests/glossary/list.rb
 - lib/deepl/requests/languages.rb
 - lib/deepl/requests/rephrase.rb
+- lib/deepl/requests/style_rule/list.rb
 - lib/deepl/requests/translate.rb
 - lib/deepl/requests/usage.rb
 - lib/deepl/resources/base.rb
@@ -106,11 +107,14 @@ files:
 - lib/deepl/resources/glossary.rb
 - lib/deepl/resources/language.rb
 - lib/deepl/resources/language_pair.rb
+- lib/deepl/resources/style_rule.rb
 - lib/deepl/resources/text.rb
 - lib/deepl/resources/usage.rb
+- lib/deepl/style_rule_api.rb
 - lib/deepl/utils/backoff_timer.rb
 - lib/deepl/utils/exception_builder.rb
 - lib/http_client_options.rb
+- lib/version.rb
 - license_checker.sh
 - spec/api/api_spec.rb
 - spec/api/configuration_spec.rb
@@ -126,10 +130,12 @@ files:
 - spec/fixtures/vcr_cassettes/glossaries.yml
 - spec/fixtures/vcr_cassettes/languages.yml
 - spec/fixtures/vcr_cassettes/rephrase_texts.yml
+- spec/fixtures/vcr_cassettes/style_rules.yml
 - spec/fixtures/vcr_cassettes/translate_texts.yml
 - spec/fixtures/vcr_cassettes/usage.yml
 - spec/integration_tests/document_api_spec.rb
 - spec/integration_tests/integration_test_utils.rb
+- spec/integration_tests/style_rule_api_spec.rb
 - spec/requests/glossary/create_spec.rb
 - spec/requests/glossary/destroy_spec.rb
 - spec/requests/glossary/entries_spec.rb