crowdin-api 1.4.0 → 1.6.0

data/lib/crowdin-api/api_resources/source_files.rb

@@ -3,6 +3,9 @@
 module Crowdin
   module ApiResources
     module SourceFiles
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.branches.getMany  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.branches.getMany  Enterprise API Documentation}
       def list_branches(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
@@ -15,6 +18,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.branches.post  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.branches.post  Enterprise API Documentation}
       def add_branch(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
@@ -27,6 +33,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param branch_id [Integer] Branch ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.branches.get  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.branches.get  Enterprise API Documentation}
       def get_branch(branch_id = nil, project_id = config.project_id)
         branch_id  || raise_parameter_is_required_error(:branch_id)
         project_id || raise_project_id_is_required_error
@@ -39,6 +48,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param branch_id [Hash] Branch ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.branches.delete  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.branches.delete  Enterprise API Documentation}
       def delete_branch(branch_id = nil, project_id = config.project_id)
         branch_id  || raise_parameter_is_required_error(:branch_id)
         project_id || raise_project_id_is_required_error
@@ -51,6 +63,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param query [Hash] Request Body
+      # @param branch_id [Integer] Branch ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.branches.patch  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.branches.patch  Enterprise API Documentation}
       def edit_branch(branch_id = nil, query = {}, project_id = config.project_id)
         branch_id  || raise_parameter_is_required_error(:branch_id)
         project_id || raise_project_id_is_required_error
@@ -64,6 +80,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.directories.getMany  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.directories.getMany  Enterprise API Documentation}
       def list_directories(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
@@ -76,6 +95,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.directories.post  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.directories.post  Enterprise API Documentation}
       def add_directory(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
@@ -88,6 +110,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param directory_id [Integer] Directory ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.directories.get API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.directories.get  Enterprise API Documentation}
       def get_directory(directory_id = nil, project_id = config.project_id)
         directory_id || raise_parameter_is_required_error(:directory_id)
         project_id   || raise_project_id_is_required_error
@@ -100,6 +125,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param directory_id [Integer] Directory ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.directories.delete  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.directories.delete  Enterprise API Documentation}
       def delete_directory(directory_id = nil, project_id = config.project_id)
         directory_id || raise_parameter_is_required_error(:directory_id)
         project_id   || raise_project_id_is_required_error
@@ -112,6 +140,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param query [Hash] Request Body
+      # @param directory_id [Integer] Directory ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.directories.patch  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.directories.patch  Enterprise API Documentation}
       def edit_directory(directory_id = nil, query = {}, project_id = config.project_id)
         directory_id || raise_parameter_is_required_error(:directory_id)
         project_id   || raise_project_id_is_required_error
@@ -125,6 +157,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.files.getMany  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.getMany  Enterprise API Documentation}
       def list_files(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
@@ -137,6 +172,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.files.post  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.post  Enterprise API Documentation}
       def add_file(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
@@ -149,6 +187,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param file_id [Integer] File ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.files.get  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.get  Enterprise API Documentation}
       def get_file(file_id = nil, project_id = config.project_id)
         file_id    || raise_parameter_is_required_error(:file_id)
         project_id || raise_project_id_is_required_error
@@ -161,6 +202,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param query [Hash] Request Body
+      # @param file_id [Integer] File ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.files.put  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.put  Enterprise API Documentation}
       def update_or_restore_file(file_id = nil, query = {}, project_id = config.project_id)
         file_id    || raise_parameter_is_required_error(:file_id)
         project_id || raise_project_id_is_required_error
@@ -174,6 +219,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param file_id [Integer] File ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.files.delete  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.delete Enterprise API Documentation}
       def delete_file(file_id = nil, project_id = config.project_id)
         file_id    || raise_parameter_is_required_error(:file_id)
         project_id || raise_project_id_is_required_error
@@ -186,6 +234,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param query [Hash] Request Body
+      # @param file_id [Integer] File ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.files.patch  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.patch Enterprise API Documentation}
       def edit_file(file_id = nil, query = {}, project_id = config.project_id)
         file_id    || raise_parameter_is_required_error(:file_id)
         project_id || raise_project_id_is_required_error
@@ -199,6 +251,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param file_id [Integer] File ID
+      # @param destination [String] Destination of File
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.files.download.get API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.download.get Enterprise API Documentation}
       def download_file(file_id = nil, destination = nil, project_id = config.project_id)
         file_id     || raise_parameter_is_required_error(:file_id)
         project_id  || raise_project_id_is_required_error
@@ -211,6 +267,10 @@ module Crowdin
         Web::SendRequest.new(request, destination).perform
       end
 
+      # @param query [Hash] Request Body
+      # @param file_id [Integer] File ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.files.revisions.getMany API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.revisions.getMany Enterprise API Documentation}
       def list_file_revisions(file_id = nil, query = {}, project_id = config.project_id)
         file_id    || raise_parameter_is_required_error(:file_id)
         project_id || raise_project_id_is_required_error
@@ -224,6 +284,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param revision_id [Integer] Revision ID
+      # @param file_id [Integer] File ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.files.revisions.get API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.revisions.get Enterprise API Documentation}
       def get_file_revision(file_id = nil, revision_id = nil, project_id = config.project_id)
         file_id     || raise_parameter_is_required_error(:file_id)
         revision_id || raise_parameter_is_required_error(:revision_id)

