phrase 2.14.0 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a84d4b1908bfbb105768607982ae6df42c5d29769a83703e9cf4776022cb14dd
-  data.tar.gz: eaef85f36598f65cd86d4cbdadba04d736023835dee31ce9d014c33420c94d7d
+  metadata.gz: a56234942a6166c1299cd75286a0ec37a654a98bfc998f806c8635b5cca69ef0
+  data.tar.gz: 3b8a5a7f7a6e782bce174f65697f6eaddbad169e912001a545ef2f3db119b632
 SHA512:
-  metadata.gz: 44cad7e58e9a1da63e70197af4b725ba8c287edf61eb3a7d7925caea72f5788c4f0eff38098411ca28279705700cef0ee17ecb600fc0ee4cdbe8b29c1f7b372b
-  data.tar.gz: 800dbacc70321c8e8f3d5c93e48aa7df6f402cb110a0880575b0f77b323f17832a00778cd43c929c52b02ffcf35a89fb6c5d86a5e25ca8c90b35cdad7bef255e
+  metadata.gz: 7537a76db6d34e63d666874a35ba8963823b0935af89555a957e02242bdd8e9ab175aff193018b8082339abbda7e71a5e60d58895310129e4409664167f7a5d4
+  data.tar.gz: 44f4dcae88b39e894ed424bd2e8816a2fe8ce0cd114e138b4a9653585f9af121535f7809aa918ad590e27642fe90d3c695762706348c65f9c6cbe81a541af55e

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [2.15.0](https://github.com/phrase/openapi/compare/ruby-v2.14.0...ruby-v2.15.0) (2023-08-28)
+
+
+### Features
+
+* **API:** Document new query parameters ([#393](https://github.com/phrase/openapi/issues/393)) ([770515a](https://github.com/phrase/openapi/commit/770515a9628122955bb3919405babf9392684eb9))
+
 ## [2.14.0](https://github.com/phrase/openapi/compare/ruby-v2.13.0...ruby-v2.14.0) (2023-08-24)
 
 

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.14.0
+- Package version: 2.15.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.14.0.gem
+gem install ./phrase-2.15.0.gem
 ```
 
-(for development, run `gem install --dev ./phrase-2.14.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./phrase-2.15.0.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -407,6 +407,7 @@ Class | Method | HTTP request | Description
  - [Phrase::CommentMarkReadParameters](docs/CommentMarkReadParameters.md)
  - [Phrase::CommentReaction](docs/CommentReaction.md)
  - [Phrase::CommentUpdateParameters](docs/CommentUpdateParameters.md)
+ - [Phrase::CommentsListParameters](docs/CommentsListParameters.md)
  - [Phrase::CurrentUser](docs/CurrentUser.md)
  - [Phrase::Distribution](docs/Distribution.md)
  - [Phrase::DistributionCreateParameters](docs/DistributionCreateParameters.md)
@@ -515,6 +516,7 @@ Class | Method | HTTP request | Description
  - [Phrase::ReleaseCreateParameters](docs/ReleaseCreateParameters.md)
  - [Phrase::ReleasePreview](docs/ReleasePreview.md)
  - [Phrase::ReleaseUpdateParameters](docs/ReleaseUpdateParameters.md)
+ - [Phrase::RepliesListParameters](docs/RepliesListParameters.md)
  - [Phrase::Screenshot](docs/Screenshot.md)
  - [Phrase::ScreenshotCreateParameters](docs/ScreenshotCreateParameters.md)
  - [Phrase::ScreenshotMarker](docs/ScreenshotMarker.md)

data/docs/CommentRepliesApi.md

@@ -15,7 +15,7 @@ Method | HTTP request | Description
 
 ## replies_list
 
-> Array<Comment> replies_list(project_id, key_id, comment_id, opts)
+> Array<Comment> replies_list(project_id, key_id, comment_id, replies_list_parameters, opts)
 
 List replies
 
@@ -41,16 +41,19 @@ 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
+replies_list_parameters = Phrase::RepliesListParameters.new # RepliesListParameters | 
 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
+  branch: 'my-feature-branch', # String | specify the branch to use
+  query: 'Some comment content', # String | Search query for comment messages
+  filters: ['[\"read\",\"unread\"]'] # Array<String> | Specify the filter for the comments
 }
 
 begin
   #List replies
-  result = api_instance.replies_list(project_id, key_id, comment_id, opts)
+  result = api_instance.replies_list(project_id, key_id, comment_id, replies_list_parameters, opts)
   pp result
 rescue Phrase::ApiError => e
   puts "Exception when calling CommentRepliesApi->replies_list: #{e}"
@@ -65,10 +68,13 @@ Name | Type | Description  | Notes
  **project_id** | **String**| Project ID | 
  **key_id** | **String**| Translation Key ID | 
  **comment_id** | **String**| Comment ID | 
+ **replies_list_parameters** | [**RepliesListParameters**](RepliesListParameters.md)|  | 
  **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] 
+ **query** | **String**| Search query for comment messages | [optional] 
+ **filters** | [**Array&lt;String&gt;**](String.md)| Specify the filter for the comments | [optional] 
 
 ### Return type
 
@@ -80,7 +86,7 @@ Response<([**Array&lt;Comment&gt;**](Comment.md))>
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
 - **Accept**: application/json
 
 

data/docs/CommentsApi.md

@@ -484,7 +484,7 @@ Response<([**Comment**](Comment.md))>
 
 ## comments_list
 
-> Array&lt;Comment&gt; comments_list(project_id, key_id, opts)
+> Array&lt;Comment&gt; comments_list(project_id, key_id, comments_list_parameters, opts)
 
 List comments
 
@@ -509,16 +509,20 @@ end
 api_instance = Phrase::CommentsApi.new
 project_id = 'project_id_example' # String | Project ID
 key_id = 'key_id_example' # String | Translation Key ID
+comments_list_parameters = Phrase::CommentsListParameters.new # CommentsListParameters | 
 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
+  branch: 'my-feature-branch', # String | specify the branch to use
+  query: 'Some comment content', # String | Search query for comment messages
+  locale_ids: ['[\"someId\"]'], # Array<String> | Search comments by their assigned locales
+  filters: ['[\"read\",\"unread\"]'] # Array<String> | Specify the filter for the comments
 }
 
 begin
   #List comments
