ruby-lokalise-api 2.8.0 → 3.1.0

data/lib/ruby-lokalise-api/rest/branches.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all branches for the given project

data/lib/ruby-lokalise-api/rest/comments.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns a single comment for the given key
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-comment-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-comment-get
     # @return [Lokalise::Resources::Comment]
     # @param project_id [String]
     # @param key_id [String, Integer]
@@ -13,7 +15,7 @@ module Lokalise
 
     # Returns all comments for all keys inside the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-project-comments-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-project-comments-get
     # @return [Lokalise::Collection::Comment<Lokalise::Resources::Comment>]
     # @param project_id [String]
     # @param params [Hash]
@@ -23,7 +25,7 @@ module Lokalise
 
     # Returns all comments for the given key inside the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-key-comments-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-key-comments-get
     # @return [Lokalise::Collection::Comment<Lokalise::Resources::Comment>]
     # @param project_id [String]
     # @param key_id [String, Integer]
@@ -34,7 +36,7 @@ module Lokalise
 
     # Creates one or more comments for the given key inside the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-create-comments-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-create-comments-post
     # @return [Lokalise::Collection::Comment<Lokalise::Resources::Comment>]
     # @param project_id [String]
     # @param key_id [String, Integer]
@@ -45,7 +47,7 @@ module Lokalise
 
     # Deletes comment for the given key inside the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-comment-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-comment-delete
     # @return [Hash]
     # @param project_id [String]
     # @param key_id [String, Integer]

data/lib/ruby-lokalise-api/rest/contributors.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all contributors for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-contributors-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-contributors-get
     # @return [Lokalise::Collection::Contributor<Lokalise::Resources::Contributor>]
     # @param project_id [String]
     # @param params [Hash]
@@ -12,7 +14,7 @@ module Lokalise
 
     # Returns a single contributor for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-contributor-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-contributor-get
     # @return [Lokalise::Resources::Contributor]
     # @param project_id [String]
     # @param contributor_id [String, Integer]
@@ -22,7 +24,7 @@ module Lokalise
 
     # Creates one or more contributors inside the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-create-contributors-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-create-contributors-post
     # @return [Lokalise::Collection::Contributor<Lokalise::Resources::Contributor>]
     # @param project_id [String]
     # @param params [Hash, Array<Hash>]
@@ -32,7 +34,7 @@ module Lokalise
 
     # Updates the given contributor inside the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-contributor-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-contributor-put
     # @return [Lokalise::Resources::Contributor]
     # @param project_id [String]
     # @param contributor_id [String, Integer]
@@ -43,7 +45,7 @@ module Lokalise
 
     # Deletes contributor inside the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-contributor-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-contributor-delete
     # @return [Hash]
     # @param project_id [String]
     # @param contributor_id [String, Integer]

data/lib/ruby-lokalise-api/rest/custom_translation_statuses.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all translation statuses for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-custom-translation-statuses-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-custom-translation-statuses-get
     # @return [Lokalise::Collection::CustomTranslationStatus<Lokalise::Resources::CustomTranslationStatus>]
     # @param project_id [String]
     # @param params [Hash]
@@ -12,7 +14,7 @@ module Lokalise
 
     # Returns a single translation status for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-custom-translation-status-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-custom-translation-status-get
     # @return [Lokalise::Resources::CustomTranslationStatus]
     # @param project_id [String]
     # @param status_id [String, Integer]
@@ -22,7 +24,7 @@ module Lokalise
 
     # Creates translation status inside the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-create-a-custom-translation-status-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-create-a-custom-translation-status-post
     # @return Lokalise::Resources::CustomTranslationStatus
     # @param project_id [String]
     # @param params Hash
@@ -32,7 +34,7 @@ module Lokalise
 
     # Updates the given translation status inside the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-custom-translation-status-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-custom-translation-status-put
     # @return [Lokalise::Resources::CustomTranslationStatus]
     # @param project_id [String]
     # @param status_id [String, Integer]
@@ -43,7 +45,7 @@ module Lokalise
 
     # Deletes translation status inside the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-custom-translation-status-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-custom-translation-status-delete
     # @return [Hash]
     # @param project_id [String]
     # @param status_id [String, Integer]
