ruby-lokalise-api 2.9.0 → 4.0.0

data/lib/ruby-lokalise-api/resources/custom_translation_status.rb

@@ -4,7 +4,7 @@ module Lokalise
   module Resources
     class CustomTranslationStatus < Base
       ID_KEY = 'status'
-      supports :update, :destroy
+      supports :update, :destroy, [:reload_data, '', :find]
 
       class << self
         def colors(client, path, *_args)

data/lib/ruby-lokalise-api/resources/file.rb

@@ -9,7 +9,9 @@ module Lokalise
         end
 
         def upload(client, path, params)
-          post(path, client, params)['content']
+          klass = Lokalise::Resources::QueuedProcess
+          klass.new post(path, client, params),
+                    ->(project_id, id) { klass.endpoint(project_id, id) }
         end
 
         def endpoint(project_id, action = '')

data/lib/ruby-lokalise-api/resources/key.rb

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class Key < Base
-      supports :update, :destroy
+      supports :update, :destroy, [:reload_data, '', :find]
 
       class << self
         def endpoint(project_id, key_id = nil)

data/lib/ruby-lokalise-api/resources/key_comment.rb

@@ -5,7 +5,7 @@ module Lokalise
     class KeyComment < Base
       DATA_KEY = 'Comment'
       ID_KEY = 'comment'
-      supports :destroy
+      supports :destroy, [:reload_data, '', :find]
 
       class << self
         def endpoint(project_id, key_id, comment_id = nil)

data/lib/ruby-lokalise-api/resources/order.rb

@@ -3,6 +3,8 @@
 module Lokalise
   module Resources
     class Order < Base
+      supports [:reload_data, '', :find]
+
       class << self
         def endpoint(team_id, order_id = nil)
           path_from teams: team_id,

data/lib/ruby-lokalise-api/resources/payment_card.rb

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class PaymentCard < Base
-      supports :destroy
+      supports :destroy, [:reload_data, '', :find]
 
       class << self
         def endpoint(card_id = nil)

data/lib/ruby-lokalise-api/resources/project.rb

@@ -3,10 +3,10 @@
 module Lokalise
   module Resources
     class Project < Base
-      supports :update, :destroy
+      supports :update, :destroy, [:reload_data, '', :find]
 
       def empty
-        self.class.empty @client, @path + '/empty'
+        self.class.empty @client, "#{@path}/empty"
       end
 
       class << self

data/lib/ruby-lokalise-api/resources/project_language.rb

@@ -5,7 +5,7 @@ module Lokalise
     class ProjectLanguage < Base
       DATA_KEY = 'Language'
       ID_KEY = 'lang'
-      supports :update, :destroy
+      supports :update, :destroy, [:reload_data, '', :find]
 
       class << self
         def endpoint(project_id, language_id = nil)

data/lib/ruby-lokalise-api/resources/queued_process.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lokalise
+  module Resources
+    class QueuedProcess < Base
+      DATA_KEY = 'Process'
+      ID_KEY = 'process'
+      supports [:reload_data, '', :find]
+
+      class << self
+        def endpoint(project_id, process_id = nil)
+          path_from projects: project_id,
+                    processes: process_id
+        end
+      end
+    end
+  end
+end

data/lib/ruby-lokalise-api/resources/screenshot.rb

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class Screenshot < Base
-      supports :update, :destroy
+      supports :update, :destroy, [:reload_data, '', :find]
 
       class << self
         def endpoint(project_id, screenshot_id = nil)

data/lib/ruby-lokalise-api/resources/snapshot.rb

@@ -11,7 +11,9 @@ module Lokalise
 
       class << self
         def restore(client, path, *_args)
-          Lokalise::Resources::Project.new post(path, client)
+          klass = Lokalise::Resources::Project
+          klass.new post(path, client),
+                    ->(project_id, *_ids) { klass.endpoint(project_id) }
         end
 
         def endpoint(project_id, snapshot_id = nil)

data/lib/ruby-lokalise-api/resources/task.rb

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class Task < Base
-      supports :update, :destroy
+      supports :update, :destroy, [:reload_data, '', :find]
 
       class << self
         def endpoint(project_id, task_id = nil)

data/lib/ruby-lokalise-api/resources/team_user.rb

@@ -4,7 +4,7 @@ module Lokalise
   module Resources
     class TeamUser < Base
       ID_KEY = 'user'
-      supports :update, :destroy
+      supports :update, :destroy, [:reload_data, '', :find]
 
       class << self
         def endpoint(team_id, team_user_id = nil)

data/lib/ruby-lokalise-api/resources/team_user_group.rb

@@ -9,7 +9,8 @@ module Lokalise
                [:add_projects, '/projects/add', :update],
                [:remove_projects, '/projects/remove', :update],
                [:add_users, '/members/add', :update],
-               [:remove_users, '/members/remove', :update]
+               [:remove_users, '/members/remove', :update],
+               [:reload_data, '', :find]
 
       class << self
         def endpoint(team_id, team_user_group_id = nil, *actions)

data/lib/ruby-lokalise-api/resources/translation.rb

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class Translation < Base
-      supports :update
+      supports :update, [:reload_data, '', :find]
 
       class << self
         def endpoint(project_id, translation_id = nil)

data/lib/ruby-lokalise-api/resources/translation_provider.rb

@@ -3,6 +3,9 @@
 module Lokalise
   module Resources
     class TranslationProvider < Base
+      supports [:reload_data, '', :find]
+      ID_KEY = 'provider'
+
       class << self
         def endpoint(team_id, provider_id = nil)
           path_from teams: team_id,

data/lib/ruby-lokalise-api/resources/webhook.rb

@@ -3,12 +3,20 @@
 module Lokalise
   module Resources
     class Webhook < Base
-      supports :update, :destroy
+      supports :update, :destroy, [:reload_data, '', :find]
+
+      def regenerate_secret
+        self.class.regenerate_secret @client, "#{@path}/secret/regenerate"
+      end
 
       class << self
-        def endpoint(project_id, webhook_id = nil)
+        def regenerate_secret(client, path, *_args)
+          patch(path, client)['content']
+        end
+
+        def endpoint(project_id, webhook_id = nil, *actions)
           path_from projects: project_id,
-                    webhooks: webhook_id
+                    webhooks: [webhook_id, *actions]
         end
       end
     end

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

@@ -4,7 +4,7 @@ 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]
@@ -15,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]
@@ -25,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]
@@ -36,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]
@@ -47,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

@@ -4,7 +4,7 @@ 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]
@@ -14,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]
@@ -24,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>]
@@ -34,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]
@@ -45,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

@@ -4,7 +4,7 @@ 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]
@@ -14,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]
@@ -24,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
@@ -34,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]
@@ -45,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]
@@ -55,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

@@ -4,7 +4,7 @@ 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]
@@ -14,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]
@@ -24,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

@@ -4,7 +4,7 @@ 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]
@@ -14,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]
@@ -25,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>]
@@ -35,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]
@@ -46,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>]
@@ -56,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]
@@ -66,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

@@ -4,7 +4,7 @@ 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 = {})
@@ -13,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]
@@ -23,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]
@@ -33,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]
@@ -43,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]
@@ -54,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]