ruby-lokalise-api 2.9.0 → 4.0.0

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

@@ -4,7 +4,7 @@ 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 = {})
@@ -13,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)
@@ -31,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

@@ -4,7 +4,7 @@ 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 = {})
@@ -13,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)
@@ -22,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)
@@ -31,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]
@@ -41,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)
@@ -50,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

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

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

@@ -4,7 +4,7 @@ module Lokalise
   class Client
     # Returns all snapshots for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-snapshots-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-snapshots-get
     # @return [Lokalise::Collection::Snapshot<Lokalise::Resources::Snapshot>]
     # @param project_id [String]
     # @param params [Hash]
@@ -14,7 +14,7 @@ module Lokalise
 
     # Creates snapshot for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-create-a-snapshot-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-create-a-snapshot-post
     # @return [Lokalise::Resources::Snapshot]
     # @param project_id [String]
     # @param params [Hash]
@@ -24,7 +24,7 @@ module Lokalise
 
     # Restore project from the given snapshot by producing project's copy
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-restore-a-snapshot-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-restore-a-snapshot-post
     # @return [Lokalise::Resources::Project]
     # @param project_id [String]
     # @param snapshot_id [String, Integer]
@@ -34,7 +34,7 @@ module Lokalise
 
     # Deletes snapshot
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-snapshot-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-snapshot-delete
     # @return [Hash]
     # @param project_id [String]
     # @param snapshot_id [String, Integer]

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

@@ -4,7 +4,7 @@ module Lokalise
   class Client
     # Returns all tasks for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-tasks-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-tasks-get
     # @return [Lokalise::Collection::Task<Lokalise::Resources::Task>]
     # @param project_id [String]
     # @param params [Hash]
@@ -14,7 +14,7 @@ module Lokalise
 
     # Returns a single task for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-task-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-task-get
     # @return [Lokalise::Resources::Task]
     # @param project_id [String]
     # @param task_id [String, Integer]
@@ -24,7 +24,7 @@ module Lokalise
 
     # Creates task for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-create-a-task-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-create-a-task-post
     # @return [Lokalise::Resources::Task]
     # @param project_id [String]
     # @param params [Hash]
@@ -34,7 +34,7 @@ module Lokalise
 
     # Updates task for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-task-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-task-put
     # @return [Lokalise::Resources::Task]
     # @param project_id [String]
     # @param task_id [String, Integer]
@@ -45,7 +45,7 @@ module Lokalise
 
     # Deletes task for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-task-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-task-delete
     # @return [Hash]
     # @param project_id [String]
     # @param task_id [String, Integer]

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

@@ -62,7 +62,7 @@ module Lokalise
     def add_projects_to_group(team_id, group_id, project_ids)
       c_r Lokalise::Resources::TeamUserGroup, :update,
           [team_id, group_id, 'projects', 'add'],
-          project_ids, :projects
+          project_ids, :projects, [team_id, group_id]
     end
 
     # Removes projects from the given group
@@ -75,7 +75,7 @@ module Lokalise
     def remove_projects_from_group(team_id, group_id, project_ids)
       c_r Lokalise::Resources::TeamUserGroup, :update,
           [team_id, group_id, 'projects', 'remove'],
-          project_ids, :projects
+          project_ids, :projects, [team_id, group_id]
     end
 
     # Adds users to the given group
@@ -88,7 +88,7 @@ module Lokalise
     def add_users_to_group(team_id, group_id, users_ids)
       c_r Lokalise::Resources::TeamUserGroup, :update,
           [team_id, group_id, 'members', 'add'],
-          users_ids, :users
+          users_ids, :users, [team_id, group_id]
     end
 
     # Removes users from the given group
@@ -101,7 +101,7 @@ module Lokalise
     def remove_users_from_group(team_id, group_id, users_ids)
       c_r Lokalise::Resources::TeamUserGroup, :update,
           [team_id, group_id, 'members', 'remove'],
-          users_ids, :users
+          users_ids, :users, [team_id, group_id]
     end
   end
 end

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

@@ -4,7 +4,7 @@ module Lokalise
   class Client
     # Returns all team users for the given team
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-team-users-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-team-users-get
     # @return [Lokalise::Collection::TeamUser<Lokalise::Resources::TeamUser>]
     # @param team_id [String]
     # @param params [Hash]
@@ -14,7 +14,7 @@ module Lokalise
 
     # Returns team user from the given team
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-team-user-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-team-user-get
     # @return [Lokalise::Resources::TeamUser]
     # @param team_id [String]
     # @param user_id [String, Integer]
@@ -24,7 +24,7 @@ module Lokalise
 
     # Updates team user for the given team
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-team-user-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-team-user-put
     # @return [Lokalise::Resources::TeamUser]
     # @param team_id [String]
     # @param user_id [String, Integer]
@@ -35,7 +35,7 @@ module Lokalise
 
     # Deletes team user from the given team
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-team-user-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-team-user-delete
     # @return [Lokalise::Resources::TeamUser]
     # @param team_id [String]
     # @param user_id [String, Integer]

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

@@ -4,7 +4,7 @@ module Lokalise
   class Client
     # Returns all teams available to the user
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-teams-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-teams-get
     # @return [Lokalise::Collection::Team<Lokalise::Resources::Team>]
     # @param params [Hash]
     def teams(params = {})

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

