phrase 1.0.6 → 1.0.11

data/docs/ScreenshotsApi.md

@@ -294,7 +294,8 @@ project_id = 'project_id_example' # String | Project 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 | allows you to specify a page size up to 100 items, 25 by default
+  per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
+  key_id: 'abcd1234cdef1234abcd1234cdef1234' # String | filter by key
 }
 
 begin
@@ -315,6 +316,7 @@ Name | Type | Description  | Notes
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
  **page** | **Integer**| Page number | [optional] 
  **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional] 
+ **key_id** | **String**| filter by key | [optional] 
 
 ### Return type
 

data/docs/Webhook.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **description** | **String** |  | [optional] 
 **events** | **Array<String>** |  | [optional] 
 **active** | **Boolean** |  | [optional] 
+**include_branches** | **Boolean** |  | [optional] 
 **created_at** | **DateTime** |  | [optional] 
 **updated_at** | **DateTime** |  | [optional] 
 
@@ -22,6 +23,7 @@ instance = Phrase::Webhook.new(id: null,
                                  description: null,
                                  events: null,
                                  active: null,
+                                 include_branches: null,
                                  created_at: null,
                                  updated_at: null)
 ```

data/docs/WebhookCreateParameters.md

@@ -5,9 +5,11 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **callback_url** | **String** | Callback URL to send requests to | [optional] 
+**secret** | **String** | Webhook secret used to calculate signature. If empty, the default project secret will be used. | [optional] 
 **description** | **String** | Webhook description | [optional] 
 **events** | **String** | List of event names to trigger the webhook (separated by comma) | [optional] 
 **active** | **Boolean** | Whether webhook is active or inactive | [optional] 
+**include_branches** | **Boolean** | If enabled, webhook will also be triggered for events from branches of the project specified. | [optional] 
 
 ## Code Sample
 
@@ -15,9 +17,11 @@ Name | Type | Description | Notes
 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)
+                                 active: null,
+                                 include_branches: null)
 ```
 
 

data/docs/WebhookUpdateParameters.md

@@ -5,9 +5,11 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **callback_url** | **String** | Callback URL to send requests to | [optional] 
+**secret** | **String** | Webhook secret used to calculate signature. If empty, the default project secret will be used. | [optional] 
 **description** | **String** | Webhook description | [optional] 
 **events** | **String** | List of event names to trigger the webhook (separated by comma) | [optional] 
 **active** | **Boolean** | Whether webhook is active or inactive | [optional] 
+**include_branches** | **Boolean** | If enabled, webhook will also be triggered for events from branches of the project specified. | [optional] 
 
 ## Code Sample
 
@@ -15,9 +17,11 @@ Name | Type | Description | Notes
 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)