data/lib/crowdin-api/api_resources/storages.rb

@@ -3,6 +3,9 @@
 module Crowdin
   module ApiResources
     module Storages
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.storages.getMany  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.storages.getMany  Enterprise API Documentation}
       def list_storages(query = {})
         request = Web::Request.new(
           connection,
@@ -13,6 +16,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param file [string] File path
+      # * {https://developer.crowdin.com/api/v2/#operation/api.storages.post  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.storages.post  Enterprise API Documentation}
       def add_storage(file = nil)
         file || raise_parameter_is_required_error(:file)
 
@@ -28,6 +34,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param storage_id [Integer] Storage ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.storages.get  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.storages.get  Enterprise API Documentation}
       def get_storage(storage_id = nil)
         storage_id || raise_parameter_is_required_error(:storage_id)
 
@@ -39,6 +48,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param storage_id [Integer] Storage ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.storages.delete  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.storages.delete  Enterprise API Documentation}
       def delete_storage(storage_id = nil)
         storage_id || raise_parameter_is_required_error(:storage_id)
 

data/lib/crowdin-api/api_resources/string_translations.rb

@@ -188,6 +188,22 @@ module Crowdin
         )
         Web::SendRequest.new(request).perform
       end
+
+      def add_translation_alignment(project_id = nil, query = {})
+        project_id || raise_project_id_is_required_error
+
+        %i[source_language_id target_language_id text].each do |param|
+          query[param] || raise_parameter_is_required_error(param)
+        end
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/translations/alignment",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
     end
   end
 end

data/lib/crowdin-api/api_resources/translation_memory.rb

@@ -126,6 +126,22 @@ module Crowdin
         )
         Web::SendRequest.new(request).perform
       end
+
+      def search_tms_concordance(project_id = nil, query = {})
+        project_id || raise_project_id_is_required_error
+
+        %i[source_language_id target_language_id expression auto_substitution min_relevant].each do |param|
+          query[param] || raise_parameter_is_required_error(param)
+        end
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/tms/concordance",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
     end
   end
 end

data/lib/crowdin-api/client/client.rb

@@ -103,7 +103,7 @@ module Crowdin
     # otherwise system will retry so many times, as indicated at tries_count
     #
     def fetch_all(api_resource, opts = {}, retry_opts = {})
-      unless Web::FetchAllExtensions::API_RESOURCES_FOR_FETCH_ALL.include?(api_resource)
+      unless api_resource.to_s.start_with?('list_')
         raise(Errors::FetchAllProcessingError, "#{api_resource} method aren't supported for FetchAll")
       end
 

data/lib/crowdin-api/client/version.rb

@@ -2,6 +2,6 @@
 
 module Crowdin
   class Client
-    VERSION = '1.4.0'
+    VERSION = '1.6.0'
   end
 end

data/lib/crowdin-api/core/fetch_all_extensions.rb

@@ -4,11 +4,6 @@ module Crowdin
   module Web
     module FetchAllExtensions
       MAX_ITEMS_COUNT_PER_REQUEST = 500.freeze
-      API_RESOURCES_FOR_FETCH_ALL = %i[list_vendors list_dictionaries list_directories list_distributions
-                                       list_workflow_templates list_languages list_labels list_mts list_files
-                                       list_projects list_groups list_branches list_strings list_storages
-                                       list_string_comments list_tasks list_user_tasks list_webhooks
-                                       list_terms list_file_revisions list_bundles].freeze
     end
   end
 end

data/spec/api_resources/bundles_spec.rb

@@ -13,11 +13,42 @@ describe Crowdin::ApiResources::Bundles do
     describe '#add_bundle' do
       it 'when request are valid', :default do
         stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/bundles")
-        add_bundle = @crowdin.add_bundle({}, project_id)
+        add_bundle = @crowdin.add_bundle({ name: '', format: '', sourcePatterns: [], exportPattern: '' }, project_id)
         expect(add_bundle).to eq(200)
       end
     end
 
+    describe '#export_bundle' do
+      let(:bundle_id) { 1 }
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/bundles/#{bundle_id}/exports")
+        export_bundle = @crowdin.export_bundle(bundle_id, project_id)
+        expect(export_bundle).to eq(200)
+      end
+    end
+
+    describe '#check_bundle_export_status' do
+      let(:bundle_id) { 1 }
+      let(:export_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/bundles/#{bundle_id}/exports/#{export_id}")
+        check_bundle_export_status = @crowdin.check_bundle_export_status(bundle_id, export_id, project_id)
+        expect(check_bundle_export_status).to eq(200)
+      end
+    end
+
+    describe '#download_bundle' do
+      let(:bundle_id) { 1 }
+      let(:export_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/bundles/#{bundle_id}/exports/#{export_id}/download")
+        download_bundle = @crowdin.download_bundle(bundle_id, export_id, project_id)
+        expect(download_bundle).to eq(200)
+      end
+    end
+
     describe '#get_bundle' do
       let(:bundle_id) { 1 }