phrase 2.13.0 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d4702070f78c40d7498d9d68e305cc787640649858e1694ab33c08ea5163ed5
-  data.tar.gz: b0911a27c09fe55d69887601c75aca0f3ac9d7f9a017fa72a4f30cde5e39b880
+  metadata.gz: a84d4b1908bfbb105768607982ae6df42c5d29769a83703e9cf4776022cb14dd
+  data.tar.gz: eaef85f36598f65cd86d4cbdadba04d736023835dee31ce9d014c33420c94d7d
 SHA512:
-  metadata.gz: 229be1ca50cc632b3377f01308fbda31b6c1c3d3c57a482e4bdf879e46c8ac89b99a620b7473696438ec27d73ae4e51c0b093cfecff44743e84433b60f09ffbd
-  data.tar.gz: a39e428c34afe189ae3ae85151bcbc6e4bcafdbe2e7a49b0240c26c9be50fbec9aa54bcf862b04d62f65e271f69f5a47a008046bd5ddbf46278311e7d228d9b3
+  metadata.gz: 44cad7e58e9a1da63e70197af4b725ba8c287edf61eb3a7d7925caea72f5788c4f0eff38098411ca28279705700cef0ee17ecb600fc0ee4cdbe8b29c1f7b372b
+  data.tar.gz: 800dbacc70321c8e8f3d5c93e48aa7df6f402cb110a0880575b0f77b323f17832a00778cd43c929c52b02ffcf35a89fb6c5d86a5e25ca8c90b35cdad7bef255e

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [2.14.0](https://github.com/phrase/openapi/compare/ruby-v2.13.0...ruby-v2.14.0) (2023-08-24)
+
+
+### Features
+
+* **API:** Introduce comment replies endpoints ([#383](https://github.com/phrase/openapi/issues/383)) ([71351ac](https://github.com/phrase/openapi/commit/71351ac285f4f49976092e176c77b09f3485eb65))
+
 ## [2.13.0](https://github.com/phrase/openapi/compare/ruby-v2.12.0...ruby-v2.13.0) (2023-08-22)
 
 

data/README.md

@@ -7,7 +7,7 @@ Phrase Strings is a translation management platform for software projects. You c
 ## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 2.13.0
+- Package version: 2.14.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
 
@@ -56,10 +56,10 @@ gem build phrase.gemspec
 Then install the gem locally:
 
 ```shell
-gem install ./phrase-2.13.0.gem
+gem install ./phrase-2.14.0.gem
 ```
 
-(for development, run `gem install --dev ./phrase-2.13.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./phrase-2.14.0.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -156,6 +156,12 @@ Class | Method | HTTP request | Description
 *Phrase::CommentReactionsApi* | [**reaction_delete**](docs/CommentReactionsApi.md#reaction_delete) | **DELETE** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id} | Delete a reaction
 *Phrase::CommentReactionsApi* | [**reaction_show**](docs/CommentReactionsApi.md#reaction_show) | **GET** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id} | Get a single reaction
 *Phrase::CommentReactionsApi* | [**reactions_list**](docs/CommentReactionsApi.md#reactions_list) | **GET** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions | List reactions
+*Phrase::CommentRepliesApi* | [**replies_list**](docs/CommentRepliesApi.md#replies_list) | **GET** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies | List replies
+*Phrase::CommentRepliesApi* | [**reply_create**](docs/CommentRepliesApi.md#reply_create) | **POST** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies | Create a reply
+*Phrase::CommentRepliesApi* | [**reply_delete**](docs/CommentRepliesApi.md#reply_delete) | **DELETE** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id} | Delete a reply
+*Phrase::CommentRepliesApi* | [**reply_mark_as_read**](docs/CommentRepliesApi.md#reply_mark_as_read) | **PATCH** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_read | Mark a reply as read
+*Phrase::CommentRepliesApi* | [**reply_mark_as_unread**](docs/CommentRepliesApi.md#reply_mark_as_unread) | **PATCH** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_unread | Mark a reply as unread
+*Phrase::CommentRepliesApi* | [**reply_show**](docs/CommentRepliesApi.md#reply_show) | **GET** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id} | Get a single reply
 *Phrase::CommentsApi* | [**comment_create**](docs/CommentsApi.md#comment_create) | **POST** /projects/{project_id}/keys/{key_id}/comments | Create a comment
 *Phrase::CommentsApi* | [**comment_delete**](docs/CommentsApi.md#comment_delete) | **DELETE** /projects/{project_id}/keys/{key_id}/comments/{id} | Delete a comment
 *Phrase::CommentsApi* | [**comment_mark_check**](docs/CommentsApi.md#comment_mark_check) | **GET** /projects/{project_id}/keys/{key_id}/comments/{id}/read | Check if comment is read

data/docs/Comment.md

@@ -6,10 +6,12 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** |  | [optional] 
 **message** | **String** |  | [optional] 
+**has_replies** | **Boolean** |  | [optional] 
 **user** | [**UserPreview**](UserPreview.md) |  | [optional] 
 **created_at** | **DateTime** |  | [optional] 
 **updated_at** | **DateTime** |  | [optional] 
 **mentioned_users** | [**Array<UserPreview>**](UserPreview.md) |  | [optional] 
+**locales** | [**Array<LocalePreview>**](LocalePreview.md) |  | [optional] 
 
 ## Code Sample
 
@@ -18,10 +20,12 @@ require 'Phrase'
 
 instance = Phrase::Comment.new(id: null,
                                  message: null,
+                                 has_replies: null,
                                  user: null,
                                  created_at: null,
                                  updated_at: null,
-                                 mentioned_users: null)
+                                 mentioned_users: null,
+                                 locales: null)
 ```
 
 

data/docs/CommentReactionsApi.md

@@ -41,7 +41,8 @@ key_id = 'key_id_example' # String | Translation Key ID
 comment_id = 'comment_id_example' # String | Comment ID
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
-  branch: 'my-feature-branch' # String | specify the branch to use
+  branch: 'my-feature-branch', # String | specify the branch to use
+  emoji: '👍' # String | specify the emoji for the reaction
 }
 
 begin
@@ -63,6 +64,7 @@ Name | Type | Description  | Notes
  **comment_id** | **String**| Comment ID | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
  **branch** | **String**| specify the branch to use | [optional] 
+ **emoji** | **String**| specify the emoji for the reaction | [optional] 
 
 ### Return type
 

data/docs/CommentRepliesApi.md

@@ -0,0 +1,427 @@
+# Phrase::CommentRepliesApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**replies_list**](CommentRepliesApi.md#replies_list) | **GET** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies | List replies
+[**reply_create**](CommentRepliesApi.md#reply_create) | **POST** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies | Create a reply
+[**reply_delete**](CommentRepliesApi.md#reply_delete) | **DELETE** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id} | Delete a reply
+[**reply_mark_as_read**](CommentRepliesApi.md#reply_mark_as_read) | **PATCH** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_read | Mark a reply as read
+[**reply_mark_as_unread**](CommentRepliesApi.md#reply_mark_as_unread) | **PATCH** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_unread | Mark a reply as unread
+[**reply_show**](CommentRepliesApi.md#reply_show) | **GET** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id} | Get a single reply
+
+
+
+## replies_list
+
+> Array<Comment> replies_list(project_id, key_id, comment_id, opts)
+
+List replies
+
+List all replies for a comment.
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::CommentRepliesApi.new
+project_id = 'project_id_example' # String | Project ID
+key_id = 'key_id_example' # String | Translation Key ID
+comment_id = 'comment_id_example' # String | Comment ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  page: 1, # Integer | Page number
+  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #List replies
+  result = api_instance.replies_list(project_id, key_id, comment_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling CommentRepliesApi->replies_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **key_id** | **String**| Translation Key ID | 
+ **comment_id** | **String**| Comment ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **page** | **Integer**| Page number | [optional] 
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<([**Array&lt;Comment&gt;**](Comment.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## reply_create
+
+> Comment reply_create(project_id, key_id, comment_id, opts)
+
+Create a reply
+
+Create a new reply for a comment.
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::CommentRepliesApi.new
+project_id = 'project_id_example' # String | Project ID
+key_id = 'key_id_example' # String | Translation Key ID
+comment_id = 'comment_id_example' # String | Comment ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch', # String | specify the branch to use
+  message: 'some message...' # String | specify the message for the comment
+}
+
+begin
+  #Create a reply
+  result = api_instance.reply_create(project_id, key_id, comment_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling CommentRepliesApi->reply_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **key_id** | **String**| Translation Key ID | 
+ **comment_id** | **String**| Comment ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+ **message** | **String**| specify the message for the comment | [optional] 
+
+### Return type
+
+Response<([**Comment**](Comment.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## reply_delete
+
+> reply_delete(project_id, key_id, comment_id, id, opts)
+
+Delete a reply
+
+Delete an existing reply.
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::CommentRepliesApi.new
+project_id = 'project_id_example' # String | Project ID
+key_id = 'key_id_example' # String | Translation Key ID
+comment_id = 'comment_id_example' # String | Comment ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #Delete a reply
+  api_instance.reply_delete(project_id, key_id, comment_id, id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling CommentRepliesApi->reply_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **key_id** | **String**| Translation Key ID | 
+ **comment_id** | **String**| Comment ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<(nil (empty response body))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## reply_mark_as_read
+
+> reply_mark_as_read(project_id, key_id, comment_id, id, opts)
+
+Mark a reply as read
+
+Mark a reply as read.
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::CommentRepliesApi.new
+project_id = 'project_id_example' # String | Project ID
+key_id = 'key_id_example' # String | Translation Key ID
+comment_id = 'comment_id_example' # String | Comment ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #Mark a reply as read
+  api_instance.reply_mark_as_read(project_id, key_id, comment_id, id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling CommentRepliesApi->reply_mark_as_read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **key_id** | **String**| Translation Key ID | 
+ **comment_id** | **String**| Comment ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<(nil (empty response body))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## reply_mark_as_unread
+
+> reply_mark_as_unread(project_id, key_id, comment_id, id, opts)
+
+Mark a reply as unread
+
+Mark a reply as unread.
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::CommentRepliesApi.new
+project_id = 'project_id_example' # String | Project ID
+key_id = 'key_id_example' # String | Translation Key ID
+comment_id = 'comment_id_example' # String | Comment ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #Mark a reply as unread
+  api_instance.reply_mark_as_unread(project_id, key_id, comment_id, id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling CommentRepliesApi->reply_mark_as_unread: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **key_id** | **String**| Translation Key ID | 
+ **comment_id** | **String**| Comment ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<(nil (empty response body))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## reply_show
+
+> Comment reply_show(project_id, key_id, comment_id, id, opts)
+
+Get a single reply
+
+Get details on a single reply.
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::CommentRepliesApi.new
+project_id = 'project_id_example' # String | Project ID
+key_id = 'key_id_example' # String | Translation Key ID
+comment_id = 'comment_id_example' # String | Comment ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #Get a single reply
+  result = api_instance.reply_show(project_id, key_id, comment_id, id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling CommentRepliesApi->reply_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **key_id** | **String**| Translation Key ID | 
+ **comment_id** | **String**| Comment ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<([**Comment**](Comment.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CommentsApi.md

@@ -44,7 +44,9 @@ project_id = 'project_id_example' # String | Project ID
 key_id = 'key_id_example' # String | Translation Key ID
 comment_create_parameters = Phrase::CommentCreateParameters.new # CommentCreateParameters | 
 opts = {
-  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  message: 'some message...', # String | specify the message for the comment
+  locale_ids: ['someId'] # Array<String> | specify the locales for the comment
 }
 
 begin
@@ -65,6 +67,8 @@ Name | Type | Description  | Notes
  **key_id** | **String**| Translation Key ID | 
  **comment_create_parameters** | [**CommentCreateParameters**](CommentCreateParameters.md)|  | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **message** | **String**| specify the message for the comment | [optional] 
+ **locale_ids** | [**Array&lt;String&gt;**](String.md)| specify the locales for the comment | [optional] 
 
 ### Return type
 

data/lib/phrase/api/comment_reactions_api.rb

@@ -15,6 +15,7 @@ module Phrase
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
     # @option opts [String] :branch specify the branch to use
+    # @option opts [String] :emoji specify the emoji for the reaction
     # @return [CommentReaction]
     def reaction_create(project_id, key_id, comment_id, opts = {})
       data, _status_code, _headers = reaction_create_with_http_info(project_id, key_id, comment_id, opts)
@@ -29,6 +30,7 @@ module Phrase
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
     # @option opts [String] :branch specify the branch to use
+    # @option opts [String] :emoji specify the emoji for the reaction
     # @return [Array<(Response<(CommentReaction)>, Integer, Hash)>] Response<(CommentReaction)> data, response status code and response headers
     def reaction_create_with_http_info(project_id, key_id, comment_id, opts = {})
       if @api_client.config.debugging
@@ -52,6 +54,7 @@ module Phrase
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
+      query_params[:'emoji'] = opts[:'emoji'] if !opts[:'emoji'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}