crowdin-api 1.12.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cd5b2539130f20d40ab8eae20e4291675e8b58c27883fd7ce59323492ad4daa
-  data.tar.gz: 699e9cc4411451da663e4bb59abb4a641c8dad98c9bb82dac475e11882facc59
+  metadata.gz: 98a60b3487c1824a37ef3519089f1e48e7de773f35734a54a981365707bbd80a
+  data.tar.gz: 0e5642b1b3446d55602f34ec4820b82e5d686e4002df0158371031141480bde1
 SHA512:
-  metadata.gz: e80a6940f20de8d1e70d4edbec95d468137ae5b9b4979ed005e920c6e5fe2e9d794ed5dfe43120766c0e3d9a2e9e7aaa2d8c1abfbfd1c566c19b688d3a494224
-  data.tar.gz: 62102d71575df111fbeed6f28fba6b7a91d66fc2835174df83ca51138df0fc3b242937363f55f07d8d1b046fb405179bd6c953e3732cdc39f05c4dbfb057e19f
+  metadata.gz: a6ee9691d7ce60578c6438bf58874262edaa4dc8100723a2c9ad56b70828c97367a332401a47b9f098408d48dec4324714d83e5a1f73f3a2d683c829f3dc792f
+  data.tar.gz: cc3e2fbdc50836e014496c9990be79492817c878a8758b35044e5cecedf670eeed33390fb42ab1d32e5d52b9873344ee88a3fc11942e4a7513a1e3adf66269d5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    crowdin-api (1.12.0)
+    crowdin-api (1.14.0)
       open-uri (>= 0.1.0, < 0.2.0)
       rest-client (>= 2.0.0, < 2.2.0)
 

data/README.md

@@ -35,7 +35,7 @@ Crowdin API is a full-featured RESTful API that helps you to integrate localizat
 Add this line to your application's Gemfile:
 
 ```gemfile
-gem 'crowdin-api', '~> 1.12.0'
+gem 'crowdin-api', '~> 1.14.0'
 ```
 
 And then execute:
