phrase 4.28.0 → 4.30.0

data/docs/Variable.md

@@ -12,12 +12,12 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::Variable.new(name: null,
-                                 value: null,
-                                 created_at: null,
-                                 updated_at: null)
+instance = Phrase::Variable.new(name: nil,
+                                 value: nil,
+                                 created_at: nil,
+                                 updated_at: nil)
 ```
 
 

data/docs/VariableCreateParameters.md

@@ -10,10 +10,10 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::VariableCreateParameters.new(name: MY_VARIABLE,
-                                 value: Hello World)
+instance = Phrase::VariableCreateParameters.new(name: 'MY_VARIABLE',
+                                 value: 'Hello World')
 ```
 
 

data/docs/VariableUpdateParameters.md

@@ -10,10 +10,10 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::VariableUpdateParameters.new(name: MY_VARIABLE,
-                                 value: Hello World)
+instance = Phrase::VariableUpdateParameters.new(name: 'MY_VARIABLE',
+                                 value: 'Hello World')
 ```
 
 

data/docs/Webhook.md

@@ -16,16 +16,16 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::Webhook.new(id: null,
-                                 callback_url: null,
-                                 description: null,
-                                 events: null,
-                                 active: null,
-                                 include_branches: null,
-                                 created_at: null,
-                                 updated_at: null)
+instance = Phrase::Webhook.new(id: nil,
+                                 callback_url: nil,
+                                 description: nil,
+                                 events: nil,
+                                 active: nil,
+                                 include_branches: nil,
+                                 created_at: nil,
+                                 updated_at: nil)
 ```
 
 

data/docs/WebhookCreateParameters.md

@@ -14,14 +14,14 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::WebhookCreateParameters.new(callback_url: http://example.com/hooks/phraseapp-notifications,
-                                 secret: secr3t,
-                                 description: My webhook for chat notifications,
-                                 events: locales:create,translations:update,
-                                 active: null,
-                                 include_branches: null)
+instance = Phrase::WebhookCreateParameters.new(callback_url: 'http://example.com/hooks/phraseapp-notifications',
+                                 secret: 'secr3t',
+                                 description: 'My webhook for chat notifications',
+                                 events: 'locales:create,translations:update',
+                                 active: nil,
+                                 include_branches: nil)
 ```
 
 

data/docs/WebhookDelivery.md

@@ -15,15 +15,15 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::WebhookDelivery.new(id: null,
-                                 webhook_id: null,
-                                 response_status_code: null,
-                                 delivered_at: null,
-                                 duration_ms: null,
-                                 created_at: null,
-                                 updated_at: null)
+instance = Phrase::WebhookDelivery.new(id: nil,
+                                 webhook_id: nil,
+                                 response_status_code: nil,
+                                 delivered_at: nil,
+                                 duration_ms: nil,
+                                 created_at: nil,
+                                 updated_at: nil)
 ```
 
 

data/docs/WebhookUpdateParameters.md

