crowdin-api 1.14.0 → 1.15.1

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

@@ -3,6 +3,9 @@
 module Crowdin
   module ApiResources
     module Languages
+      # @param query [Hash] Request Query Parameters
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.languages.getMany  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.languages.getMany  Enterprise API Documentation}
       def list_languages(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/#operation/api.languages.post  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.languages.post  Enterprise API Documentation}
       def add_custom_language(query = {})
         request = Web::Request.new(
           connection,
@@ -23,6 +29,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param language_id [String] Language Identifier
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.languages.get  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.languages.get  Enterprise API Documentation}
       def get_language(language_id = nil)
         language_id || raise_parameter_is_required_error(:language_id)
 
@@ -34,6 +43,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param language_id [String] Language Identifier
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.languages.delete  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.languages.delete  Enterprise API Documentation}
       def delete_custom_language(language_id = nil)
         language_id || raise_parameter_is_required_error(:language_id)
 
@@ -45,6 +57,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/#operation/api.languages.patch  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.languages.patch  Enterprise API Documentation}
       def edit_custom_language(language_id = nil, query = {})
         language_id || raise_parameter_is_required_error(:language_id)
 

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

@@ -3,6 +3,9 @@
 module Crowdin
   module ApiResources
     module MachineTranslationEngines
+      # @param query [Hash] Request Query Parameters
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.mts.getMany  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.mts.getMany  Enterprise API Documentation}
       def list_mts(query = {})
         request = Web::Request.new(
           connection,
@@ -13,6 +16,9 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param mt_id [Integer] Machine Translation engine identifier
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.mts.get  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.mts.get  Enterprise API Documentation}
       def get_mt(mt_id = nil)
         mt_id || raise_parameter_is_required_error(:mt_id)
 
@@ -24,6 +30,10 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param mt_id [Integer] Machine Translation engine identifier
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.mts.translations.post  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.mts.translations.post  Enterprise API Documentation}
       def translate_via_mt(mt_id = nil, query = {})
         mt_id || raise_parameter_is_required_error(:mt_id)
 
@@ -38,6 +48,9 @@ module Crowdin
 
       # -- For Enterprise mode only --
 
+      # @param mt_id [Integer] Machine Translation engine identifier
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.mts.patch  Enterprise API Documentation}
       def edit_mt(mt_id = nil, query = {})
         enterprise_mode? || raise_only_for_enterprise_mode_error
         mt_id            || raise_parameter_is_required_error(:mt_id)
@@ -51,6 +64,8 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.mts.post  Enterprise API Documentation}
       def add_mt(query = {})
         enterprise_mode? || raise_only_for_enterprise_mode_error
 
@@ -63,6 +78,8 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
+      # @param mt_id [Integer] Machine Translation engine identifier
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.mts.delete  Enterprise API Documentation}
       def delete_mt(mt_id = nil)
         enterprise_mode? || raise_only_for_enterprise_mode_error
         mt_id            || raise_parameter_is_required_error(:mt_id)

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

@@ -3,6 +3,8 @@
 module Crowdin
   module ApiResources
     module Notifications
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.notify.post  API Documentation}
       def send_notification_to_authenticated_user(query = {})
         %i[message].each do |param|
           query[param] || raise_parameter_is_required_error(param)
@@ -17,8 +19,11 @@ module Crowdin
         Web::SendRequest.new(request).perform
       end
 