@@ -134,6 +134,28 @@ file_revisions = crowdin.list_file_revisions(your_file_id, { limit: 10 }, your_p
 # Note: more examples you can find in spec folder
 ```
 
+### GraphQL API
+
+The client can send GraphQL requests to Crowdin's default API host or to an Enterprise organization endpoint.
+
+```ruby
+query = <<~GRAPHQL
+  query Viewer {
+    viewer {
+      id
+    }
+  }
+GRAPHQL
+
+response = crowdin.graphql({ query: query })
+```
+
+You can also provide a custom endpoint URL for testing.
+
+```ruby
+crowdin.graphql({ query: query }, url: 'http://localhost:3000/api/graphql')
+```
+
 ### Fetch all records
 
 There is a possibility to fetch all records from paginatable methods using `fetch_all` method.

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

@@ -7,7 +7,7 @@ module Crowdin
       # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.applications.api.get  API Documentation}
       def get_application_data(application_identifier = nil, path = nil)
         application_identifier || raise_parameter_is_required_error(:application_identifier)
-        application_identifier || raise_parameter_is_required_error(:path)
+        path || raise_parameter_is_required_error(:path)
 
         request = Web::Request.new(
           connection,
@@ -21,7 +21,7 @@ module Crowdin
       # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.applications.api.put  API Documentation}
       def update_or_restore_application_data(query = {}, application_identifier = nil, path = nil)
         application_identifier || raise_parameter_is_required_error(:application_identifier)
-        application_identifier || raise_parameter_is_required_error(:path)
+        path || raise_parameter_is_required_error(:path)
 
         request = Web::Request.new(
           connection,
@@ -36,7 +36,7 @@ module Crowdin
       # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.applications.api.put  API Documentation}
       def add_application_data(query = {}, application_identifier = nil, path = nil)
         application_identifier || raise_parameter_is_required_error(:application_identifier)
-        application_identifier || raise_parameter_is_required_error(:path)
+        path || raise_parameter_is_required_error(:path)
 
         request = Web::Request.new(
           connection,
@@ -51,7 +51,7 @@ module Crowdin
       # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.applications.api.delete  API Documentation}
       def delete_application_data(query = {}, application_identifier = nil, path = nil)
         application_identifier || raise_parameter_is_required_error(:application_identifier)
-        application_identifier || raise_parameter_is_required_error(:path)
+        path || raise_parameter_is_required_error(:path)
 
         request = Web::Request.new(
           connection,
@@ -66,7 +66,7 @@ module Crowdin
       # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.applications.api.patch  API Documentation}
       def edit_application_data(query = {}, application_identifier = nil, path = nil)
         application_identifier || raise_parameter_is_required_error(:application_identifier)
-        application_identifier || raise_parameter_is_required_error(:path)
+        path || raise_parameter_is_required_error(:path)
 
         request = Web::Request.new(
           connection,

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

@@ -3,6 +3,9 @@
 module Crowdin
   module ApiResources
     module Dictionaries
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Dictionaries/operation/api.projects.dictionaries.getMany  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Dictionaries/operation/api.projects.dictionaries.getMany  Enterprise API Documentation}
       def list_dictionaries(query = {}, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
@@ -15,6 +18,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param language_id [String] Language Identifier
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Dictionaries/operation/api.projects.dictionaries.patch  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Dictionaries/operation/api.projects.dictionaries.patch  Enterprise API Documentation}
       def edit_dictionary(language_id = nil, query = {}, project_id = config.project_id)
         language_id || raise_parameter_is_required_error(:language_id)
         project_id  || raise_project_id_is_required_error

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

@@ -3,6 +3,9 @@
 module Crowdin
   module ApiResources
     module Distributions
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Distributions/operation/api.projects.distributions.getMany  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Distributions/operation/api.projects.distributions.getMany  Enterprise API Documentation}
       def list_distributions(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://support.crowdin.com/developer/api/v2/#tag/Distributions/operation/api.projects.distributions.post  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Distributions/operation/api.projects.distributions.post  Enterprise API Documentation}
       def add_distribution(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 hash [String] Hash
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Distributions/operation/api.projects.distributions.get  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Distributions/operation/api.projects.distributions.get  Enterprise API Documentation}
       def get_distribution(hash = nil, project_id = config.project_id)
         hash       || raise_parameter_is_required_error(:hash)
         project_id || raise_project_id_is_required_error
@@ -39,6 +48,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param hash [String] Hash
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Distributions/operation/api.projects.distributions.delete  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Distributions/operation/api.projects.distributions.delete  Enterprise API Documentation}
       def delete_distribution(hash = nil, project_id = config.project_id)
         hash       || raise_parameter_is_required_error(:hash)
         project_id || raise_project_id_is_required_error
@@ -51,6 +63,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param hash [String] Hash
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Distributions/operation/api.projects.distributions.patch  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Distributions/operation/api.projects.distributions.patch  Enterprise API Documentation}
       def edit_distribution(hash = nil, query = {}, project_id = config.project_id)
         hash       || raise_parameter_is_required_error(:hash)
         project_id || raise_project_id_is_required_error
@@ -64,6 +80,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param hash [String] Hash
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Distributions/operation/api.projects.distributions.release.get  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Distributions/operation/api.projects.distributions.release.get  Enterprise API Documentation}
       def get_distribution_release(hash = nil, project_id = config.project_id)
         hash       || raise_parameter_is_required_error(:hash)
         project_id || raise_project_id_is_required_error
@@ -76,6 +95,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param hash [String] Hash
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Distributions/operation/api.projects.distributions.release.post  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Distributions/operation/api.projects.distributions.release.post  Enterprise API Documentation}
       def release_distribution(hash = nil, project_id = config.project_id)
         hash       || raise_parameter_is_required_error(:hash)
         project_id || raise_project_id_is_required_error

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

@@ -3,6 +3,9 @@
 module Crowdin
   module ApiResources
     module Glossaries
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.getMany  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.getMany  Enterprise API Documentation}
       def list_glossaries(query = {})
         request = Web::Request.new(
           connection,
@@ -13,6 +16,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.post  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.post  Enterprise API Documentation}
       def add_glossary(query = {})
         request = Web::Request.new(
           connection,
@@ -23,6 +29,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param glossary_id [Integer] Glossary Identifier
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.get  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.get  Enterprise API Documentation}
       def get_glossary(glossary_id = nil, query = {})
         glossary_id || raise_parameter_is_required_error(:glossary_id)
 
@@ -35,6 +45,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param glossary_id [Integer] Glossary Identifier
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.delete  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.delete  Enterprise API Documentation}
       def delete_glossary(glossary_id = nil)
         glossary_id || raise_parameter_is_required_error(:glossary_id)
 
@@ -46,6 +59,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param glossary_id [Integer] Glossary Identifier
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.patch  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.patch  Enterprise API Documentation}
       def edit_glossary(glossary_id = nil, query = {})
         glossary_id || raise_parameter_is_required_error(:glossary_id)
 
@@ -58,6 +75,11 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param query [Hash] Request Body
+      # @param glossary_id [Integer] Glossary Identifier
+      # @param destination [String] File destination
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.exports.post  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.exports.post  Enterprise API Documentation}
       def export_glossary(query = {}, glossary_id = nil, destination = nil)
         glossary_id || raise_parameter_is_required_error(:glossary_id)
 
@@ -70,6 +92,10 @@ module Crowdin
         Web::SendRequest.new(request, destination).perform
       end
 
+      # @param glossary_id [Integer] Glossary Identifier
+      # @param export_id [String] Export Identifier, consists of 36 characters
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.exports.get  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.exports.get  Enterprise API Documentation}
       def check_glossary_export_status(glossary_id = nil, export_id = nil)
         glossary_id || raise_parameter_is_required_error(:glossary_id)
         export_id   || raise_parameter_is_required_error(:export_id)
@@ -82,6 +108,11 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param glossary_id [Integer] Glossary Identifier
+      # @param export_id [String] Export Identifier, consists of 36 characters
+      # @param destination [String] File destination
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.exports.download.download  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.exports.download.download  Enterprise API Documentation}
       def download_glossary(glossary_id = nil, export_id = nil, destination = nil)
         glossary_id || raise_parameter_is_required_error(:glossary_id)
         export_id   || raise_parameter_is_required_error(:export_id)
@@ -94,6 +125,10 @@ module Crowdin
         Web::SendRequest.new(request, destination).perform
       end
 
+      # @param glossary_id [Integer] Glossary Identifier
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.imports.post  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.imports.post  Enterprise API Documentation}
       def import_glossary(glossary_id = nil, query = {})
         glossary_id || raise_parameter_is_required_error(:glossary_id)
 
@@ -106,6 +141,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param glossary_id [Integer] Glossary Identifier
+      # @param import_id [String] Import Identifier, consists of 36 characters
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.imports.get  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.imports.get  Enterprise API Documentation}
       def check_glossary_import_status(glossary_id = nil, import_id = nil)
         glossary_id || raise_parameter_is_required_error(:glossary_id)
         import_id   || raise_parameter_is_required_error(:import_id)
@@ -118,6 +157,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param glossary_id [Integer] Glossary Identifier
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.terms.getMany  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.terms.getMany  Enterprise API Documentation}
       def list_terms(glossary_id = nil, query = {})
         glossary_id || raise_parameter_is_required_error(:glossary_id)
 
@@ -130,6 +173,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param glossary_id [Integer] Glossary Identifier
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.terms.post  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.terms.post  Enterprise API Documentation}
       def add_term(glossary_id = nil, query = {})
         glossary_id || raise_parameter_is_required_error(:glossary_id)
 
@@ -142,6 +189,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param glossary_id [Integer] Glossary Identifier
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.terms.deleteMany  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.terms.deleteMany  Enterprise API Documentation}
       def clear_glossary(glossary_id = nil, query = {})
         glossary_id || raise_parameter_is_required_error(:glossary_id)
 
@@ -158,6 +209,10 @@ module Crowdin
         e.message
       end
 
+      # @param glossary_id [Integer] Glossary Identifier
+      # @param term_id [Integer] Term Identifier
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.terms.get  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.terms.get  Enterprise API Documentation}
       def get_term(glossary_id = nil, term_id = nil)
         glossary_id || raise_parameter_is_required_error(:glossary_id)
         term_id     || raise_parameter_is_required_error(:term_id)
@@ -170,6 +225,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param glossary_id [Integer] Glossary Identifier
+      # @param term_id [Integer] Term Identifier
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.terms.delete  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.terms.delete  Enterprise API Documentation}
       def delete_term(glossary_id = nil, term_id = nil)
         glossary_id || raise_parameter_is_required_error(:glossary_id)
         term_id     || raise_parameter_is_required_error(:term_id)
@@ -182,6 +241,11 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param glossary_id [Integer] Glossary Identifier
+      # @param term_id [Integer] Term Identifier
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.terms.patch  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.terms.patch  Enterprise API Documentation}
       def edit_term(glossary_id = nil, term_id = nil, query = {})
         glossary_id || raise_parameter_is_required_error(:glossary_id)
         term_id     || raise_parameter_is_required_error(:term_id)
@@ -195,6 +259,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param glossary_id [Integer] Glossary Identifier
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.concepts.getMany  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.concepts.getMany  Enterprise API Documentation}
       def list_concepts(glossary_id = nil, query = {})
         glossary_id || raise_parameter_is_required_error(:glossary_id)
 
@@ -207,6 +275,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param glossary_id [Integer] Glossary Identifier
+      # @param concept_id [Integer] Concept Identifier
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.concepts.get  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.concepts.get  Enterprise API Documentation}
       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)
@@ -219,6 +291,11 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param glossary_id [Integer] Glossary Identifier
+      # @param concept_id [Integer] Concept Identifier
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.concepts.put  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.concepts.put  Enterprise API Documentation}
       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)
@@ -232,6 +309,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param glossary_id [Integer] Glossary Identifier
+      # @param concept_id [Integer] Concept Identifier
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.glossaries.concepts.delete  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.glossaries.concepts.delete  Enterprise API Documentation}
       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)
@@ -244,6 +325,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param project_id [Integer] Project Identifier
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Glossaries/operation/api.projects.glossaries.concordance.post  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Glossaries/operation/api.projects.glossaries.concordance.post  Enterprise API Documentation}
       def search_glossaries_concordance(project_id = nil, query = {})
         project_id || raise_project_id_is_required_error
 

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module StringCorrections
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/String-Corrections/operation/api.projects.corrections.getMany Enterprise API Documentation}
+      def list_corrections(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}/corrections",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/String-Corrections/operation/api.projects.corrections.post Enterprise API Documentation}
+      def add_correction(body = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/corrections",
+          { params: body }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/String-Corrections/operation/api.projects.corrections.get Enterprise API Documentation}
+      def get_correction(correction_id = nil, query = {}, project_id = config.project_id)
+        correction_id || raise_parameter_is_required_error(:correction_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/corrections/#{correction_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/String-Corrections/operation/api.projects.corrections.deleteMany Enterprise API Documentation}
+      def delete_corrections(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/corrections",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/String-Corrections/operation/api.projects.corrections.delete Enterprise API Documentation}
+      def delete_correction(correction_id = nil, project_id = config.project_id)
+        correction_id || raise_parameter_is_required_error(:correction_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/corrections/#{correction_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/String-Corrections/operation/api.projects.corrections.put Enterprise API Documentation}
+      def restore_correction(correction_id = nil, project_id = config.project_id)
+        correction_id || raise_parameter_is_required_error(:correction_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :put,
+          "#{config.target_api_url}/projects/#{project_id}/corrections/#{correction_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

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

@@ -97,6 +97,82 @@ module Crowdin
         )
         Web::SendRequest.new(request).perform
       end
+
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Tasks/operation/api.projects.tasks.comments.getMany  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Tasks/operation/api.projects.tasks.comments.getMany  Enterprise API Documentation}
+      def list_task_comments(task_id = nil, query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+        task_id    || raise_parameter_is_required_error(:task_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/tasks/#{task_id}/comments",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Tasks/operation/api.projects.tasks.comments.get  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Tasks/operation/api.projects.tasks.comments.get  Enterprise API Documentation}
+      def get_task_comment(task_id = nil, comment_id = nil, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+        task_id    || raise_parameter_is_required_error(:task_id)
+        comment_id || raise_parameter_is_required_error(:comment_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/tasks/#{task_id}/comments/#{comment_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Tasks/operation/api.projects.tasks.comments.post  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Tasks/operation/api.projects.tasks.comments.post  Enterprise API Documentation}
+      def add_task_comment(task_id = nil, body = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+        task_id    || raise_parameter_is_required_error(:task_id)
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/tasks/#{task_id}/comments",
+          { params: body }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Tasks/operation/api.projects.tasks.comments.patch  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Tasks/operation/api.projects.tasks.comments.patch  Enterprise API Documentation}
+      def edit_task_comment(task_id = nil, comment_id = nil, body = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+        task_id    || raise_parameter_is_required_error(:task_id)
+        comment_id || raise_parameter_is_required_error(:comment_id)
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/tasks/#{task_id}/comments/#{comment_id}",
+          { params: body }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Tasks/operation/api.projects.tasks.comments.delete  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Tasks/operation/api.projects.tasks.comments.delete  Enterprise API Documentation}
+      def delete_task_comment(task_id = nil, comment_id = nil, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+        task_id    || raise_parameter_is_required_error(:task_id)
+        comment_id || raise_parameter_is_required_error(:comment_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/tasks/#{task_id}/comments/#{comment_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
     end
   end
 end

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

@@ -52,6 +52,20 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # * {https://support.crowdin.com/developer/api/v2/#tag/Translations/operation/api.projects.pre-translations.report.getReport  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#tag/Translations/operation/api.projects.pre-translations.report.getReport Enterprise API Documentation}
+      def pre_translation_report(pre_translation_id = nil, project_id = config.project_id)
+        pre_translation_id || raise_parameter_is_required_error(:pre_translation_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/pre-translations/#{pre_translation_id}/report"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
       def build_project_directory_translation(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

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

@@ -31,15 +31,10 @@ module Crowdin
     end
 
     include Web::FetchAllExtensions
+    include Web::GraphqlExtensions
 
-    # Config instance that includes configuration options for the Client
-    attr_reader :config
-    # Instance with established connection through RestClient to the Crowdin API
-    attr_reader :connection
-    # Instance with options and headers for RestClient connection
-    attr_reader :options
-    # Logger instance
-    attr_reader :logger
+    # Client configuration, connection, request options, and logger instances
+    attr_reader :config, :connection, :options, :logger
 
     def initialize(&block)
       build_configuration(&block)

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

@@ -2,6 +2,6 @@
 
 module Crowdin
   class Client
-    VERSION = '1.12.0'
+    VERSION = '1.14.0'
   end
 end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module Web
+    module GraphqlExtensions
+      def graphql(query = nil, **request_options)
+        url = request_options.delete(:url)
+        graphql_query = query || request_options
+
+        response = ::RestClient::Request.execute(
+          {
+            method: :post,
+            url: url || "#{config.base_url}/api/graphql",
+            payload: graphql_query.to_json
+          }.merge(options)
+        ) { |res, _, _| res }
+
+        response.body.empty? ? response.code : JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/crowdin-api.rb

@@ -6,7 +6,7 @@ module Crowdin
                              StringTranslations StringComments Screenshots Glossaries TranslationMemory
                              MachineTranslationEngines Reports Tasks Users Teams Vendors Webhooks
                              Dictionaries Distributions Labels TranslationStatus Bundles Notifications
-                             Applications].freeze
+                             Applications StringCorrections].freeze
 
   # Error Raisers modules
   ERROR_RAISERS_MODULES = %i[ApiErrorsRaiser ClientErrorsRaiser].freeze
@@ -23,6 +23,7 @@ require 'crowdin-api/core/errors_raisers'
 require 'crowdin-api/core/request'
 require 'crowdin-api/core/send_request'
 require 'crowdin-api/core/fetch_all_extensions'
+require 'crowdin-api/core/graphql_extensions'
 
 # API modules
 Crowdin::API_RESOURCES_MODULES.each do |api_resource|

data/spec/api_resources/string_corrections_spec.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::StringCorrections do
+  describe 'Default endpoints' do
+    let(:correction_id) { 35 }
+    let(:string_id) { 2 }
+
+    describe '#list_corrections' do
+      it 'when request is valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/corrections")
+          .with(query: { stringId: string_id })
+        list_corrections = @crowdin.list_corrections({ stringId: string_id }, project_id)
+        expect(list_corrections).to eq(200)
+      end
+
+      it 'when request is valid', :default do
+        query = { stringId: string_id, limit: 50, offset: 10, orderBy: 'createdAt desc', denormalizePlaceholders: 1 }
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/corrections")
+          .with(query: query)
+        list_corrections = @crowdin.list_corrections(query, project_id)
+        expect(list_corrections).to eq(200)
+      end
+    end
+
+    describe '#add_correction' do
+      it 'when request is valid', :default do
+        body = { stringId: 35_434, text: 'This string has been corrected', pluralCategoryName: 'few' }
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/corrections")
+          .with(body: body)
+        add_correction = @crowdin.add_correction(body, project_id)
+        expect(add_correction).to eq(200)
+      end
+
+      it 'when request is valid', :default do
+        body = { stringId: 35_434, text: 'This string has been corrected' }
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/corrections")
+          .with(body: body)
+        add_correction = @crowdin.add_correction(body, project_id)
+        expect(add_correction).to eq(200)
+      end
+    end
+
+    describe '#get_correction' do
+      it 'when request is valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/corrections/#{correction_id}")
+        get_correction = @crowdin.get_correction(correction_id, {}, project_id)
+        expect(get_correction).to eq(200)
+      end
+
+      it 'when request is valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/corrections/#{correction_id}")
+          .with(query: { denormalizePlaceholders: 1 })
+        get_correction = @crowdin.get_correction(correction_id, { denormalizePlaceholders: 1 }, project_id)
+        expect(get_correction).to eq(200)
+      end
+    end
+
+    describe '#delete_corrections' do
+      it 'when request is valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/corrections")
+          .with(query: { stringId: string_id })
+        delete_corrections = @crowdin.delete_corrections({ stringId: string_id }, project_id)
+        expect(delete_corrections).to eq(200)
+      end
+    end
+
+    describe '#delete_correction' do
+      it 'when request is valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/corrections/#{correction_id}")
+        delete_correction = @crowdin.delete_correction(correction_id, project_id)
+        expect(delete_correction).to eq(200)
+      end
+    end
+
+    describe '#restore_correction' do
+      it 'when request is valid', :default do
+        stub_request(:put, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/corrections/#{correction_id}")
+        restore_correction = @crowdin.restore_correction(correction_id, project_id)
+        expect(restore_correction).to eq(200)
+      end
+    end
+  end
+end

data/spec/api_resources/tasks_spec.rb

@@ -76,4 +76,49 @@ describe Crowdin::ApiResources::Tasks do
       end
     end
   end
+
+  describe 'Task Comments endpoints' do
+    let(:task_id) { 1 }
+    let(:comment_id) { 101 }
+
+    describe '#list_task_comments' do
+      it 'when request is valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/tasks/#{task_id}/comments")
+        list_task_comments = @crowdin.list_task_comments(task_id, {}, project_id)
+        expect(list_task_comments).to eq(200)
+      end
+    end
+
+    describe '#get_task_comment' do
+      it 'when request is valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/tasks/#{task_id}/comments/#{comment_id}")
+        get_task_comment = @crowdin.get_task_comment(task_id, comment_id, project_id)
+        expect(get_task_comment).to eq(200)
+      end
+    end
+
+    describe '#add_task_comment' do
+      it 'when request is valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/tasks/#{task_id}/comments")
+        add_task_comment = @crowdin.add_task_comment(task_id, { text: 'New comment' }, project_id)
+        expect(add_task_comment).to eq(200)
+      end
+    end
+
+    describe '#edit_task_comment' do
+      it 'when request is valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/tasks/#{task_id}/comments/#{comment_id}")
+        edit_task_comment = @crowdin.edit_task_comment(task_id, comment_id, { text: 'Updated comment' }, project_id)
+        expect(edit_task_comment).to eq(200)
+      end
+    end
+
+    describe '#delete_task_comment' do
+      it 'when request is valid', :default do
+        stub_request(:delete, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/tasks/#{task_id}/comments/#{comment_id}")
+        delete_task_comment = @crowdin.delete_task_comment(task_id, comment_id, project_id)
+        expect(delete_task_comment).to eq(200)
+      end
+    end
+  end
 end

data/spec/api_resources/translations_spec.rb

@@ -38,6 +38,16 @@ describe Crowdin::ApiResources::Translations do
       end
     end
 
+    describe '#pre_translation_report' do
+      let(:pre_translation_id) { 1 }
+
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/pre-translations/#{pre_translation_id}/report")
+        pre_translation_report = @crowdin.pre_translation_report(pre_translation_id, project_id)
+        expect(pre_translation_report).to eq(200)
+      end
+    end
+
     describe '#build_project_directory_translation' do
       let(:directory_id) { 1 }
 

data/spec/unit/client_spec.rb

@@ -98,6 +98,53 @@ describe 'Crowdin Client' do
     end
   end
 
+  describe 'Crowdin Client graphql' do
+    let(:graphql_request) do
+      {
+        query: 'query Viewer { viewer { id } }',
+        operationName: 'Viewer',
+        variables: { projectId: 1, emptyValue: nil }
+      }
+    end
+    let(:graphql_response) { { 'data' => { 'viewer' => { 'id' => 1 } } } }
+
+    it 'posts to the default GraphQL endpoint', :default do
+      stub_request(:post, 'https://api.crowdin.com/api/graphql')
+        .with(body: graphql_request.to_json)
+        .to_return(body: graphql_response.to_json)
+
+      expect(@crowdin.graphql(graphql_request)).to eq(graphql_response)
+    end
+
+    it 'posts to the Enterprise GraphQL endpoint', :enterprise do
+      stub_request(:post, 'https://domain.api.crowdin.com/api/graphql')
+        .with(body: graphql_request.to_json)
+        .to_return(body: graphql_response.to_json)
+
+      expect(@crowdin.graphql(graphql_request)).to eq(graphql_response)
+    end
+
+    it 'supports a custom GraphQL endpoint URL', :default do
+      custom_url = 'http://localhost:3000/api/graphql'
+
+      stub_request(:post, custom_url)
+        .with(body: graphql_request.to_json)
+        .to_return(body: graphql_response.to_json)
+
+      expect(@crowdin.graphql(graphql_request, url: custom_url)).to eq(graphql_response)
+    end
+
+    it 'returns parsed GraphQL error responses', :default do
+      graphql_error_response = { 'errors' => [{ 'message' => 'Invalid query' }] }
+
+      stub_request(:post, 'https://api.crowdin.com/api/graphql')
+        .with(body: graphql_request.to_json)
+        .to_return(status: 400, body: graphql_error_response.to_json)
+
+      expect(@crowdin.graphql(graphql_request)).to eq(graphql_error_response)
+    end
+  end
+
   describe 'connection' do
     subject(:connection) { crowdin_client.connection }
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-api
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.14.0
 platform: ruby
 authors:
 - Crowdin
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open-uri
@@ -221,6 +220,7 @@ files:
 - lib/crowdin-api/api_resources/source_strings.rb
 - lib/crowdin-api/api_resources/storages.rb
 - lib/crowdin-api/api_resources/string_comments.rb
+- lib/crowdin-api/api_resources/string_corrections.rb
 - lib/crowdin-api/api_resources/string_translations.rb
 - lib/crowdin-api/api_resources/tasks.rb
 - lib/crowdin-api/api_resources/teams.rb
@@ -237,6 +237,7 @@ files:
 - lib/crowdin-api/core/errors.rb
 - lib/crowdin-api/core/errors_raisers.rb
 - lib/crowdin-api/core/fetch_all_extensions.rb
+- lib/crowdin-api/core/graphql_extensions.rb
 - lib/crowdin-api/core/request.rb
 - lib/crowdin-api/core/send_request.rb
 - spec/api_resources/applications_spec.rb
@@ -255,6 +256,7 @@ files:
 - spec/api_resources/source_strings_spec.rb
 - spec/api_resources/storages_spec.rb
 - spec/api_resources/string_comments_spec.rb
+- spec/api_resources/string_corrections_spec.rb
 - spec/api_resources/string_translations_spec.rb
 - spec/api_resources/tasks_spec.rb
 - spec/api_resources/teams_spec.rb
@@ -271,7 +273,6 @@ homepage: https://github.com/crowdin/crowdin-api-client-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -286,8 +287,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby Client for the Crowdin API
 test_files: []