+                                 active: null,
+                                 include_branches: null)
 ```
 
 

data/lib/phrase.rb

@@ -28,6 +28,7 @@ require 'phrase/models/blacklisted_key_update_parameters'
 require 'phrase/models/branch'
 require 'phrase/models/branch_create_parameters'
 require 'phrase/models/branch_merge_parameters'
+require 'phrase/models/branch_name'
 require 'phrase/models/branch_update_parameters'
 require 'phrase/models/comment'
 require 'phrase/models/comment_create_parameters'
@@ -89,7 +90,11 @@ require 'phrase/models/locale_preview'
 require 'phrase/models/locale_statistics'
 require 'phrase/models/locale_update_parameters'
 require 'phrase/models/member'
+require 'phrase/models/member_project_detail'
+require 'phrase/models/member_project_detail_project_roles'
+require 'phrase/models/member_spaces'
 require 'phrase/models/member_update_parameters'
+require 'phrase/models/member_update_settings_parameters'
 require 'phrase/models/order_confirm_parameters'
 require 'phrase/models/order_create_parameters'
 require 'phrase/models/project'

data/lib/phrase/api/locales_api.rb

@@ -165,6 +165,7 @@ module Phrase
     # @option opts [String] :tags Limit results to keys tagged with a list of comma separated tag names.
     # @option opts [String] :tag Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead
     # @option opts [Boolean] :include_empty_translations Indicates whether keys without translations should be included in the output as well.
+    # @option opts [Boolean] :exclude_empty_zero_forms Indicates whether zero forms should be included when empty in pluralized keys.
     # @option opts [Boolean] :include_translated_keys Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
     # @option opts [Boolean] :keep_notranslate_tags Indicates whether [NOTRANSLATE] tags should be kept.
     # @option opts [Boolean] :convert_emoji This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.
@@ -191,6 +192,7 @@ module Phrase
     # @option opts [String] :tags Limit results to keys tagged with a list of comma separated tag names.
     # @option opts [String] :tag Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead
     # @option opts [Boolean] :include_empty_translations Indicates whether keys without translations should be included in the output as well.
+    # @option opts [Boolean] :exclude_empty_zero_forms Indicates whether zero forms should be included when empty in pluralized keys.
     # @option opts [Boolean] :include_translated_keys Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
     # @option opts [Boolean] :keep_notranslate_tags Indicates whether [NOTRANSLATE] tags should be kept.
     # @option opts [Boolean] :convert_emoji This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.
@@ -223,6 +225,7 @@ module Phrase
       query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?
       query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
       query_params[:'include_empty_translations'] = opts[:'include_empty_translations'] if !opts[:'include_empty_translations'].nil?
+      query_params[:'exclude_empty_zero_forms'] = opts[:'exclude_empty_zero_forms'] if !opts[:'exclude_empty_zero_forms'].nil?
       query_params[:'include_translated_keys'] = opts[:'include_translated_keys'] if !opts[:'include_translated_keys'].nil?
       query_params[:'keep_notranslate_tags'] = opts[:'keep_notranslate_tags'] if !opts[:'keep_notranslate_tags'].nil?
       query_params[:'convert_emoji'] = opts[:'convert_emoji'] if !opts[:'convert_emoji'].nil?

data/lib/phrase/api/members_api.rb

@@ -229,6 +229,86 @@ module Phrase
       return response, status_code, headers
     end
 
+    # Update a member's project settings
+    # Update user settings in the project. Access token scope must include <code>team.manage</code>.
+    # @param project_id [String] Project ID
+    # @param id [String] ID
+    # @param member_update_settings_parameters [MemberUpdateSettingsParameters] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @return [MemberProjectDetail]
+    def member_update_settings(project_id, id, member_update_settings_parameters, opts = {})
+      data, _status_code, _headers = member_update_settings_with_http_info(project_id, id, member_update_settings_parameters, opts)
+      data
+    end
+
+    # Update a member&#39;s project settings
+    # Update user settings in the project. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.
+    # @param project_id [String] Project ID
+    # @param id [String] ID
+    # @param member_update_settings_parameters [MemberUpdateSettingsParameters] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @return [Array<(Response<(MemberProjectDetail)>, Integer, Hash)>] Response<(MemberProjectDetail)> data, response status code and response headers
+    def member_update_settings_with_http_info(project_id, id, member_update_settings_parameters, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MembersApi.member_update_settings ...'
+      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.member_update_settings"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling MembersApi.member_update_settings"
+      end
+      # verify the required parameter 'member_update_settings_parameters' is set
+      if @api_client.config.client_side_validation && member_update_settings_parameters.nil?
+        fail ArgumentError, "Missing the required parameter 'member_update_settings_parameters' when calling MembersApi.member_update_settings"
+      end
+      # resource path
+      local_var_path = '/projects/{project_id}/members/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # 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'])
+      # 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] || @api_client.object_to_http_body(member_update_settings_parameters) 
+
+      # return_type
+      return_type = opts[:return_type] || 'MemberProjectDetail' 
+
+      # 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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MembersApi#member_update_settings\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 <code>team.manage</code>.
     # @param account_id [String] Account ID

data/lib/phrase/api/screenshots_api.rb

@@ -310,6 +310,7 @@ module Phrase
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
     # @option opts [Integer] :page Page number
     # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
+    # @option opts [String] :key_id filter by key
     # @return [Array<Screenshot>]
     def screenshots_list(project_id, opts = {})
       data, _status_code, _headers = screenshots_list_with_http_info(project_id, opts)
@@ -323,6 +324,7 @@ module Phrase
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
     # @option opts [Integer] :page Page number
     # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
+    # @option opts [String] :key_id filter by key
     # @return [Array<(Response<(Array<Screenshot>)>, Integer, Hash)>] Response<(Array<Screenshot>)> data, response status code and response headers
     def screenshots_list_with_http_info(project_id, opts = {})
       if @api_client.config.debugging
@@ -339,6 +341,7 @@ module Phrase
       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?
+      query_params[:'key_id'] = opts[:'key_id'] if !opts[:'key_id'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/phrase/api_client.rb

@@ -131,6 +131,8 @@ module Phrase
           when ::File, ::Tempfile, ::Array, nil
             # let typhoeus handle File, Tempfile, Array and nil parameters
             data[key] = value
+          when ::Hash
+            data[key] = build_request_body(header_params, value, body)
           else
             data[key] = value.to_s
           end

data/lib/phrase/models/branch_name.rb

@@ -0,0 +1,194 @@
+require 'date'
+
+module Phrase
+  class BranchName
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'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::BranchName` 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::BranchName`. 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?(:'name')
+        self.name = attributes[:'name']
+      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 &&
+          name == o.name
+    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
+      [name].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/invitation.rb

@@ -14,6 +14,8 @@ module Phrase
 
     attr_accessor :locales
 
+    attr_accessor :default_locale_codes
+
     attr_accessor :permissions
 
     attr_accessor :created_at
@@ -22,6 +24,8 @@ module Phrase
 
     attr_accessor :accepted_at
 
+    attr_accessor :spaces
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -31,10 +35,12 @@ module Phrase
         :'state' => :'state',
         :'projects' => :'projects',
         :'locales' => :'locales',
+        :'default_locale_codes' => :'default_locale_codes',
         :'permissions' => :'permissions',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at',
-        :'accepted_at' => :'accepted_at'
+        :'accepted_at' => :'accepted_at',
+        :'spaces' => :'spaces'
       }
     end
 
@@ -47,10 +53,12 @@ module Phrase
         :'state' => :'String',
         :'projects' => :'Array<ProjectShort>',
         :'locales' => :'Array<LocalePreview>',
+        :'default_locale_codes' => :'Array<String>',
         :'permissions' => :'Object',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime',
-        :'accepted_at' => :'DateTime'
+        :'accepted_at' => :'DateTime',
+        :'spaces' => :'Array<MemberSpaces>'
       }
     end
 
@@ -103,6 +111,12 @@ module Phrase
         end
       end
 
+      if attributes.key?(:'default_locale_codes')
+        if (value = attributes[:'default_locale_codes']).is_a?(Array)
+          self.default_locale_codes = value
+        end
+      end
+
       if attributes.key?(:'permissions')
         self.permissions = attributes[:'permissions']
       end
@@ -118,6 +132,12 @@ module Phrase
       if attributes.key?(:'accepted_at')
         self.accepted_at = attributes[:'accepted_at']
       end
+
+      if attributes.key?(:'spaces')
+        if (value = attributes[:'spaces']).is_a?(Array)
+          self.spaces = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -144,10 +164,12 @@ module Phrase
           state == o.state &&
           projects == o.projects &&
           locales == o.locales &&
+          default_locale_codes == o.default_locale_codes &&
           permissions == o.permissions &&
           created_at == o.created_at &&
           updated_at == o.updated_at &&
-          accepted_at == o.accepted_at
+          accepted_at == o.accepted_at &&
+          spaces == o.spaces
     end
 
     # @see the `==` method
@@ -159,7 +181,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, email, role, state, projects, locales, permissions, created_at, updated_at, accepted_at].hash
+      [id, email, role, state, projects, locales, default_locale_codes, permissions, created_at, updated_at, accepted_at, spaces].hash
     end
 
     # Builds the object from hash