@@ -4,7 +4,7 @@ module Lokalise
   class Client
     # Returns all translation providers for the given team
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-providers-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-providers-get
     # @return [Lokalise::Collection::TranslationProvider<Lokalise::Resources::TranslationProvider>]
     # @param team_id [String]
     # @param params [Hash]
@@ -14,7 +14,7 @@ module Lokalise
 
     # Returns a single translation provider for the given team
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-provider-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-provider-get
     # @return [Lokalise::Resources::TranslationProvider]
     # @param team_id [String]
     # @param provider_id [String, Integer]

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

@@ -4,7 +4,7 @@ module Lokalise
   class Client
     # Returns all translations for the given project (ungrouped)
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-translations-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-translations-get
     # @return [Lokalise::Collection::Translation<Lokalise::Resources::Translation>]
     # @param project_id [String]
     # @param params [Hash]
@@ -14,7 +14,7 @@ module Lokalise
 
     # Returns translation of the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-translation-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-translation-get
     # @return [Lokalise::Resources::Translation]
     # @param project_id [String]
     # @param translation_id [String, Integer]
@@ -25,7 +25,7 @@ module Lokalise
 
     # Updates translation of the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-translation-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-translation-put
     # @return [Lokalise::Resources::Translation]
     # @param project_id [String]
     # @param translation_id [String, Integer]

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

@@ -4,7 +4,7 @@ module Lokalise
   class Client
     # Returns all webhooks for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-webhooks-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-webhooks-get
     # @return [Lokalise::Collection::Webhook<Lokalise::Resources::Webhook>]
     # @param project_id [String]
     # @param params [Hash]
@@ -14,7 +14,7 @@ module Lokalise
 
     # Returns a single webhook for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-webhook-get
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-webhook-get
     # @return [Lokalise::Resources::Webhook]
     # @param project_id [String]
     # @param webhook_id [String, Integer]
@@ -24,7 +24,7 @@ module Lokalise
 
     # Creates webhook for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-create-a-webhook-post
+    # @see https://app.lokalise.com/api2docs/curl/#transition-create-a-webhook-post
     # @return [Lokalise::Resources::Webhook]
     # @param project_id [String]
     # @param params [Hash]
@@ -34,7 +34,7 @@ module Lokalise
 
     # Updates webhook for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-webhook-put
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-webhook-put
     # @return [Lokalise::Resources::Webhook]
     # @param project_id [String]
     # @param webhook_id [String, Integer]
@@ -45,12 +45,23 @@ module Lokalise
 
     # Deletes webhook for the given project
     #
-    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-webhook-delete
+    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-webhook-delete
     # @return [Hash]
     # @param project_id [String]
     # @param webhook_id [String, Integer]
     def destroy_webhook(project_id, webhook_id)
       c_r Lokalise::Resources::Webhook, :destroy, [project_id, webhook_id]
     end
+
+    # Regenerates secret for the given webhook
+    #
+    # @see https://lokalise.com/api2docs/curl/#transition-regenerate-a-webhook-secret-patch
+    # @return [Hash]
+    # @param project_id [String]
+    # @param webhook_id [String, Integer]
+    def regenerate_webhook_secret(project_id, webhook_id)
+      c_r Lokalise::Resources::Webhook, :regenerate_secret,
+          [project_id, webhook_id, 'secret', 'regenerate']
+    end
   end
 end

data/lib/ruby-lokalise-api/utils/attribute_helpers.rb

@@ -16,16 +16,21 @@ module Lokalise
       # @return [String]
       # @param model_class [String]
       # @param plural [Boolean] Should the returned value be pluralized?
-      def data_key_for(model_class, plural = false, collection = false)
-        data_key_plural = get_key('DATA_KEY_PLURAL', model_class, true, true)
+      def data_key_for(model_class:, plural: false, collection: false)
+        data_key_plural = get_key(
+          name: 'DATA_KEY_PLURAL',
+          model_class: model_class,
+          collection: true,
+          strict: true
+        )
 
         return data_key_plural if collection && data_key_plural
 
-        data_key = get_key 'DATA_KEY', model_class, collection
+        data_key = get_key name: 'DATA_KEY', model_class: model_class, collection: collection
 
         return data_key unless plural
 
-        data_key + 's'
+        "#{data_key}s"
       end
 
       # Returns key used to determine resource id (for example `user_id` or `project_id`).
@@ -35,7 +40,7 @@ module Lokalise
       # @return [String]
       # @param model_class [String]
       def id_key_for(model_class)
-        get_key('ID_KEY', model_class) + '_id'
+        "#{get_key(name: 'ID_KEY', model_class: model_class)}_id"
       end
 
       # Loads attributes for the given resource based on its name
@@ -52,7 +57,7 @@ module Lokalise
 
       private
 
-      def get_key(name, model_class, collection = false, strict = false)
+      def get_key(name:, model_class:, collection: false, strict: false)
         key = if collection && Module.const_defined?("Lokalise::Collections::#{model_class}::#{name}")
                 Module.const_get "Lokalise::Collections::#{model_class}::#{name}"
               elsif Module.const_defined? "Lokalise::Resources::#{model_class}::#{name}"