-  result = api_instance.comments_list(project_id, key_id, opts)
+  result = api_instance.comments_list(project_id, key_id, comments_list_parameters, opts)
   pp result
 rescue Phrase::ApiError => e
   puts "Exception when calling CommentsApi->comments_list: #{e}"
@@ -532,10 +536,14 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **project_id** | **String**| Project ID | 
  **key_id** | **String**| Translation Key ID | 
+ **comments_list_parameters** | [**CommentsListParameters**](CommentsListParameters.md)|  | 
  **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] 
+ **query** | **String**| Search query for comment messages | [optional] 
+ **locale_ids** | [**Array&lt;String&gt;**](String.md)| Search comments by their assigned locales | [optional] 
+ **filters** | [**Array&lt;String&gt;**](String.md)| Specify the filter for the comments | [optional] 
 
 ### Return type
 
@@ -547,6 +555,6 @@ Response<([**Array&lt;Comment&gt;**](Comment.md))>
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
 - **Accept**: application/json
 

data/docs/CommentsListParameters.md

@@ -0,0 +1,23 @@
+# Phrase::CommentsListParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | Specify the branch to use | [optional] 
+**query** | **String** | Search query for comment messages | [optional] 
+**locale_ids** | **Array<String>** | Search comments by their assigned locales | [optional] 
+**filters** | **Array<String>** | Specify filters to find comments by | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::CommentsListParameters.new(branch: my-feature-branch,
+                                 query: Some comment content,
+                                 locale_ids: ["someId","otherId"],
+                                 filters: ["read","unread"])
+```
+
+

data/docs/RepliesListParameters.md

@@ -0,0 +1,21 @@
+# Phrase::RepliesListParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | Specify the branch to use | [optional] 
+**query** | **String** | Search query for comment messages | [optional] 
+**filters** | **Array<String>** | Specify filters to find comments by | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::RepliesListParameters.new(branch: my-feature-branch,
+                                 query: Some comment content,
+                                 filters: ["read","unread"])
+```
+
+

data/lib/phrase/api/comment_replies_api.rb

@@ -12,14 +12,17 @@ module Phrase
     # @param project_id [String] Project ID
     # @param key_id [String] Translation Key ID
     # @param comment_id [String] Comment ID
+    # @param replies_list_parameters [RepliesListParameters] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
     # @option opts [Integer] :page Page number
     # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
     # @option opts [String] :branch specify the branch to use
+    # @option opts [String] :query Search query for comment messages
+    # @option opts [Array<String>] :filters Specify the filter for the comments
     # @return [Array<Comment>]
