phrase 4.9.0 → 4.10.0

data/lib/phrase/models/automations_create_parameters1.rb

@@ -0,0 +1,326 @@
+require 'date'
+
+module Phrase
+  class AutomationsCreateParameters1
+    # name of the automation
+    attr_accessor :name
+
+    attr_accessor :trigger
+
+    # List of project IDs to associate with the automation. Currently, only the first ID in the array is used. The array format leaves room for future support of multiple projects. 
+    attr_accessor :project_ids
+
+    # id of job template that the automation uses to create jobs from
+    attr_accessor :job_template_id
+
+    # translation key statuses used to filter keys that are added to jobs
+    attr_accessor :status_filters
+
+    # used to filter which keys are added to jobs
+    attr_accessor :tags
+
+    # along with time_zone, specifies when the scheduled automation is supposed to run
+    attr_accessor :cron_schedule
+
+    # along with cron_schedule, specifies when the scheduled automation is supposed to run
+    attr_accessor :time_zone
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'trigger' => :'trigger',
+        :'project_ids' => :'project_ids',
+        :'job_template_id' => :'job_template_id',
+        :'status_filters' => :'status_filters',
+        :'tags' => :'tags',
+        :'cron_schedule' => :'cron_schedule',
+        :'time_zone' => :'time_zone'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'trigger' => :'String',
+        :'project_ids' => :'Array<String>',
+        :'job_template_id' => :'String',
+        :'status_filters' => :'Array<String>',
+        :'tags' => :'Array<String>',
+        :'cron_schedule' => :'String',
+        :'time_zone' => :'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::AutomationsCreateParameters1` 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::AutomationsCreateParameters1`. 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
+
+      if attributes.key?(:'trigger')
+        self.trigger = attributes[:'trigger']
+      end
+
+      if attributes.key?(:'project_ids')
+        if (value = attributes[:'project_ids']).is_a?(Array)
+          self.project_ids = value
+        end
+      end
+
+      if attributes.key?(:'job_template_id')
+        self.job_template_id = attributes[:'job_template_id']
+      end
+
+      if attributes.key?(:'status_filters')
+        if (value = attributes[:'status_filters']).is_a?(Array)
+          self.status_filters = value
+        end
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
+      if attributes.key?(:'cron_schedule')
+        self.cron_schedule = attributes[:'cron_schedule']
+      end
+
+      if attributes.key?(:'time_zone')
+        self.time_zone = attributes[:'time_zone']
+      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
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @trigger.nil?
+        invalid_properties.push('invalid value for "trigger", trigger cannot be nil.')
+      end
+
+      if @project_ids.nil?
+        invalid_properties.push('invalid value for "project_ids", project_ids cannot be nil.')
+      end
+
+      if @status_filters.nil?
+        invalid_properties.push('invalid value for "status_filters", status_filters cannot be nil.')
+      end
+
+      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?
+      return false if @name.nil?
+      return false if @trigger.nil?
+      trigger_validator = EnumAttributeValidator.new('String', ["schedule", "upload"])
+      return false unless trigger_validator.valid?(@trigger)
+      return false if @project_ids.nil?
+      return false if @status_filters.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] trigger Object to be assigned
+    def trigger=(trigger)
+      validator = EnumAttributeValidator.new('String', ["schedule", "upload"])
+      unless validator.valid?(trigger)
+        fail ArgumentError, "invalid value for \"trigger\", must be one of #{validator.allowable_values}."
+      end
+      @trigger = trigger
+    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 &&
+          trigger == o.trigger &&
+          project_ids == o.project_ids &&
+          job_template_id == o.job_template_id &&
+          status_filters == o.status_filters &&
+          tags == o.tags &&
+          cron_schedule == o.cron_schedule &&
+          time_zone == o.time_zone
+    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, trigger, project_ids, job_template_id, status_filters, tags, cron_schedule, time_zone].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 :Time
+        Time.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/translation_update_parameters.rb

@@ -20,6 +20,9 @@ module Phrase
     # Indicates whether the translation should be auto-translated. Responses with status 422 if provided for translation within a non-default locale or the project does not have the Autopilot feature enabled.
     attr_accessor :autotranslate
 
+    # When set to `true`, the translation will be marked as reviewed.
+    attr_accessor :reviewed
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -28,7 +31,8 @@ module Phrase
         :'plural_suffix' => :'plural_suffix',
         :'unverified' => :'unverified',
         :'excluded' => :'excluded',
-        :'autotranslate' => :'autotranslate'
+        :'autotranslate' => :'autotranslate',
+        :'reviewed' => :'reviewed'
       }
     end
 
