crowdin-api 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 283ff1afb3a211be3a2c06c0417decc9b6ff3fcca1e8c61c78523708c428d286
-  data.tar.gz: e6f02c86c39702e00eacc0908c6dec0a93783a7a4038e2eddbc634ca2d4887d3
+  metadata.gz: 92b7e78f934fe0170055ff679da134b9b4444caba51677c19ba8903a1eaf55ec
+  data.tar.gz: 22ebff0813e0d4d1c0217a3c9163e738f3b58fa6124d09f5cfff4cf3ddb3330c
 SHA512:
-  metadata.gz: ca47c68a8c81d3de24a5ae913155ece611ae9400fdbea47933355d6043036c269d15ab067df037afcdc4aae1fa982991f49bee4603fb5f6816a783dd6d7c30b1
-  data.tar.gz: dcf04302fb3c882a81f630476b4e7dce4cf1e98320da04615d3d393fb4bdfadb9bc67aec732bee227321cd3af7cbc095363f0f0c22a903a5f954acb6101a243a
+  metadata.gz: e0705ea1264b498c2a8080445ab79ccc353347e65f928acd68008ea96a1a8a97c0c947b332d88fb9171ba1d02001e231498cc34102d2c8dd6967d1b858204f7a
+  data.tar.gz: 81c748f6b6cf1090bb218d486548634c37c2a10594d937745abdd07e2cea097a8e9dd64617a85e85c06cc35b97b7ac4a5f4ffa3bc7846970efa860ef99fe3522

data/.github/workflows/docs.yml