-    def replies_list(project_id, key_id, comment_id, opts = {})
-      data, _status_code, _headers = replies_list_with_http_info(project_id, key_id, comment_id, opts)
+    def replies_list(project_id, key_id, comment_id, replies_list_parameters, opts = {})
+      data, _status_code, _headers = replies_list_with_http_info(project_id, key_id, comment_id, replies_list_parameters, opts)
       data
     end
 
@@ -28,13 +31,16 @@ module Phrase
     # @param project_id [String] Project ID
     # @param key_id [String] Translation Key ID
     # @param comment_id [String] Comment ID
+    # @param replies_list_parameters [RepliesListParameters] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
     # @option opts [Integer] :page Page number
     # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
     # @option opts [String] :branch specify the branch to use
+    # @option opts [String] :query Search query for comment messages
+    # @option opts [Array<String>] :filters Specify the filter for the comments
     # @return [Array<(Response<(Array<Comment>)>, Integer, Hash)>] Response<(Array<Comment>)> data, response status code and response headers
-    def replies_list_with_http_info(project_id, key_id, comment_id, opts = {})
+    def replies_list_with_http_info(project_id, key_id, comment_id, replies_list_parameters, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: CommentRepliesApi.replies_list ...'
       end
@@ -50,6 +56,10 @@ module Phrase
       if @api_client.config.client_side_validation && comment_id.nil?
         fail ArgumentError, "Missing the required parameter 'comment_id' when calling CommentRepliesApi.replies_list"
       end
+      # verify the required parameter 'replies_list_parameters' is set
+      if @api_client.config.client_side_validation && replies_list_parameters.nil?
+        fail ArgumentError, "Missing the required parameter 'replies_list_parameters' when calling CommentRepliesApi.replies_list"
+      end
       # resource path
       local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'comment_id' + '}', CGI.escape(comment_id.to_s))
 
@@ -58,18 +68,22 @@ module Phrase
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
       query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
+      query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
+      query_params[:'filters'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:body] || @api_client.object_to_http_body(replies_list_parameters) 
 
       # return_type
       return_type = opts[:return_type] || 'Array<Comment>' 

data/lib/phrase/api/comments_api.rb

@@ -585,14 +585,18 @@ module Phrase
     # List all comments for a key.
     # @param project_id [String] Project ID
     # @param key_id [String] Translation Key ID
+    # @param comments_list_parameters [CommentsListParameters] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
     # @option opts [Integer] :page Page number
     # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
     # @option opts [String] :branch specify the branch to use
+    # @option opts [String] :query Search query for comment messages
+    # @option opts [Array<String>] :locale_ids Search comments by their assigned locales
+    # @option opts [Array<String>] :filters Specify the filter for the comments
     # @return [Array<Comment>]
-    def comments_list(project_id, key_id, opts = {})
-      data, _status_code, _headers = comments_list_with_http_info(project_id, key_id, opts)
+    def comments_list(project_id, key_id, comments_list_parameters, opts = {})
+      data, _status_code, _headers = comments_list_with_http_info(project_id, key_id, comments_list_parameters, opts)
       data
     end
 
@@ -600,13 +604,17 @@ module Phrase
     # List all comments for a key.
     # @param project_id [String] Project ID
     # @param key_id [String] Translation Key ID
+    # @param comments_list_parameters [CommentsListParameters] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
     # @option opts [Integer] :page Page number
     # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
     # @option opts [String] :branch specify the branch to use
+    # @option opts [String] :query Search query for comment messages
+    # @option opts [Array<String>] :locale_ids Search comments by their assigned locales
+    # @option opts [Array<String>] :filters Specify the filter for the comments
     # @return [Array<(Response<(Array<Comment>)>, Integer, Hash)>] Response<(Array<Comment>)> data, response status code and response headers
-    def comments_list_with_http_info(project_id, key_id, opts = {})
+    def comments_list_with_http_info(project_id, key_id, comments_list_parameters, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: CommentsApi.comments_list ...'
       end
@@ -618,6 +626,10 @@ module Phrase
       if @api_client.config.client_side_validation && key_id.nil?
         fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comments_list"
       end
+      # verify the required parameter 'comments_list_parameters' is set
+      if @api_client.config.client_side_validation && comments_list_parameters.nil?
+        fail ArgumentError, "Missing the required parameter 'comments_list_parameters' when calling CommentsApi.comments_list"
+      end
       # resource path
       local_var_path = '/projects/{project_id}/keys/{key_id}/comments'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s))
 
@@ -626,18 +638,23 @@ module Phrase
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
       query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