@@ -40,7 +44,8 @@ module Phrase
         :'plural_suffix' => :'String',
         :'unverified' => :'Boolean',
         :'excluded' => :'Boolean',
-        :'autotranslate' => :'Boolean'
+        :'autotranslate' => :'Boolean',
+        :'reviewed' => :'Boolean'
       }
     end
 
@@ -88,6 +93,10 @@ module Phrase
       if attributes.key?(:'autotranslate')
         self.autotranslate = attributes[:'autotranslate']
       end
+
+      if attributes.key?(:'reviewed')
+        self.reviewed = attributes[:'reviewed']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -113,7 +122,8 @@ module Phrase
           plural_suffix == o.plural_suffix &&
           unverified == o.unverified &&
           excluded == o.excluded &&
-          autotranslate == o.autotranslate
+          autotranslate == o.autotranslate &&
+          reviewed == o.reviewed
     end
 
     # @see the `==` method
@@ -125,7 +135,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branch, content, plural_suffix, unverified, excluded, autotranslate].hash
+      [branch, content, plural_suffix, unverified, excluded, autotranslate, reviewed].hash
     end
 
     # Builds the object from hash

data/lib/phrase/version.rb

@@ -1,3 +1,3 @@
 module Phrase
-  VERSION = '4.9.0'
+  VERSION = '4.10.0'
 end

data/lib/phrase.rb

@@ -17,6 +17,9 @@ require 'phrase/models/authorization'
 require 'phrase/models/authorization_create_parameters'
 require 'phrase/models/authorization_update_parameters'
 require 'phrase/models/authorization_with_token'
+require 'phrase/models/automation'
+require 'phrase/models/automations_create_parameters'
+require 'phrase/models/automations_create_parameters1'
 require 'phrase/models/blacklisted_key'
 require 'phrase/models/blacklisted_key_create_parameters'
 require 'phrase/models/blacklisted_key_update_parameters'
@@ -227,6 +230,7 @@ require 'phrase/models/webhook_update_parameters'
 # APIs
 require 'phrase/api/accounts_api'
 require 'phrase/api/authorizations_api'
+require 'phrase/api/automations_api'
 require 'phrase/api/blacklisted_keys_api'
 require 'phrase/api/branches_api'
 require 'phrase/api/comment_reactions_api'

data/spec/api/automations_api_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Phrase::AutomationsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AutomationsApi' do
+  before do
+    # run before each test
+    @api_instance = Phrase::AutomationsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AutomationsApi' do
+    it 'should create an instance of AutomationsApi' do
+      expect(@api_instance).to be_instance_of(Phrase::AutomationsApi)
+    end
+  end
+
+  # unit tests for automation_activate
+  # Activate an automation
+  # @param account_id Account ID
+  # @param id ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [Automation]
+  describe 'automation_activate test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for automation_create
+  # Create an automation
+  # Create a new automation.
+  # @param account_id Account ID
+  # @param automations_create_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [Automation]
+  describe 'automation_create test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for automation_deactivate
+  # Deactivate an automation
+  # @param account_id Account ID
+  # @param id ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [Automation]
+  describe 'automation_deactivate test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for automation_delete
+  # Destroy automation
+  # Destroy an automation of an account.  This endpoint is only available to accounts with advanced plans or above. 
+  # @param account_id Account ID
+  # @param id ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [nil]
+  describe 'automation_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for automation_show
+  # Get a single automation
+  # Get details of a single automation.
+  # @param account_id Account ID
+  # @param id ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [Automation]
+  describe 'automation_show test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for automation_update
+  # Update an automation
+  # Update an existing automation.
+  # @param account_id Account ID
+  # @param id ID
+  # @param automations_create_parameters1 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [Automation]
+  describe 'automation_update test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for automations_list
+  # List automations
+  # List all automations for an account.  This endpoint is only available to accounts with advanced plans or above. 
+  # @param account_id 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<Automation>]
+  describe 'automations_list test' 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/automation_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Phrase::Automation
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'Automation' do
+  before do
+    # run before each test
+    @instance = Phrase::Automation.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Automation' do
+    it 'should create an instance of Automation' do
+      expect(@instance).to be_instance_of(Phrase::Automation)
+    end
+  end
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "status"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["inactive", "active", "error"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.status = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "trigger"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["schedule", "upload"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.trigger = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "status_filters"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('Array<String>', ["unverified", "untranslated", "ready_for_review"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.status_filters = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "project_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "job_template_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "tags"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "cron_schedule"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "time_zone"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "account"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "created_at"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "updated_at"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end