-      def send_notification_to_organization_members(query = {})
-        enterprise_mode? || raise_only_for_enterprise_mode_error
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.projects.notify.post  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.notify.post  Enterprise API Documentation}
+      def send_notifications_to_project_members(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
 
         %i[message].each do |param|
           query[param] || raise_parameter_is_required_error(param)
@@ -27,14 +32,18 @@ module Crowdin
         request = Web::Request.new(
           connection,
           :post,
-          "#{config.target_api_url}/notify",
+          "#{config.target_api_url}/projects/#{project_id}/notify",
           { params: query }
         )
         Web::SendRequest.new(request).perform
       end
 
-      def send_notifications_to_project_members(query = {}, project_id = config.project_id)
-        project_id || raise_project_id_is_required_error
+      # -- For Enterprise mode only --
+
+      # @param query [Hash] Request Body
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.notify.post  Enterprise API Documentation}
+      def send_notification_to_organization_members(query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
 
         %i[message].each do |param|
           query[param] || raise_parameter_is_required_error(param)
@@ -43,7 +52,7 @@ module Crowdin
         request = Web::Request.new(
           connection,
           :post,
-          "#{config.target_api_url}/projects/#{project_id}/notify",
+          "#{config.target_api_url}/notify",
           { params: query }
         )
         Web::SendRequest.new(request).perform

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Organization
+      # -- For Enterprise mode only --
+
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.organization.get  Enterprise API Documentation}
+      def get_organization_info
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/organization"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.organization.auth-settings.get  Enterprise API Documentation}
+      def get_organization_authentication_settings
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/organization/auth-settings"
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module OrganizationWebhooks
+      # @param query [Hash] Request Query Parameters
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.webhooks.getMany  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.webhooks.getMany  Enterprise API Documentation}
+      def list_organization_webhooks(query = {})
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/webhooks",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param body [Hash] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.webhooks.post  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.webhooks.post  Enterprise API Documentation}
+      def add_organization_webhook(body = {})
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/webhooks",
+          { params: body }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param organization_webhook_id [Integer] Webhook Identifier
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.webhooks.delete  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.webhooks.delete  Enterprise API Documentation}
+      def delete_organization_webhook(organization_webhook_id)
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/webhooks/#{organization_webhook_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param organization_webhook_id [Integer] Webhook Identifier
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.webhooks.get  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.webhooks.get  Enterprise API Documentation}
+      def get_organization_webhook(organization_webhook_id)
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/webhooks/#{organization_webhook_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param organization_webhook_id [Integer] Webhook Identifier
+      # @param body [Array] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.webhooks.patch  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.webhooks.patch  Enterprise API Documentation}
+      def edit_organization_webhook(organization_webhook_id, body = [])
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/webhooks/#{organization_webhook_id}",
+          { params: body }
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Placeholders
+      # @param query [Hash] Request Query Parameters
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.projects.system-placeholders.getMany  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.system-placeholders.getMany  Enterprise API Documentation}
+      def list_project_system_placeholders(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}/system-placeholders",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param body [Array] Request Body
+      # * {https://support.crowdin.com/developer/api/v2/#operation/api.projects.system-placeholders.batchPatch  API Documentation}
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.system-placeholders.batchPatch  Enterprise API Documentation}
+      def project_system_placeholder_batch_operations(body = [], project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/system-placeholders",
+          { params: body }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # -- For Enterprise mode only --
+
+      # @param query [Hash] Request Query Parameters
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.custom-placeholders.getMany  Enterprise API Documentation}
+      def list_custom_placeholders(query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/custom-placeholders",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param body [Hash] Request Body
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.custom-placeholders.post  Enterprise API Documentation}
+      def add_custom_placeholder(body = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/custom-placeholders",
+          { params: body }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param custom_placeholder_id [Integer] Custom Placeholder identifier
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.custom-placeholders.delete  Enterprise API Documentation}
+      def delete_custom_placeholder(custom_placeholder_id)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/custom-placeholders/#{custom_placeholder_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param custom_placeholder_id [Integer] Custom Placeholder identifier
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.custom-placeholders.get  Enterprise API Documentation}
+      def get_custom_placeholder(custom_placeholder_id)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/custom-placeholders/#{custom_placeholder_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param custom_placeholder_id [Integer] Custom Placeholder identifier
+      # @param body [Array] Request Body
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.custom-placeholders.patch  Enterprise API Documentation}
+      def edit_custom_placeholder(custom_placeholder_id, body = [])
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/custom-placeholders/#{custom_placeholder_id}",
+          { params: body }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param query [Hash] Request Query Parameters
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.placeholders.getMany  Enterprise API Documentation}
+      def list_project_placeholders(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}/placeholders",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param body [Hash] Request Body
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.placeholders.post  Enterprise API Documentation}
+      def add_project_placeholder(body = {}, 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,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/placeholders",
+          { params: body }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param project_placeholder_id [Integer] Project Placeholder identifier
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.placeholders.delete  Enterprise API Documentation}
+      def delete_project_placeholder(project_placeholder_id, 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,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/placeholders/#{project_placeholder_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param project_placeholder_id [Integer] Project Placeholder identifier
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.placeholders.get  Enterprise API Documentation}
+      def get_project_placeholder(project_placeholder_id, 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}/placeholders/#{project_placeholder_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param project_placeholder_id [Integer] Project Placeholder identifier
+      # @param body [Array] Request Body
+      # * {https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.placeholders.patch  Enterprise API Documentation}
+      def edit_project_placeholder(project_placeholder_id, body = [], 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,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/placeholders/#{project_placeholder_id}",
+          { params: body }
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end