+      query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
+      query_params[:'locale_ids'] = @api_client.build_collection_param(opts[:'locale_ids'], :multi) if !opts[:'locale_ids'].nil?
+      query_params[:'filters'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
       header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:body] || @api_client.object_to_http_body(comments_list_parameters) 
 
       # return_type
       return_type = opts[:return_type] || 'Array<Comment>' 

data/lib/phrase/models/comments_list_parameters.rb

@@ -0,0 +1,229 @@
+require 'date'
+
+module Phrase
+  class CommentsListParameters
+    # Specify the branch to use
+    attr_accessor :branch
+
+    # Search query for comment messages
+    attr_accessor :query
+
+    # Search comments by their assigned locales
+    attr_accessor :locale_ids
+
+    # Specify filters to find comments by
+    attr_accessor :filters
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'branch' => :'branch',
+        :'query' => :'query',
+        :'locale_ids' => :'locale_ids',
+        :'filters' => :'filters'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'branch' => :'String',
+        :'query' => :'String',
+        :'locale_ids' => :'Array<String>',
+        :'filters' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::CommentsListParameters` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::CommentsListParameters`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'branch')
+        self.branch = attributes[:'branch']
+      end
+
+      if attributes.key?(:'query')
+        self.query = attributes[:'query']
+      end
+
+      if attributes.key?(:'locale_ids')
+        if (value = attributes[:'locale_ids']).is_a?(Array)
+          self.locale_ids = value
+        end
+      end
+
+      if attributes.key?(:'filters')
+        if (value = attributes[:'filters']).is_a?(Array)
+          self.filters = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          branch == o.branch &&
+          query == o.query &&
+          locale_ids == o.locale_ids &&
+          filters == o.filters
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [branch, query, locale_ids, filters].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        Phrase.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/phrase/models/replies_list_parameters.rb

@@ -0,0 +1,217 @@
+require 'date'
+
+module Phrase
+  class RepliesListParameters
+    # Specify the branch to use
+    attr_accessor :branch
+
+    # Search query for comment messages
+    attr_accessor :query
+
+    # Specify filters to find comments by
+    attr_accessor :filters
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'branch' => :'branch',
+        :'query' => :'query',
+        :'filters' => :'filters'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'branch' => :'String',
+        :'query' => :'String',
+        :'filters' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::RepliesListParameters` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::RepliesListParameters`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'branch')
+        self.branch = attributes[:'branch']
+      end
+
+      if attributes.key?(:'query')
+        self.query = attributes[:'query']
+      end
+
+      if attributes.key?(:'filters')
+        if (value = attributes[:'filters']).is_a?(Array)
+          self.filters = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          branch == o.branch &&
+          query == o.query &&
+          filters == o.filters
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [branch, query, filters].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        Phrase.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/phrase/version.rb

@@ -1,3 +1,3 @@
 module Phrase
-  VERSION = '2.14.0'
+  VERSION = '2.15.0'
 end

data/lib/phrase.rb

@@ -36,6 +36,7 @@ require 'phrase/models/comment_create_parameters'
 require 'phrase/models/comment_mark_read_parameters'
 require 'phrase/models/comment_reaction'
 require 'phrase/models/comment_update_parameters'
+require 'phrase/models/comments_list_parameters'
 require 'phrase/models/current_user'
 require 'phrase/models/distribution'
 require 'phrase/models/distribution_create_parameters'
@@ -144,6 +145,7 @@ require 'phrase/models/release'
 require 'phrase/models/release_create_parameters'
 require 'phrase/models/release_preview'
 require 'phrase/models/release_update_parameters'
+require 'phrase/models/replies_list_parameters'
 require 'phrase/models/screenshot'
 require 'phrase/models/screenshot_create_parameters'
 require 'phrase/models/screenshot_marker'

data/spec/api/comment_replies_api_spec.rb

@@ -26,11 +26,14 @@ describe 'CommentRepliesApi' do
   # @param project_id Project ID
   # @param key_id Translation Key ID
   # @param comment_id Comment ID
+  # @param replies_list_parameters 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
   # @option opts [Integer] :page Page number
   # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
   # @option opts [String] :branch specify the branch to use
+  # @option opts [String] :query Search query for comment messages
+  # @option opts [Array<String>] :filters Specify the filter for the comments
   # @return [Array<Comment>]
   describe 'replies_list test' do
     it 'should work' do

data/spec/api/comments_api_spec.rb

@@ -138,11 +138,15 @@ describe 'CommentsApi' do
   # List all comments for a key.
   # @param project_id Project ID
   # @param key_id Translation Key ID
+  # @param comments_list_parameters 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
   # @option opts [Integer] :page Page number
   # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
   # @option opts [String] :branch specify the branch to use