@@ -53,7 +55,7 @@ module Lokalise
 
     # Returns an array of available colors that can be assigned to custom translation statuses
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-available-colors-for-custom-translation-statuses-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-available-colors-for-custom-translation-statuses-get
     # @return [Array]
     # @param project_id [String]
     def translation_status_colors(project_id)

data/lib/ruby-lokalise-api/rest/files.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all translation files for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-files-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-files-get
     # @return [Lokalise::Collection::File<Lokalise::Resources::File>]
     # @param project_id [String]
     # @param params [Hash]
@@ -12,7 +14,7 @@ module Lokalise
 
     # Exports translation files as .zip bundle, uploads them to Amazon S3 and returns a URL to the generated bundle. The URL is valid for a year
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-download-files-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-download-files-post
     # @return [Hash]
     # @param project_id [String]
     # @param params [Hash]
@@ -22,7 +24,7 @@ module Lokalise
 
     # Imports translation file to the given project. File data must base64-encoded
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-upload-a-file-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-upload-a-file-post
     # @return [Hash]
     # @param project_id [String]
     # @param params [Hash]

data/lib/ruby-lokalise-api/rest/keys.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all translation keys for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-keys-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-keys-get
     # @return [Lokalise::Collection::Key<Lokalise::Resources::Key>]
     # @param project_id [String]
     # @param params [Hash]
@@ -12,7 +14,7 @@ module Lokalise
 
     # Returns a single translation key for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-key-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-key-get
     # @return [Lokalise::Resources::Key]
     # @param project_id [String]
     # @param key_id [String, Integer]
@@ -23,7 +25,7 @@ module Lokalise
 
     # Creates one or more translation keys for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-create-keys-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-create-keys-post
     # @return [Lokalise::Collection::Key<Lokalise::Resources::Key>]
     # @param project_id [String]
     # @param params [Hash, Array<Hash>]
@@ -33,7 +35,7 @@ module Lokalise
 
     # Updates translation key for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-key-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-key-put
     # @return [Lokalise::Resources::Key]
     # @param project_id [String]
     # @param key_id [String, Integer]
@@ -44,7 +46,7 @@ module Lokalise
 
     # Updates one or multiple translation keys for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-bulk-update-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-bulk-update-put
     # @return [Lokalise::Collection::Key<Lokalise::Resources::Key>]
     # @param project_id [String]
     # @param params [Hash, Array<Hash>]
@@ -54,7 +56,7 @@ module Lokalise
 
     # Deletes translation key for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-key-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-key-delete
     # @return [Hash]
     # @param project_id [String]
     # @param key_id [String, Integer]
@@ -64,7 +66,7 @@ module Lokalise
 
     # Deletes one or multiple translation keys for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-multiple-keys-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-multiple-keys-delete
     # @return [Hash]
     # @param project_id [String]
     # @param key_ids [String, Integer, Array<String>, Array<Integer>]

data/lib/ruby-lokalise-api/rest/languages.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all languages supported by Lokalise
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-system-languages-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-system-languages-get
     # @return [Lokalise::Collection::SystemLanguage<Lokalise::Resources::SystemLanguage>]
     # @param params [Hash]
     def system_languages(params = {})
@@ -11,7 +13,7 @@ module Lokalise
 
     # Returns all languages for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-project-languages-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-project-languages-get
     # @return [Lokalise::Collection::ProjectLanguage<Lokalise::Resources::ProjectLanguage>]
     # @param project_id [String, Integer]
     # @param params [Hash]
@@ -21,7 +23,7 @@ module Lokalise
 
     # Returns a single language for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-language-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-language-get
     # @return [Lokalise::Resources::ProjectLanguage]
     # @param project_id [String]
     # @param language_id [String, Integer]
@@ -31,7 +33,7 @@ module Lokalise
 
     # Creates one or more language for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-language-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-language-get
     # @return [Lokalise::Collection::ProjectLanguage<Lokalise::Resources::ProjectLanguage>]
     # @param project_id [String]
     # @param params [Hash]
@@ -41,7 +43,7 @@ module Lokalise
 
     # Updates language for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-language-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-language-put
     # @return [Lokalise::Resources::ProjectLanguage]
     # @param project_id [String]
     # @param language_id [String, Integer]
@@ -52,7 +54,7 @@ module Lokalise
 
     # Deletes language for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-language-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-language-delete
     # @return [Hash]
     # @param project_id [String]
     # @param language_id [String, Integer]

data/lib/ruby-lokalise-api/rest/orders.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all orders for the given team

