phrase 2.0.0 → 2.3.1

data/lib/phrase/api/projects_api.rb

@@ -285,6 +285,9 @@ 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] :account_id Filter by Account ID
+    # @option opts [String] :sort_by Sort projects. Valid options are \"name_asc\", \"name_desc\", \"updated_at_asc\", \"updated_at_desc\", \"space_asc\" and \"space_desc\".
+    # @option opts [Array<String>] :filters Filter projects. Valid options are [\&quot;favorites\&quot;].
     # @return [Array<Project>]
     def projects_list(opts = {})
       data, _status_code, _headers = projects_list_with_http_info(opts)
@@ -297,6 +300,9 @@ 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] :account_id Filter by Account ID
+    # @option opts [String] :sort_by Sort projects. Valid options are \&quot;name_asc\&quot;, \&quot;name_desc\&quot;, \&quot;updated_at_asc\&quot;, \&quot;updated_at_desc\&quot;, \&quot;space_asc\&quot; and \&quot;space_desc\&quot;.
+    # @option opts [Array<String>] :filters Filter projects. Valid options are [\&quot;favorites\&quot;].
     # @return [Array<(Response<(Array<Project>)>, Integer, Hash)>] Response<(Array<Project>)> data, response status code and response headers
     def projects_list_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -309,6 +315,9 @@ 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[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
+      query_params[:'sort_by'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
+      query_params[:'filters'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/phrase/api/search_api.rb

@@ -0,0 +1,84 @@
+require 'cgi'
+
+module Phrase
+  class SearchApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Search across projects
+    # Search for keys and translations in all account projects
+    # @param account_id [String] Account ID
+    # @param search_in_account_parameters [SearchInAccountParameters] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @return [AccountSearchResult]
+    def search_in_account(account_id, search_in_account_parameters, opts = {})
+      data, _status_code, _headers = search_in_account_with_http_info(account_id, search_in_account_parameters, opts)
+      data
+    end
+
+    # Search across projects
+    # Search for keys and translations in all account projects
+    # @param account_id [String] Account ID
+    # @param search_in_account_parameters [SearchInAccountParameters] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @return [Array<(Response<(AccountSearchResult)>, Integer, Hash)>] Response<(AccountSearchResult)> data, response status code and response headers
+    def search_in_account_with_http_info(account_id, search_in_account_parameters, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SearchApi.search_in_account ...'
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling SearchApi.search_in_account"
+      end
+      # verify the required parameter 'search_in_account_parameters' is set
+      if @api_client.config.client_side_validation && search_in_account_parameters.nil?
+        fail ArgumentError, "Missing the required parameter 'search_in_account_parameters' when calling SearchApi.search_in_account"
+      end
+      # resource path
+      local_var_path = '/accounts/{account_id}/search'.sub('{' + 'account_id' + '}', CGI.escape(account_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(search_in_account_parameters) 
+
+      # return_type
+      return_type = opts[:return_type] || 'AccountSearchResult' 
+
+      # 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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#search_in_account\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/account.rb

@@ -14,6 +14,8 @@ module Phrase
 
     attr_accessor :updated_at
 
+    attr_accessor :company_logo_url
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -22,7 +24,8 @@ module Phrase
         :'slug' => :'slug',
         :'company' => :'company',
         :'created_at' => :'created_at',
-        :'updated_at' => :'updated_at'
+        :'updated_at' => :'updated_at',
+        :'company_logo_url' => :'company_logo_url'
       }
     end
 
@@ -34,7 +37,8 @@ module Phrase
         :'slug' => :'String',
         :'company' => :'String',
         :'created_at' => :'DateTime',
-        :'updated_at' => :'DateTime'
+        :'updated_at' => :'DateTime',
+        :'company_logo_url' => :'String'
       }
     end
 
@@ -82,6 +86,10 @@ module Phrase
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       end
+
+      if attributes.key?(:'company_logo_url')
+        self.company_logo_url = attributes[:'company_logo_url']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -107,7 +115,8 @@ module Phrase
           slug == o.slug &&
           company == o.company &&
           created_at == o.created_at &&
-          updated_at == o.updated_at
+          updated_at == o.updated_at &&
+          company_logo_url == o.company_logo_url
     end
 
     # @see the `==` method
@@ -119,7 +128,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, slug, company, created_at, updated_at].hash
+      [id, name, slug, company, created_at, updated_at, company_logo_url].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/account_details.rb

@@ -14,6 +14,10 @@ module Phrase
 
     attr_accessor :updated_at
 
+    attr_accessor :company_logo_url
+
+    attr_accessor :subscription
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -22,7 +26,9 @@ module Phrase
         :'slug' => :'slug',
         :'company' => :'company',
         :'created_at' => :'created_at',
-        :'updated_at' => :'updated_at'
+        :'updated_at' => :'updated_at',
+        :'company_logo_url' => :'company_logo_url',
+        :'subscription' => :'subscription'
       }
     end
 
@@ -34,7 +40,9 @@ module Phrase
         :'slug' => :'String',
         :'company' => :'String',
         :'created_at' => :'DateTime',
-        :'updated_at' => :'DateTime'
+        :'updated_at' => :'DateTime',
+        :'company_logo_url' => :'String',
+        :'subscription' => :'Subscription'
       }
     end
 
@@ -90,6 +98,14 @@ module Phrase
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       end
+
+      if attributes.key?(:'company_logo_url')
+        self.company_logo_url = attributes[:'company_logo_url']
+      end
+
+      if attributes.key?(:'subscription')
+        self.subscription = attributes[:'subscription']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -115,7 +131,9 @@ module Phrase
           slug == o.slug &&
           company == o.company &&
           created_at == o.created_at &&
-          updated_at == o.updated_at
+          updated_at == o.updated_at &&
+          company_logo_url == o.company_logo_url &&
+          subscription == o.subscription
     end
 
     # @see the `==` method
@@ -127,7 +145,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, slug, company, created_at, updated_at].hash
+      [id, name, slug, company, created_at, updated_at, company_logo_url, subscription].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/account_details1.rb