@@ -0,0 +1,31 @@
+name: Docs
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.6
+        uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+        with:
+          ruby-version: 2.6
+      - run: bundle install
+
+      - name: Cleanup the Readme
+        run: |
+          sed -i /\<div/d README.md
+          sed -i /\<\\/div/d README.md
+
+      - name: Generate Docs
+        run: yardoc lib/crowdin-api/api_resources/*.rb
+
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@v4.4.1
+        with:
+          branch: gh-pages
+          folder: doc

data/.rubocop_todo.yml

@@ -104,7 +104,7 @@ Metrics/MethodLength:
 # Offense count: 8
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 196
+  Max: 256
 
 # Offense count: 2
 # Configuration parameters: Max, CountKeywordArgs.

data/Gemfile

@@ -2,4 +2,7 @@
 
 source 'https://rubygems.org'
 
+# For Documentation
+gem 'yard', '~> 0.9.28'
+
 gemspec

data/README.md

@@ -1,4 +1,4 @@
-[<p align='center'><img src='https://support.crowdin.com/assets/logos/crowdin-dark-symbol.png' data-canonical-src='https://support.crowdin.com/assets/logos/crowdin-dark-symbol.png' width='200' height='200' align='center'/></p>](https://crowdin.com)
+[<p align='center'><img src='https://support.crowdin.com/assets/logos/crowdin-dark-symbol.png' data-canonical-src='https://support.crowdin.com/assets/logos/crowdin-dark-symbol.png' width='150' height='150' align='center'/></p>](https://crowdin.com)
 
 # Crowdin Ruby client
 
@@ -6,11 +6,11 @@ The Crowdin Ruby client is a lightweight interface to the Crowdin API v2. It pro
 
 Crowdin API is a full-featured RESTful API that helps you to integrate localization into your development process. The endpoints that we use allow you to easily make calls to retrieve information and to execute actions needed.
 
-For more about Crowdin API v2 see the documentation:
-- [Crowdin](https://support.crowdin.com/api/v2/)
-- [Crowdin Enterprise](https://support.crowdin.com/enterprise/api/)
+<div align="center">
 
-## Status
+[**`API Client Docs`**](http://crowdin.github.io/crowdin-api-client-ruby/) &nbsp;|&nbsp;
+[**`Crowdin API`**](https://developer.crowdin.com/api/v2/) &nbsp;|&nbsp;
+[**`Crowdin Enterprise API`**](https://developer.crowdin.com/enterprise/api/v2/)
 
 [![Gem](https://img.shields.io/gem/v/crowdin-api?logo=ruby&cacheSeconds=1800)](https://rubygems.org/gems/crowdin-api)
 [![Gem](https://img.shields.io/gem/dt/crowdin-api?cacheSeconds=1800)](https://rubygems.org/gems/crowdin-api)
@@ -21,6 +21,8 @@ For more about Crowdin API v2 see the documentation:
 [![GitHub issues](https://img.shields.io/github/issues/crowdin/crowdin-api-client-ruby?cacheSeconds=1800)](https://github.com/crowdin/crowdin-api-client-ruby/issues)
 [![GitHub](https://img.shields.io/github/license/crowdin/crowdin-api-client-ruby?cacheSeconds=1800)](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/LICENSE)
 
+</div>
+
 ## Table of Contents
 * [Requirements](#requirements)
 * [Installation](#installation)
@@ -41,7 +43,7 @@ For more about Crowdin API v2 see the documentation:
 Add this line to your application's Gemfile:
 
 ```gemfile
-gem 'crowdin-api', '~> 1.4.0'
+gem 'crowdin-api', '~> 1.5.0'
 ```
 
 And then execute:

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

@@ -3,6 +3,9 @@
 module Crowdin
   module ApiResources
     module Bundles
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.getMany  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.getMany  Enterprise API Documentation}
       def list_bundles(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
@@ -15,8 +18,14 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.post  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.post  Enterprise API Documentation}
       def add_bundle(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
+        %i[name format sourcePatterns exportPattern].each do |param|
+          query[param] || raise_parameter_is_required_error(param)
+        end
 
         request = Web::Request.new(
           connection,
@@ -27,6 +36,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param bundle_id [Integer] Bundle ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.get  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.get  Enterprise API Documentation}
       def get_bundle(bundle_id, project_id = config.project_id)
         bundle_id  || raise_parameter_is_required_error(:bundle_id)
         project_id || raise_project_id_is_required_error
@@ -39,6 +51,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param bundle_id [Integer] Bundle ID
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.delete  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.delete  Enterprise API Documentation}
       def delete_bundle(bundle_id, project_id = config.project_id)
         bundle_id  || raise_parameter_is_required_error(:bundle_id)
         project_id || raise_project_id_is_required_error
@@ -51,6 +66,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param bundle_id [Integer] Bundle ID
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.patch  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.patch  Enterprise API Documentation}
       def edit_bundle(bundle_id, query = {}, project_id = config.project_id)
         bundle_id  || raise_parameter_is_required_error(:bundle_id)
         project_id || raise_project_id_is_required_error
@@ -64,6 +83,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param bundle_id [Integer] Bundle ID
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.bundles.files.getMany  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.bundles.files.getMany  Enterprise API Documentation}
       def bundle_list_files(bundle_id, query = {}, project_id = config.project_id)
         bundle_id  || raise_parameter_is_required_error(:bundle_id)
         project_id || raise_project_id_is_required_error

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

@@ -194,6 +194,55 @@ module Crowdin
         )
         Web::SendRequest.new(request).perform
       end
+
+      def list_concepts(glossary_id = nil, query = {})
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/glossaries/#{glossary_id}/concepts",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_concept(glossary_id = nil, concept_id = nil)
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+        concept_id || raise_parameter_is_required_error(:concept_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/glossaries/#{glossary_id}/concepts/#{concept_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def update_concept(glossary_id = nil, concept_id = nil, query = {})
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+        concept_id || raise_parameter_is_required_error(:concept_id)
+
+        request = Web::Request.new(
+          connection,
+          :put,
+          "#{config.target_api_url}/glossaries/#{glossary_id}/concepts/#{concept_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_concept(glossary_id = nil, concept_id = nil)
+        glossary_id || raise_parameter_is_required_error(:glossary_id)
+        concept_id || raise_parameter_is_required_error(:concept_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/glossaries/#{glossary_id}/concepts/#{concept_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
     end
   end
 end

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

@@ -3,6 +3,9 @@
 module Crowdin
   module ApiResources
     module Projects
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.getMany  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.getMany  Enterprise API Documentation}
+      # @param query [Hash] Request Body
       def list_projects(query = {})
         request = Web::Request.new(
           connection,
@@ -13,6 +16,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.post  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.post  Enterprise API Documentation}
+      # @param query [Hash] Request Body
       def add_project(query = {})
         request = Web::Request.new(
           connection,
@@ -23,6 +29,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.get  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.get  Enterprise API Documentation}
+      # @param project_id [Integer] Project ID
       def get_project(project_id = nil)
         project_id || raise_parameter_is_required_error(:project_id)
 
@@ -34,6 +43,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.delete  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.delete  Enterprise API Documentation}
+      # @param project_id [Integer] Project ID
       def delete_project(project_id = nil)
         project_id || raise_parameter_is_required_error(:project_id)
 
@@ -45,6 +57,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param project_id [Integer] Project ID
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.patch  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.patch  Enterprise API Documentation}
       def edit_project(project_id = nil, query = {})
         project_id || raise_parameter_is_required_error(:project_id)
 
@@ -59,6 +75,8 @@ module Crowdin
 
       # -- For Enterprise mode only --
 
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.groups.getMany  Enterprise API Documentation}
       def list_groups(query = {})
         enterprise_mode? || raise_only_for_enterprise_mode_error
 
@@ -71,6 +89,8 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.groups.post  Enterprise API Documentation}
       def add_group(query = {})
         enterprise_mode? || raise_only_for_enterprise_mode_error
 
@@ -83,6 +103,8 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param group_id [Integer] Group ID
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.groups.get  Enterprise API Documentation}
       def get_group(group_id = nil)
         enterprise_mode? || raise_only_for_enterprise_mode_error
         group_id         || raise_parameter_is_required_error(:group_id)
@@ -95,6 +117,8 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param group_id [Integer] Group ID
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.groups.delete  Enterprise API Documentation}
       def delete_group(group_id = nil)
         enterprise_mode? || raise_only_for_enterprise_mode_error
         group_id         || raise_parameter_is_required_error(:group_id)
@@ -107,6 +131,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param group_id [Integer] Group ID
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.groups.patch  Enterprise API Documentation}
       def edit_group(group_id = nil, query = {})
         enterprise_mode? || raise_only_for_enterprise_mode_error
         group_id         || raise_parameter_is_required_error(:group_id)

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

@@ -115,6 +115,70 @@ module Crowdin
         )
         Web::SendRequest.new(request, destination).perform
       end
+
+      def list_report_settings_templates(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/reports/settings-templates",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_report_settings_template(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+        %i[name currency unit mode config].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}/reports/settings-templates",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_report_settings_template(template_id = nil, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+        template_id || raise_parameter_is_required_error(:template_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_report_settings_template(query = {}, template_id = nil, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+        template_id || raise_parameter_is_required_error(:template_id)
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_report_settings_template(template_id = nil, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+        template_id || raise_parameter_is_required_error(:template_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
     end
   end
 end

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/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.5.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,7 +13,7 @@ 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

data/spec/api_resources/glossaries_spec.rb

@@ -163,5 +163,48 @@ describe Crowdin::ApiResources::Glossaries do
         expect(edit_term).to eq(200)
       end
     end
+
+    describe '#list_concepts' do
+      let(:glossary_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/concepts")
+        concepts = @crowdin.list_concepts(glossary_id)
+        expect(concepts).to eq(200)
+      end
+    end
+
+    describe '#get_concept' do
+      let(:glossary_id) { 1 }
+      let(:concept_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/concepts/#{concept_id}")
+        concept = @crowdin.get_concept(glossary_id, concept_id)
+        expect(concept).to eq(200)
+      end
+    end
+
+    describe '#update_concept' do
+      let(:glossary_id) { 1 }
+      let(:concept_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:put, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/concepts/#{concept_id}")
+        concept = @crowdin.update_concept(glossary_id, concept_id)
+        expect(concept).to eq(200)
+      end
+    end
+
+    describe '#update_concept' do
+      let(:glossary_id) { 1 }
+      let(:concept_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/glossaries/#{glossary_id}/concepts/#{concept_id}")
+        concept = @crowdin.delete_concept(glossary_id, concept_id)
+        expect(concept).to eq(200)
+      end
+    end
   end
 end

data/spec/api_resources/reports_spec.rb

@@ -92,4 +92,54 @@ describe Crowdin::ApiResources::Reports do
       end
     end
   end
+
+  describe 'Setting Templates endpoints' do
+    describe 'List Report Settings templates' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/reports/settings-templates")
+        settings_templates = @crowdin.list_report_settings_templates({}, project_id)
+        expect(settings_templates).to eq(200)
+      end
+    end
+
+    describe 'Add Report Settings template' do
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/reports/settings-templates")
+        settings_templates = @crowdin.add_report_settings_template(
+          { name: '', currency: '', unit: '', mode: '', config: '' }, project_id
+        )
+        expect(settings_templates).to eq(200)
+      end
+    end
+
+    describe 'Get Report Settings template' do
+      let(:template_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}")
+        settings_templates = @crowdin.get_report_settings_template(template_id, project_id)
+        expect(settings_templates).to eq(200)
+      end
+    end
+
+    describe 'Get Report Settings template' do
+      let(:template_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}")
+        settings_templates = @crowdin.edit_report_settings_template({}, template_id, project_id)
+        expect(settings_templates).to eq(200)
+      end
+    end
+
+    describe 'Get Report Settings template' do
+      let(:template_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}")
+        settings_templates = @crowdin.delete_report_settings_template(template_id, project_id)
+        expect(settings_templates).to eq(200)
+      end
+    end
+  end
 end

data/spec/unit/client_spec.rb

@@ -82,4 +82,10 @@ describe 'Crowdin Client' do
       expect(@crowdin.config.base_url).to eq("https://#{full_organization_domain}")
     end
   end
+
+  describe 'Crowdin Client fetch_all' do
+    it 'should raise error if fetch_all is called for unsupported methods' do
+      expect { @crowdin.fetch_all(:add_bundle).to raise_error(Crowdin::Errors::FetchAllProcessingError) }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-api
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-15 00:00:00.000000000 Z
+date: 2022-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open-uri
@@ -170,6 +170,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/build-and-publish.yml"
+- ".github/workflows/docs.yml"
 - ".github/workflows/test-and-lint.yml"
 - ".gitignore"
 - ".rspec"