crowdin-api 1.13.0 → 1.15.0

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

@@ -5,6 +5,8 @@ module Crowdin
     module Workflows
       # -- For Enterprise mode only --
 
+      # @param query [Hash] Request Query Parameters
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.workflow-steps.getMany  Enterprise API Documentation}
       def list_workflow_steps(query = {}, project_id = config.project_id)
         enterprise_mode? || raise_only_for_enterprise_mode_error
         project_id       || raise_project_id_is_required_error
@@ -18,6 +20,8 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param step_id [Integer] Workflow Step Identifier
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.workflow-steps.get  Enterprise API Documentation}
       def get_workflow_step(step_id = nil, project_id = config.project_id)
         enterprise_mode? || raise_only_for_enterprise_mode_error
         step_id          || raise_parameter_is_required_error(:step_id)
@@ -31,6 +35,8 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param query [Hash] Request Query Parameters
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.workflow-templates.getMany  Enterprise API Documentation}
       def list_workflow_templates(query = {})
         enterprise_mode? || raise_only_for_enterprise_mode_error
 
@@ -43,6 +49,8 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param template_id [Integer] Workflow Template Identifier
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.workflow-templates.get  Enterprise API Documentation}
       def get_workflow_template(template_id = nil)
         enterprise_mode? || raise_only_for_enterprise_mode_error
         template_id      || raise_parameter_is_required_error(:template_id)
@@ -54,6 +62,22 @@ module Crowdin
         )
         Web::SendRequest.new(request).perform
       end
+
+      # @param step_id [Integer] Workflow Step Identifier
+      # @param query [Hash] Request Query Parameters
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.workflow-steps.strings.getMany  Enterprise API Documentation}
+      def list_workflow_step_strings(step_id, query = {}, project_id = config.project_id)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/workflow-steps/#{step_id}/strings",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
     end
   end
 end

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.13.0'
+    VERSION = '1.15.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/core/request.rb

@@ -26,7 +26,7 @@ module Crowdin
       end
 
       def delete
-        connection.delete(prepare_payload(payload[:params]))
+        connection.delete(prepare_payload(payload[:params]).merge(payload[:headers]))
       end
 
       def process_with_body

data/lib/crowdin-api.rb

@@ -6,7 +6,9 @@ module Crowdin
                              StringTranslations StringComments Screenshots Glossaries TranslationMemory
                              MachineTranslationEngines Reports Tasks Users Teams Vendors Webhooks
                              Dictionaries Distributions Labels TranslationStatus Bundles Notifications
-                             Applications StringCorrections].freeze
+                             Applications StringCorrections Ai Advisor Integrations
+                             OrganizationWebhooks Placeholders SecurityLogs StyleGuides Clients CustomSpellcheckers
+                             ExternalQaChecks Fields Organization].freeze
 
   # Error Raisers modules
   ERROR_RAISERS_MODULES = %i[ApiErrorsRaiser ClientErrorsRaiser].freeze
@@ -23,6 +25,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/advisor_spec.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+describe Crowdin::ApiResources::Advisor do
+  describe 'Default endpoints' do
+    describe '#create_advisor_check' do
+      it 'when request are valid', :default do
+        stub_request(:post, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/advisors/checks")
+        result = @crowdin.create_advisor_check({}, project_id)
+        expect(result).to eq(200)
+      end
+    end
+
+    describe '#get_advisor_check_status' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/advisors/checks/1")
+        result = @crowdin.get_advisor_check_status(1, project_id)
+        expect(result).to eq(200)
+      end
+    end
+
+    describe '#list_advisor_insights' do
+      it 'when request are valid', :default do
+        stub_request(:get, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/advisors/insights")
+        result = @crowdin.list_advisor_insights({}, project_id)
+        expect(result).to eq(200)
+      end
+    end
+
+    describe '#edit_advisor_insight' do
+      it 'when request are valid', :default do
+        stub_request(:patch, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/advisors/insights/1")
+        result = @crowdin.edit_advisor_insight(1, [], project_id)
+        expect(result).to eq(200)
+      end
+    end
+
+    describe '#create_or_update_application_advisor_insight' do
+      it 'when request are valid', :default do
+        stub_request(:put, "https://api.crowdin.com/#{target_api_url}/projects/#{project_id}/applications/1/modules/1/advisors/insights")
+        result = @crowdin.create_or_update_application_advisor_insight(1, 1, {}, project_id)
+        expect(result).to eq(200)
+      end
+    end
+  end
+end