data/lib/ruby-lokalise-api/rest/payment_cards.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all payment cards available to the user authorized with the API token
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-cards-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-cards-get
     # @return [Lokalise::Collection::PaymentCard<Lokalise::Resources::PaymentCard>]
     # @param params [Hash]
     def payment_cards(params = {})
@@ -11,7 +13,7 @@ module Lokalise
 
     # Returns a single payment card
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-card-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-card-get
     # @return [Lokalise::Resources::PaymentCard]
     # @param card_id [String, Integer]
     def payment_card(card_id)
@@ -29,7 +31,7 @@ module Lokalise
 
     # Deletes the payment card
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-card-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-card-delete
     # @return [Hash]
     # @param card_id [String, Integer]
     def destroy_payment_card(card_id)

data/lib/ruby-lokalise-api/rest/projects.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all projects available to the user authorized with the API token
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-projects-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-projects-get
     # @return [Lokalise::Collection::Project<Lokalise::Resources::Project>]
     # @param params [Hash]
     def projects(params = {})
@@ -11,7 +13,7 @@ module Lokalise
 
     # Returns a single project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-project-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-project-get
     # @return [Lokalise::Resources::Project]
     # @param project_id [String, Integer]
     def project(project_id)
@@ -20,7 +22,7 @@ module Lokalise
 
     # Creates project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-create-a-project-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-create-a-project-post
     # @return [Lokalise::Resources::Project]
     # @param params [Hash]
     def create_project(params)
@@ -29,7 +31,7 @@ module Lokalise
 
     # Updates project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-project-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-project-put
     # @return [Lokalise::Resources::Project]
     # @param project_id [String, Integer]
     # @param params [Hash]
@@ -39,7 +41,7 @@ module Lokalise
 
     # Deletes all keys and translations from the project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-empty-a-project-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-empty-a-project-put
     # @return [Hash]
     # @param project_id [String, Integer]
     def empty_project(project_id)
@@ -48,7 +50,7 @@ module Lokalise
 
     # Deletes the project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-project-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-project-delete
     # @return [Hash]
     # @param project_id [String, Integer]
     def destroy_project(project_id)

data/lib/ruby-lokalise-api/rest/queued_processes.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Lokalise
+  class Client
+    # Returns all queued processes for the given project
+    #
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-processes-get
+    # @return [Lokalise::Collection::QueuedProcess<Lokalise::Resources::QueuedProcess>]
+    # @param project_id [String]
+    # @param params [Hash]
+    def queued_processes(project_id, params = {})
+      c_r Lokalise::Collections::QueuedProcess, :all, project_id, params
+    end
+
+    # Returns a queued process for the given project
+    #
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-process-get
+    # @return [Lokalise::Resources::QueuedProcess]
+    # @param project_id [String]
+    # @param process_id [String]
+    def queued_process(project_id, process_id)
+      c_r Lokalise::Resources::QueuedProcess, :find,
+          [project_id, process_id]
+    end
+  end
+end

data/lib/ruby-lokalise-api/rest/screenshots.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Lokalise
   class Client
     # Returns all screenshots for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-screenshots-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-screenshots-get
     # @return [Lokalise::Collection::Screenshot<Lokalise::Resources::Screenshot>]
     # @param project_id [String]
     # @param params [Hash]
@@ -12,7 +14,7 @@ module Lokalise
 
     # Returns a single screenshot for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-screenshot-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-screenshot-get
     # @return [Lokalise::Resources::Screenshot]
     # @param project_id [String]
     # @param screenshot_id [String, Integer]
@@ -22,7 +24,7 @@ module Lokalise
 
     # Creates one or more screenshots for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-create-screenshots-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-create-screenshots-post
     # @return [Lokalise::Collection::Screenshot<Lokalise::Resources::Screenshot>]
     # @param project_id [String]
     # @param params [Hash]
@@ -32,7 +34,7 @@ module Lokalise
 
     # Updates screenshot
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-screenshot-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-screenshot-put
     # @return [Lokalise::Resources::Screenshot]
     # @param project_id [String]
     # @param screenshot_id [String, Integer]
@@ -43,7 +45,7 @@ module Lokalise
 
     # Deletes screenshot
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-screenshot-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-screenshot-delete
     # @return [Hash]
     # @param project_id [String]
     # @param screenshot_id [String, Integer]