+  # @option opts [String] :query Search query for comment messages
+  # @option opts [Array<String>] :locale_ids Search comments by their assigned locales
+  # @option opts [Array<String>] :filters Specify the filter for the comments
   # @return [Array<Comment>]
   describe 'comments_list test' do
     it 'should work' do

data/spec/models/comments_list_parameters_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Phrase::CommentsListParameters
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CommentsListParameters' do
+  before do
+    # run before each test
+    @instance = Phrase::CommentsListParameters.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CommentsListParameters' do
+    it 'should create an instance of CommentsListParameters' do
+      expect(@instance).to be_instance_of(Phrase::CommentsListParameters)
+    end
+  end
+  describe 'test attribute "branch"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "query"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "locale_ids"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "filters"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/replies_list_parameters_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Phrase::RepliesListParameters
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'RepliesListParameters' do
+  before do
+    # run before each test
+    @instance = Phrase::RepliesListParameters.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RepliesListParameters' do
+    it 'should create an instance of RepliesListParameters' do
+      expect(@instance).to be_instance_of(Phrase::RepliesListParameters)
+    end
+  end
+  describe 'test attribute "branch"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "query"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "filters"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phrase
 version: !ruby/object:Gem::Version
-  version: 2.14.0
+  version: 2.15.0
 platform: ruby
 authors:
 - Phrase
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-24 00:00:00.000000000 Z
+date: 2023-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -132,6 +132,7 @@ files:
 - docs/CommentRepliesApi.md
 - docs/CommentUpdateParameters.md
 - docs/CommentsApi.md
+- docs/CommentsListParameters.md
 - docs/CurrentUser.md
 - docs/Distribution.md
 - docs/DistributionCreateParameters.md
@@ -265,6 +266,7 @@ files:
 - docs/ReleasePreview.md
 - docs/ReleaseUpdateParameters.md
 - docs/ReleasesApi.md
+- docs/RepliesListParameters.md
 - docs/Screenshot.md
 - docs/ScreenshotCreateParameters.md
 - docs/ScreenshotMarker.md
@@ -427,6 +429,7 @@ files:
 - lib/phrase/models/comment_mark_read_parameters.rb
 - lib/phrase/models/comment_reaction.rb
 - lib/phrase/models/comment_update_parameters.rb
+- lib/phrase/models/comments_list_parameters.rb
 - lib/phrase/models/current_user.rb
 - lib/phrase/models/distribution.rb
 - lib/phrase/models/distribution_create_parameters.rb
@@ -535,6 +538,7 @@ files:
 - lib/phrase/models/release_create_parameters.rb
 - lib/phrase/models/release_preview.rb
 - lib/phrase/models/release_update_parameters.rb
+- lib/phrase/models/replies_list_parameters.rb
 - lib/phrase/models/screenshot.rb
 - lib/phrase/models/screenshot_create_parameters.rb
 - lib/phrase/models/screenshot_marker.rb
@@ -683,6 +687,7 @@ files:
 - spec/models/comment_reaction_spec.rb
 - spec/models/comment_spec.rb
 - spec/models/comment_update_parameters_spec.rb
+- spec/models/comments_list_parameters_spec.rb
 - spec/models/current_user_spec.rb
 - spec/models/distribution_create_parameters_spec.rb
 - spec/models/distribution_preview_spec.rb
@@ -791,6 +796,7 @@ files:
 - spec/models/release_preview_spec.rb
 - spec/models/release_spec.rb
 - spec/models/release_update_parameters_spec.rb
+- spec/models/replies_list_parameters_spec.rb
 - spec/models/screenshot_create_parameters_spec.rb
 - spec/models/screenshot_marker_create_parameters_spec.rb
 - spec/models/screenshot_marker_spec.rb
@@ -974,6 +980,7 @@ test_files:
 - spec/models/subscription_spec.rb
 - spec/models/teams_projects_create_parameters_spec.rb
 - spec/models/gitlab_sync_history_spec.rb
+- spec/models/replies_list_parameters_spec.rb
 - spec/models/team_detail_spec.rb
 - spec/models/screenshot_update_parameters_spec.rb
 - spec/models/release_spec.rb
@@ -1028,6 +1035,7 @@ test_files:
 - spec/models/locale_team_preview_spec.rb
 - spec/models/blacklisted_key_spec.rb
 - spec/models/comment_spec.rb
+- spec/models/comments_list_parameters_spec.rb
 - spec/models/space_spec.rb
 - spec/models/account_spec.rb
 - spec/models/webhook_update_parameters_spec.rb