deepl-rb 3.6.1 → 3.7.0

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

@@ -0,0 +1,41 @@
+# Copyright 2026 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 FindCustomInstruction < Base
+        def initialize(api, style_id, instruction_id, options = {})
+          super(api, options)
+          @style_id = style_id
+          @instruction_id = instruction_id
+        end
+
+        def request
+          build_custom_instruction(*execute_request_with_retries(get_request))
+        end
+
+        def to_s
+          "GET #{uri.request_uri}"
+        end
+
+        private
+
+        def build_custom_instruction(_request, response)
+          data = JSON.parse(response.body)
+          DeepL::Resources::CustomInstruction.new(data)
+        end
+
+        def uri
+          @uri ||= URI("#{host}/v3/#{path}")
+        end
+
+        def path
+          "style_rules/#{@style_id}/custom_instructions/#{@instruction_id}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# Copyright 2026 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 Update < Base
+        def initialize(api, style_id, name, options = {})
+          super(api, options)
+          @style_id = style_id
+          @name = name
+        end
+
+        def request
+          payload = { name: @name }
+          build_style_rule(*execute_request_with_retries(patch_request(payload)))
+        end
+
+        def to_s
+          "PATCH #{uri.request_uri}"
+        end
+
+        private
+
+        def build_style_rule(request, response)
+          data = JSON.parse(response.body)
+          DeepL::Resources::StyleRule.new(data, request, response)
+        end
+
+        def uri
+          @uri ||= URI("#{host}/v3/#{path}")
+        end
+
+        def path
+          "style_rules/#{@style_id}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# Copyright 2026 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 UpdateConfiguredRules < Base
+        def initialize(api, style_id, configured_rules, options = {})
+          super(api, options)
+          @style_id = style_id
+          @configured_rules = configured_rules
+        end
+
+        def request
+          build_style_rule(*execute_request_with_retries(put_request(@configured_rules)))
+        end
+
+        def to_s
+          "PUT #{uri.request_uri}"
+        end
+
+        private
+
+        def build_style_rule(request, response)
+          data = JSON.parse(response.body)
+          DeepL::Resources::StyleRule.new(data, request, response)
+        end
+
+        def uri
+          @uri ||= URI("#{host}/v3/#{path}")
+        end
+
+        def path
+          "style_rules/#{@style_id}/configured_rules"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# Copyright 2026 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 UpdateCustomInstruction < Base
+        def initialize(api, style_id, instruction_id, label, prompt, # rubocop:disable Metrics/ParameterLists
+                       source_language = nil, options = {})
+          super(api, options)
+          @style_id = style_id
+          @instruction_id = instruction_id
+          @label = label
+          @prompt = prompt
+          @source_language = source_language
+        end
+
+        def request
+          payload = { label: @label, prompt: @prompt }
+          payload[:source_language] = @source_language if @source_language
+          build_custom_instruction(*execute_request_with_retries(put_request(payload)))
+        end
+
+        def to_s
+          "PUT #{uri.request_uri}"
+        end
+
+        private
+
+        def build_custom_instruction(_request, response)
+          data = JSON.parse(response.body)
+          DeepL::Resources::CustomInstruction.new(data)
+        end
+
+        def uri
+          @uri ||= URI("#{host}/v3/#{path}")
+        end
+
+        def path
+          "style_rules/#{@style_id}/custom_instructions/#{@instruction_id}"
+        end
+      end
+    end
+  end
+end

data/lib/deepl/requests/translate.rb

@@ -39,12 +39,12 @@ module DeepL
         tweak_parameters!
       end
 
-      def request # rubocop:disable Metrics/MethodLength
+      def request # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
         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)
+          style_rule = delete_option(:style_rule)
           payload[:style_id] = if style_rule.is_a?(DeepL::Resources::StyleRule)
                                  style_rule.style_id
                                else
@@ -52,6 +52,19 @@ module DeepL
                                end
         end
 
+        if option?(:translation_memory)
+          tm = delete_option(:translation_memory)
+          payload[:translation_memory_id] = if tm.is_a?(DeepL::Resources::TranslationMemory)
+                                              tm.translation_memory_id
+                                            else
+                                              tm.to_s
+                                            end
+        end
+
+        if option?(:translation_memory_threshold)
+          payload[:translation_memory_threshold] = delete_option(:translation_memory_threshold)
+        end
+
         build_texts(*execute_request_with_retries(post_request(payload)))
       end
 

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

@@ -0,0 +1,58 @@
+# Copyright 2026 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 TranslationMemory
+      class List < Base
+        def initialize(api, options = {})
+          super
+        end
+
+        def request
+          build_translation_memory_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_translation_memory_list(request, response)
+          data = JSON.parse(response.body)
+          data['translation_memories'].map do |tm|
+            Resources::TranslationMemory.new(tm, 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)
+          URI.encode_www_form(params)
+        end
+
+        def path
+          'translation_memories'
+        end
+      end
+    end
+  end
+end