@@ -2,11 +2,14 @@ require 'date'
 
 module Phrase
   class AccountDetails1
+    attr_accessor :subscription
+
     attr_accessor :slug
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'subscription' => :'subscription',
         :'slug' => :'slug'
       }
     end
@@ -14,6 +17,7 @@ module Phrase
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'subscription' => :'Subscription',
         :'slug' => :'String'
       }
     end
@@ -39,6 +43,10 @@ module Phrase
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'subscription')
+        self.subscription = attributes[:'subscription']
+      end
+
       if attributes.key?(:'slug')
         self.slug = attributes[:'slug']
       end
@@ -62,6 +70,7 @@ module Phrase
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          subscription == o.subscription &&
           slug == o.slug
     end
 
@@ -74,7 +83,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [slug].hash
+      [subscription, slug].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/account_search_result.rb

@@ -0,0 +1,250 @@
+require 'date'
+
+module Phrase
+  class AccountSearchResult
+    attr_accessor :query
+
+    attr_accessor :excerpt
+
+    attr_accessor :key
+
+    attr_accessor :locale
+
+    attr_accessor :project
+
+    attr_accessor :translation
+
+    attr_accessor :other_translations
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'query' => :'query',
+        :'excerpt' => :'excerpt',
+        :'key' => :'key',
+        :'locale' => :'locale',
+        :'project' => :'project',
+        :'translation' => :'translation',
+        :'other_translations' => :'other_translations'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'query' => :'String',
+        :'excerpt' => :'String',
+        :'key' => :'KeyPreview',
+        :'locale' => :'LocalePreview',
+        :'project' => :'Project',
+        :'translation' => :'Translation',
+        :'other_translations' => :'Array<Translation>'
+      }
+    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::AccountSearchResult` 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::AccountSearchResult`. 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?(:'query')
+        self.query = attributes[:'query']
+      end
+
+      if attributes.key?(:'excerpt')
+        self.excerpt = attributes[:'excerpt']
+      end
+
+      if attributes.key?(:'key')
+        self.key = attributes[:'key']
+      end
+
+      if attributes.key?(:'locale')
+        self.locale = attributes[:'locale']
+      end
+
+      if attributes.key?(:'project')
+        self.project = attributes[:'project']
+      end
+
+      if attributes.key?(:'translation')
+        self.translation = attributes[:'translation']
+      end
+
+      if attributes.key?(:'other_translations')
+        if (value = attributes[:'other_translations']).is_a?(Array)
+          self.other_translations = 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 &&
+          query == o.query &&
+          excerpt == o.excerpt &&
+          key == o.key &&
+          locale == o.locale &&
+          project == o.project &&
+          translation == o.translation &&
+          other_translations == o.other_translations
+    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
+      [query, excerpt, key, locale, project, translation, other_translations].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