v9.2.0

Author: bodrovis

docs/_data/api_items.yml

@@ -120,6 +120,11 @@
       path: fetch-a-single-payment-card
     - title: Delete a payment card
       path: delete-a-payment-card
+- title: Permission templates
+  path: permission-templates
+  sub_paths:
+    - title: Fetch permission templates
+      path: fetch-permission-templates
 - title: Projects
   path: projects
   sub_paths:

docs/additional_info/changelog.md

@@ -1,5 +1,38 @@
 # Changelog
 
+## 9.2.0 (15-Oct-2024)
+
+* Added support for a new [`PermissionTemplates` endpoint](https://developers.lokalise.com/reference/list-all-permission-templates):
+
+```ruby
+permission_templates = test_client.permission_templates team_id
+
+template = permission_templates[0]
+
+template.id # => 1
+template.role # => "Manager"
+template.permissions # => ['branches_main_modify', ...]
+template.description # => 'Manage project settings ...'
+template.tag # => 'Full access'
+template.tagColor # => 'green'
+template.tagInfo # => ''
+template.doesEnableAllReadOnlyLanguages # => true
+```
+
+* Added `role_id` attribute to the user group object. For example:
+
+```ruby
+group = test_client.team_user_group team_id, group_id
+group.role_id # => 5
+```
+
+* Added `role_id` attribute to the contributor object. For example:
+
+```ruby
+contributor = test_client.contributor project_id, user_id
+contributor.role_id # => 5
+```
+
 ## 9.1.0 (15-May-2024)
 
 * Add support for [cursor pagination](https://lokalise.github.io/ruby-lokalise-api/api/getting-started#cursor-pagination) for List keys and List translation endpoints:

docs/api/permission-templates.md

@@ -0,0 +1,22 @@
+# Permission templates
+
+[Permission template attributes](https://developers.lokalise.com/reference/permission-template-object)
+
+## Fetch permission templates
+
+[API doc](https://developers.lokalise.com/reference/list-all-permission-templates)
+
+```ruby
+permission_templates = test_client.permission_templates team_id
+
+template = permission_templates[0]
+
+template.id # => 1
+template.role # => "Manager"
+template.permissions # => ['branches_main_modify', ...]
+template.description # => 'Manage project settings ...'
+template.tag # => 'Full access'
+template.tagColor # => 'green'
+template.tagInfo # => ''
+template.doesEnableAllReadOnlyLanguages # => true
+```

lib/ruby_lokalise_api/collections/permission_templates.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    class PermissionTemplates < Base
+      ENDPOINT = RubyLokaliseApi::Endpoints::PermissionTemplatesEndpoint
+      RESOURCE = RubyLokaliseApi::Resources::PermissionTemplate
+      DATA_KEY = 'roles'
+    end
+  end
+end

lib/ruby_lokalise_api/data/resource_attributes.yml

@@ -28,6 +28,7 @@ contributor:
   - is_reviewer
   - languages
   - admin_rights
+  - role_id
 custom_translation_status:
   - project_id
   - branch
@@ -142,6 +143,15 @@ queued_process:
   - created_at
   - created_at_timestamp
   - details
+permission_template:
+  - id
+  - role
+  - permissions
+  - description
+  - tag
+  - tagColor
+  - tagInfo
+  - doesEnableAllReadOnlyLanguages
 screenshot:
   - project_id
   - branch
@@ -256,6 +266,7 @@ team_user_group:
   - team_id
   - projects
   - members
+  - role_id
 translation:
   - project_id
   - branch

lib/ruby_lokalise_api/endpoints/permission_templates_endpoint.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class PermissionTemplatesEndpoint < MainEndpoint
+      private
+
+      def base_query(team_id)
+        {
+          teams: [team_id, :roles]
+        }
+      end
+    end
+  end
+end

lib/ruby_lokalise_api/resources/permission_template.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Resources
+    class PermissionTemplate < Base
+      MAIN_PARAMS = %i[nil].freeze
+      no_support_for %i[update destroy reload_data]
+    end
+  end
+end

lib/ruby_lokalise_api/rest.rb

@@ -14,6 +14,7 @@ module Rest
     include Rest::Languages
     include Rest::Orders
     include Rest::PaymentCards
+    include Rest::PermissionTemplates
     include Rest::Projects
     include Rest::QueuedProcesses
     include Rest::Segments

lib/ruby_lokalise_api/rest/permission_templates.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Rest
+    module PermissionTemplates
+      # Returns permission tempates for a team
+      #
+      # @see https://developers.lokalise.com/reference/list-all-permission-templates
+      # @return [RubyLokaliseApi::Collections::PermissionTemplates]
+      # @param team_id [Integer, String]
+      def permission_templates(team_id)
+        name = 'PermissionTemplates'
+        params = { query: team_id }
+
+        data = endpoint(name: name, params: params).do_get
+
+        collection name, data
+      end
+    end
+  end
+end

lib/ruby_lokalise_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyLokaliseApi
-  VERSION = '9.1.0'
+  VERSION = '9.2.0'
 end