data/lib/deepl/resources/style_rule.rb

@@ -29,9 +29,10 @@ module DeepL
     end
 
     class CustomInstruction
-      attr_reader :label, :prompt, :source_language
+      attr_reader :id, :label, :prompt, :source_language
 
       def initialize(custom_instruction_data)
+        @id = custom_instruction_data['id']
         @label = custom_instruction_data['label']
         @prompt = custom_instruction_data['prompt']
         @source_language = custom_instruction_data['source_language']

data/lib/deepl/resources/translation_memory.rb

@@ -0,0 +1,25 @@
+# Copyright 2026 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 Resources
+    class TranslationMemory < Base
+      attr_reader :translation_memory_id, :name, :source_language, :target_languages, :segment_count
+
+      def initialize(translation_memory, *args)
+        super(*args)
+        @translation_memory_id = translation_memory['translation_memory_id']
+        @name = translation_memory['name']
+        @source_language = translation_memory['source_language']
+        @target_languages = translation_memory['target_languages'] || []
+        @segment_count = translation_memory['segment_count'] || 0
+      end
+
+      def to_s
+        "#{translation_memory_id} - #{name}"
+      end
+    end
+  end
+end

data/lib/deepl/style_rule_api.rb

@@ -13,5 +13,49 @@ module DeepL
     def list(options = {})
       DeepL::Requests::StyleRule::List.new(@api, options).request
     end
+
+    def create(name, language, options = {})
+      DeepL::Requests::StyleRule::Create.new(@api, name, language, options).request
+    end
+
+    def find(style_id, options = {})
+      DeepL::Requests::StyleRule::Find.new(@api, style_id, options).request
+    end
+
+    def update_name(style_id, name, options = {})
+      DeepL::Requests::StyleRule::Update.new(@api, style_id, name, options).request
+    end
+
+    def destroy(style_id, options = {})
+      DeepL::Requests::StyleRule::Destroy.new(@api, style_id, options).request
+    end
+
+    def update_configured_rules(style_id, configured_rules, options = {})
+      DeepL::Requests::StyleRule::UpdateConfiguredRules.new(@api, style_id, configured_rules,
+                                                            options).request
+    end
+
+    def create_custom_instruction(style_id, label, prompt, source_language = nil, options = {})
+      DeepL::Requests::StyleRule::CreateCustomInstruction.new(@api, style_id, label, prompt,
+                                                              source_language, options).request
+    end
+
+    def find_custom_instruction(style_id, instruction_id, options = {})
+      DeepL::Requests::StyleRule::FindCustomInstruction.new(@api, style_id, instruction_id,
+                                                            options).request
+    end
+
+    def update_custom_instruction(style_id, instruction_id, label,
+                                  prompt, source_language = nil,
+                                  options = {})
+      DeepL::Requests::StyleRule::UpdateCustomInstruction.new(@api, style_id, instruction_id,
+                                                              label, prompt, source_language,
+                                                              options).request
+    end
+
+    def destroy_custom_instruction(style_id, instruction_id, options = {})
+      DeepL::Requests::StyleRule::DestroyCustomInstruction.new(@api, style_id, instruction_id,
+                                                               options).request
+    end
   end
 end

data/lib/deepl/translation_memory_api.rb

@@ -0,0 +1,17 @@
+# Copyright 2026 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 TranslationMemoryApi
+    def initialize(api, options = {})
+      @api = api
+      @options = options
+    end
+
+    def list(options = {})
+      DeepL::Requests::TranslationMemory::List.new(@api, options).request
+    end
+  end
+end

data/lib/deepl.rb

@@ -8,71 +8,83 @@ require 'json'
 require 'net/http'
 
 # -- Exceptions
-require 'deepl/exceptions/error'
-require 'deepl/exceptions/request_error'
-require 'deepl/exceptions/authorization_failed'
-require 'deepl/exceptions/bad_request'
-require 'deepl/exceptions/limit_exceeded'
-require 'deepl/exceptions/quota_exceeded'
-require 'deepl/exceptions/not_found'
-require 'deepl/exceptions/not_supported'
-require 'deepl/exceptions/request_entity_too_large'
-require 'deepl/exceptions/document_translation_error'
-require 'deepl/exceptions/server_error'
+require_relative 'deepl/exceptions/error'
+require_relative 'deepl/exceptions/request_error'
+require_relative 'deepl/exceptions/authorization_failed'
+require_relative 'deepl/exceptions/bad_request'
+require_relative 'deepl/exceptions/limit_exceeded'
+require_relative 'deepl/exceptions/quota_exceeded'
+require_relative 'deepl/exceptions/not_found'
+require_relative 'deepl/exceptions/not_supported'
+require_relative 'deepl/exceptions/request_entity_too_large'
+require_relative 'deepl/exceptions/document_translation_error'
+require_relative 'deepl/exceptions/server_error'
 
 # -- Requests