@@ -14,14 +14,14 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::WebhookUpdateParameters.new(callback_url: http://example.com/hooks/phraseapp-notifications,
-                                 secret: secr3t,
-                                 description: My webhook for chat notifications,
-                                 events: locales:create,translations:update,
-                                 active: null,
-                                 include_branches: null)
+instance = Phrase::WebhookUpdateParameters.new(callback_url: 'http://example.com/hooks/phraseapp-notifications',
+                                 secret: 'secr3t',
+                                 description: 'My webhook for chat notifications',
+                                 events: 'locales:create,translations:update',
+                                 active: nil,
+                                 include_branches: nil)
 ```
 
 

data/lib/phrase/api/members_api.rb

@@ -311,6 +311,84 @@ module Phrase
       return response, status_code, headers
     end
 
+    # List project members
+    # Get all members active in the project. Access token scope must include `read`.
+    # @param project_id [String] Project ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @option opts [String] :q Specify a query to search for members by name or email (including wildcards).
+    # @option opts [String] :job_id Filter members to those assigned to the job identified by this id.
+    # @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
+    # @return [Array<ProjectMember>]
+    def members_by_project(project_id, opts = {})
+      data, _status_code, _headers = members_by_project_with_http_info(project_id, opts)
+      data
+    end
+
+    # List project members
+    # Get all members active in the project. Access token scope must include &#x60;read&#x60;.
+    # @param project_id [String] Project ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @option opts [String] :q Specify a query to search for members by name or email (including wildcards).
+    # @option opts [String] :job_id Filter members to those assigned to the job identified by this id.
+    # @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
+    # @return [Array<(Response<(Array<ProjectMember>)>, Integer, Hash)>] Response<(Array<ProjectMember>)> data, response status code and response headers
+    def members_by_project_with_http_info(project_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MembersApi.members_by_project ...'
+      end
+      # verify the required parameter 'project_id' is set
+      if @api_client.config.client_side_validation && project_id.nil?
+        fail ArgumentError, "Missing the required parameter 'project_id' when calling MembersApi.members_by_project"
+      end
+      # resource path
+      local_var_path = '/projects/{project_id}/members'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
+      query_params[:'job_id'] = opts[:'job_id'] if !opts[:'job_id'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['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] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<ProjectMember>' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MembersApi#members_by_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      response = ::Phrase::Response.new(data, headers)
+      return response, status_code, headers
+    end
+
     # List members
     # Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include `team.manage`.
     # @param account_id [String] Account ID

data/lib/phrase/api/repo_syncs_api.rb

@@ -382,6 +382,8 @@ module Phrase
     # @param account_id [String] Account ID
     # @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
     # @return [Array<RepoSync>]
     def repo_sync_list(account_id, opts = {})
       data, _status_code, _headers = repo_sync_list_with_http_info(account_id, opts)
@@ -393,6 +395,8 @@ module Phrase
     # @param account_id [String] Account ID
     # @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
     # @return [Array<(Response<(Array<RepoSync>)>, Integer, Hash)>] Response<(Array<RepoSync>)> data, response status code and response headers
     def repo_sync_list_with_http_info(account_id, opts = {})
       if @api_client.config.debugging
@@ -407,6 +411,8 @@ module Phrase
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/phrase/api/reports_api.rb

@@ -7,8 +7,8 @@ module Phrase
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # List Locale Reports
-    # List all locale reports for the given project
+    # List Locale Reports (word count, character count, translation statistics)
+    # List all locale reports for the given project. Each report includes translation statistics per locale, including word count and character count fields (`source_word_count`, `word_count`, `word_count_unverified`, `word_count_missing`) as well as translation completion statistics (`keys_count`, `completed_translations_count`, `untranslated_keys_count`, `unverified_translations_count`, `reviewed_translations_count`, and their percentages). Use the `tag` parameter to scope the report to a specific job (e.g. its job tag) to get job-scoped word count statistics.
     # @param project_id [String] Project ID
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
@@ -23,8 +23,8 @@ module Phrase
       data
     end
 
-    # List Locale Reports
-    # List all locale reports for the given project
+    # List Locale Reports (word count, character count, translation statistics)
+    # List all locale reports for the given project. Each report includes translation statistics per locale, including word count and character count fields (`source_word_count`, `word_count`, `word_count_unverified`, `word_count_missing`) as well as translation completion statistics (`keys_count`, `completed_translations_count`, `untranslated_keys_count`, `unverified_translations_count`, `reviewed_translations_count`, and their percentages). Use the `tag` parameter to scope the report to a specific job (e.g. its job tag) to get job-scoped word count statistics.
     # @param project_id [String] Project ID
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)

data/lib/phrase/api/supported_languages_api.rb

@@ -0,0 +1,67 @@
+require 'cgi'
+
+module Phrase
+  class SupportedLanguagesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List supported languages
+    # Returns all languages/locale codes that Phrase Strings recognizes, mapped to their human-readable display name. This endpoint does not require authentication. 
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, String>]
+    def languages_list(opts = {})
+      data, _status_code, _headers = languages_list_with_http_info(opts)
+      data
+    end
+
+    # List supported languages
+    # Returns all languages/locale codes that Phrase Strings recognizes, mapped to their human-readable display name. This endpoint does not require authentication. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Response<(Hash<String, String>)>, Integer, Hash)>] Response<(Hash<String, String>)> data, response status code and response headers
+    def languages_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SupportedLanguagesApi.languages_list ...'
+      end
+      # resource path
+      local_var_path = '/languages'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Hash<String, String>' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SupportedLanguagesApi#languages_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      response = ::Phrase::Response.new(data, headers)
+      return response, status_code, headers
+    end
+  end
+end

data/lib/phrase/models/job_template_create_parameters.rb

@@ -17,6 +17,9 @@ module Phrase
     # The API id of the source language. This locale will be set as source locale for the job template. If not provided, the project default locale will be used.
     attr_accessor :source_locale_id
 
+    # Code of the account member to set as the job template owner. The referenced user must also be a member of the project; passing the code of an account member who is not a project member returns a 404. When omitted or blank, no owner is pre-set; the user who creates a job from this template is assigned as owner at job-creation time. 
+    attr_accessor :owner_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -24,7 +27,8 @@ module Phrase
         :'name' => :'name',
         :'briefing' => :'briefing',
         :'autotranslate' => :'autotranslate',
-        :'source_locale_id' => :'source_locale_id'
+        :'source_locale_id' => :'source_locale_id',
+        :'owner_id' => :'owner_id'
       }
     end
 
@@ -35,7 +39,8 @@ module Phrase
         :'name' => :'String',
         :'briefing' => :'String',
         :'autotranslate' => :'Boolean',
-        :'source_locale_id' => :'String'
+        :'source_locale_id' => :'String',
+        :'owner_id' => :'String'
       }
     end
 
@@ -79,6 +84,10 @@ module Phrase
       if attributes.key?(:'source_locale_id')
         self.source_locale_id = attributes[:'source_locale_id']
       end
+
+      if attributes.key?(:'owner_id')
+        self.owner_id = attributes[:'owner_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -108,7 +117,8 @@ module Phrase
           name == o.name &&
           briefing == o.briefing &&
           autotranslate == o.autotranslate &&
-          source_locale_id == o.source_locale_id
+          source_locale_id == o.source_locale_id &&
+          owner_id == o.owner_id
     end
 
     # @see the `==` method
@@ -120,7 +130,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branch, name, briefing, autotranslate, source_locale_id].hash
+      [branch, name, briefing, autotranslate, source_locale_id, owner_id].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/job_template_update_parameters.rb

@@ -17,6 +17,9 @@ module Phrase
     # The API id of the source language. This locale will be set as source locale for the job template. If not provided, the project default locale will be used.
     attr_accessor :source_locale_id
 
+    # Code of the account member to set as the job template owner. The referenced user must also be a member of the project; passing the code of an account member who is not a project member returns a 404. Pass an empty string to clear a previously set owner; when blank, jobs created from this template will default to assigning the job creator as owner. 
+    attr_accessor :owner_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -24,7 +27,8 @@ module Phrase
         :'name' => :'name',
         :'briefing' => :'briefing',
         :'autotranslate' => :'autotranslate',
-        :'source_locale_id' => :'source_locale_id'
+        :'source_locale_id' => :'source_locale_id',
+        :'owner_id' => :'owner_id'
       }
     end
 
@@ -35,7 +39,8 @@ module Phrase
         :'name' => :'String',
         :'briefing' => :'String',
         :'autotranslate' => :'Boolean',
-        :'source_locale_id' => :'String'
+        :'source_locale_id' => :'String',
+        :'owner_id' => :'String'
       }
     end
 
@@ -79,6 +84,10 @@ module Phrase
       if attributes.key?(:'source_locale_id')
         self.source_locale_id = attributes[:'source_locale_id']
       end
+
+      if attributes.key?(:'owner_id')
+        self.owner_id = attributes[:'owner_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -108,7 +117,8 @@ module Phrase
           name == o.name &&
           briefing == o.briefing &&
           autotranslate == o.autotranslate &&
-          source_locale_id == o.source_locale_id
+          source_locale_id == o.source_locale_id &&
+          owner_id == o.owner_id
     end
 
     # @see the `==` method
@@ -120,7 +130,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branch, name, briefing, autotranslate, source_locale_id].hash
+      [branch, name, briefing, autotranslate, source_locale_id, owner_id].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/locale_create_parameters.rb

@@ -5,10 +5,10 @@ module Phrase
     # specify the branch to use
     attr_accessor :branch
 
-    # Locale name
+    # Locale name. Must be unique per project.
     attr_accessor :name
 
-    # Locale ISO code
+    # Locale ISO code. Unlike `name`, `code` is not required to be unique per project - creating a locale whose `code` duplicates an existing locale's `code` in the same project will succeed rather than error, resulting in two locales that share the same code.
     attr_accessor :code
 
     # Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale.

data/lib/phrase/models/organization_job_template_create_parameters.rb

@@ -11,12 +11,16 @@ module Phrase
     # Automatically translate the job using machine translation.
     attr_accessor :autotranslate
 
+    # Code of the account member to set as the job template owner. When omitted or blank, no owner is pre-set; the user who creates a job from this template is assigned as its owner at job-creation time. 
+    attr_accessor :owner_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
         :'briefing' => :'briefing',
-        :'autotranslate' => :'autotranslate'
+        :'autotranslate' => :'autotranslate',
+        :'owner_id' => :'owner_id'
       }
     end
 
@@ -25,7 +29,8 @@ module Phrase
       {
         :'name' => :'String',
         :'briefing' => :'String',
-        :'autotranslate' => :'Boolean'
+        :'autotranslate' => :'Boolean',
+        :'owner_id' => :'String'
       }
     end
 
@@ -61,6 +66,10 @@ module Phrase
       if attributes.key?(:'autotranslate')
         self.autotranslate = attributes[:'autotranslate']
       end
+
+      if attributes.key?(:'owner_id')
+        self.owner_id = attributes[:'owner_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -88,7 +97,8 @@ module Phrase
       self.class == o.class &&
           name == o.name &&
           briefing == o.briefing &&
-          autotranslate == o.autotranslate
+          autotranslate == o.autotranslate &&
+          owner_id == o.owner_id
     end
 
     # @see the `==` method
@@ -100,7 +110,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, briefing, autotranslate].hash
+      [name, briefing, autotranslate, owner_id].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/organization_job_template_update_parameters.rb

@@ -11,12 +11,16 @@ module Phrase
     # Automatically translate the job using machine translation.
     attr_accessor :autotranslate
 
+    # Code of the account member to set as the job template owner. Pass an empty string to clear a previously set owner; when blank, the owner is set to null and jobs created from this template will default to assigning the job creator as owner. 
+    attr_accessor :owner_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
         :'briefing' => :'briefing',
-        :'autotranslate' => :'autotranslate'
+        :'autotranslate' => :'autotranslate',
+        :'owner_id' => :'owner_id'
       }
     end
 
@@ -25,7 +29,8 @@ module Phrase
       {
         :'name' => :'String',
         :'briefing' => :'String',
-        :'autotranslate' => :'Boolean'
+        :'autotranslate' => :'Boolean',
+        :'owner_id' => :'String'
       }
     end
 
@@ -61,6 +66,10 @@ module Phrase
       if attributes.key?(:'autotranslate')
         self.autotranslate = attributes[:'autotranslate']
       end
+
+      if attributes.key?(:'owner_id')
+        self.owner_id = attributes[:'owner_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -88,7 +97,8 @@ module Phrase
       self.class == o.class &&
           name == o.name &&
           briefing == o.briefing &&
-          autotranslate == o.autotranslate
+          autotranslate == o.autotranslate &&
+          owner_id == o.owner_id
     end
 
     # @see the `==` method
@@ -100,7 +110,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, briefing, autotranslate].hash
+      [name, briefing, autotranslate, owner_id].hash
     end
 
     # Builds the object from hash