-require 'deepl/requests/base'
-require 'deepl/requests/document/download'
-require 'deepl/requests/document/get_status'
-require 'deepl/requests/document/upload'
-require 'deepl/requests/glossary/create'
-require 'deepl/requests/glossary/destroy'
-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'
-require 'deepl/requests/rephrase'
+require_relative 'deepl/requests/base'
+require_relative 'deepl/requests/document/download'
+require_relative 'deepl/requests/document/get_status'
+require_relative 'deepl/requests/document/upload'
+require_relative 'deepl/requests/glossary/create'
+require_relative 'deepl/requests/glossary/destroy'
+require_relative 'deepl/requests/glossary/entries'
+require_relative 'deepl/requests/glossary/find'
+require_relative 'deepl/requests/glossary/language_pairs'
+require_relative 'deepl/requests/glossary/list'
+require_relative 'deepl/requests/style_rule/list'
+require_relative 'deepl/requests/style_rule/create'
+require_relative 'deepl/requests/style_rule/find'
+require_relative 'deepl/requests/style_rule/update'
+require_relative 'deepl/requests/style_rule/destroy'
+require_relative 'deepl/requests/style_rule/update_configured_rules'
+require_relative 'deepl/requests/style_rule/create_custom_instruction'
+require_relative 'deepl/requests/style_rule/find_custom_instruction'
+require_relative 'deepl/requests/style_rule/update_custom_instruction'
+require_relative 'deepl/requests/style_rule/destroy_custom_instruction'
+require_relative 'deepl/requests/translation_memory/list'
+require_relative 'deepl/requests/languages'
+require_relative 'deepl/requests/translate'
+require_relative 'deepl/requests/usage'
+require_relative 'deepl/requests/rephrase'
 
 # -- Responses and resources
-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'
-require 'deepl/resources/usage'
+require_relative 'deepl/resources/base'
+require_relative 'deepl/resources/document_handle'
+require_relative 'deepl/resources/document_translation_status'
+require_relative 'deepl/resources/glossary'
+require_relative 'deepl/resources/style_rule'
+require_relative 'deepl/resources/translation_memory'
+require_relative 'deepl/resources/language'
+require_relative 'deepl/resources/language_pair'
+require_relative 'deepl/resources/text'
+require_relative 'deepl/resources/usage'
 
 # -- Utils
-require 'deepl/utils/exception_builder'
-require 'deepl/utils/backoff_timer'
+require_relative 'deepl/utils/exception_builder'
+require_relative 'deepl/utils/backoff_timer'
 
 # -- Constants
-require 'deepl/constants/base_constant'
-require 'deepl/constants/formality'
-require 'deepl/constants/model_type'
-require 'deepl/constants/split_sentences'
-require 'deepl/constants/tag_handling'
-require 'deepl/constants/tone'
-require 'deepl/constants/writing_style'
+require_relative 'deepl/constants/base_constant'
+require_relative 'deepl/constants/formality'
+require_relative 'deepl/constants/model_type'
+require_relative 'deepl/constants/split_sentences'
+require_relative 'deepl/constants/tag_handling'
+require_relative 'deepl/constants/tone'
+require_relative 'deepl/constants/writing_style'
 
 # -- HTTP Utils
-require 'http_client_options'
+require_relative 'http_client_options'
 
 # -- Version
-require 'version'
+require_relative 'version'
 
 # -- Other wrappers
-require 'deepl/api'
-require 'deepl/configuration'
-require 'deepl/document_api'
-require 'deepl/glossary_api'
-require 'deepl/style_rule_api'
+require_relative 'deepl/api'
+require_relative 'deepl/configuration'
+require_relative 'deepl/document_api'
+require_relative 'deepl/glossary_api'
+require_relative 'deepl/style_rule_api'
+require_relative 'deepl/translation_memory_api'
 
 # -- Gem interface
 module DeepL
@@ -108,6 +120,11 @@ module DeepL
     StyleRuleApi.new(api, options)
   end
 
+  def translation_memories(options = {})
+    configure if @configuration.nil?
+    TranslationMemoryApi.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

@@ -4,5 +4,5 @@
 # frozen_string_literal: true
 
 module DeepL
-  VERSION = '3.6.1'
+  VERSION = '3.7.0'
 end