phrase 2.7.0 → 2.8.0

data/lib/phrase/models/webhook_delivery.rb

@@ -0,0 +1,248 @@
+require 'date'
+
+module Phrase
+  class WebhookDelivery
+    attr_accessor :id
+
+    attr_accessor :webhook_id
+
+    attr_accessor :response_status_code
+
+    attr_accessor :delivered_at
+
+    attr_accessor :duration_ms
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'webhook_id' => :'webhook_id',
+        :'response_status_code' => :'response_status_code',
+        :'delivered_at' => :'delivered_at',
+        :'duration_ms' => :'duration_ms',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'webhook_id' => :'String',
+        :'response_status_code' => :'Integer',
+        :'delivered_at' => :'DateTime',
+        :'duration_ms' => :'Integer',
+        :'created_at' => :'DateTime',
+        :'updated_at' => :'DateTime'
+      }
+    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::WebhookDelivery` 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::WebhookDelivery`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'webhook_id')
+        self.webhook_id = attributes[:'webhook_id']
+      end
+
+      if attributes.key?(:'response_status_code')
+        self.response_status_code = attributes[:'response_status_code']
+      end
+
+      if attributes.key?(:'delivered_at')
+        self.delivered_at = attributes[:'delivered_at']
+      end
+
+      if attributes.key?(:'duration_ms')
+        self.duration_ms = attributes[:'duration_ms']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      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 &&
+          id == o.id &&
+          webhook_id == o.webhook_id &&
+          response_status_code == o.response_status_code &&
+          delivered_at == o.delivered_at &&
+          duration_ms == o.duration_ms &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    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
+      [id, webhook_id, response_status_code, delivered_at, duration_ms, created_at, updated_at].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.7.0'
+  VERSION = '2.8.0'
 end

data/lib/phrase.rb

@@ -67,6 +67,9 @@ require 'phrase/models/invitation_create_parameters'
 require 'phrase/models/invitation_update_parameters'
 require 'phrase/models/invitation_update_settings_parameters'
 require 'phrase/models/job'
+require 'phrase/models/job_comment'
+require 'phrase/models/job_comment_create_parameters'
+require 'phrase/models/job_comment_update_parameters'
 require 'phrase/models/job_complete_parameters'
 require 'phrase/models/job_create_parameters'
 require 'phrase/models/job_details'
@@ -196,6 +199,7 @@ require 'phrase/models/variable_create_parameters'
 require 'phrase/models/variable_update_parameters'
 require 'phrase/models/webhook'
 require 'phrase/models/webhook_create_parameters'
+require 'phrase/models/webhook_delivery'
 require 'phrase/models/webhook_update_parameters'
 
 # APIs
@@ -215,6 +219,7 @@ require 'phrase/api/glossary_term_translations_api'
 require 'phrase/api/glossary_terms_api'
 require 'phrase/api/icu_api'
 require 'phrase/api/invitations_api'
+require 'phrase/api/job_comments_api'
 require 'phrase/api/job_locales_api'
 require 'phrase/api/job_template_locales_api'
 require 'phrase/api/job_templates_api'
@@ -239,6 +244,7 @@ require 'phrase/api/uploads_api'
 require 'phrase/api/users_api'
 require 'phrase/api/variables_api'
 require 'phrase/api/versions_history_api'
+require 'phrase/api/webhook_deliveries_api'
 require 'phrase/api/webhooks_api'
 
 module Phrase

data/spec/api/blacklisted_keys_api_spec.rb

@@ -21,8 +21,8 @@ describe 'BlacklistedKeysApi' do
   end
 
   # unit tests for blacklisted_key_create
-  # Create a blacklisted key
-  # Create a new rule for blacklisting keys.
+  # Create a blocked key
+  # Create a new rule for blocking keys.
   # @param project_id Project ID
   # @param blacklisted_key_create_parameters 
   # @param [Hash] opts the optional parameters
@@ -35,8 +35,8 @@ describe 'BlacklistedKeysApi' do
   end
 
   # unit tests for blacklisted_key_delete
-  # Delete a blacklisted key
-  # Delete an existing rule for blacklisting keys.
+  # Delete a blocked key
+  # Delete an existing rule for blocking keys.
   # @param project_id Project ID
   # @param id ID
   # @param [Hash] opts the optional parameters
@@ -49,8 +49,8 @@ describe 'BlacklistedKeysApi' do
   end
 
   # unit tests for blacklisted_key_show
-  # Get a single blacklisted key
-  # Get details on a single rule for blacklisting keys for a given project.
+  # Get a single blocked key
+  # Get details on a single rule for blocking keys for a given project.
   # @param project_id Project ID
   # @param id ID
   # @param [Hash] opts the optional parameters
@@ -63,8 +63,8 @@ describe 'BlacklistedKeysApi' do
   end
 
   # unit tests for blacklisted_key_update
-  # Update a blacklisted key
-  # Update an existing rule for blacklisting keys.
+  # Update a blocked key
+  # Update an existing rule for blocking keys.
   # @param project_id Project ID
   # @param id ID
   # @param blacklisted_key_update_parameters 
@@ -78,8 +78,8 @@ describe 'BlacklistedKeysApi' do
   end
 
   # unit tests for blacklisted_keys_list
-  # List blacklisted keys
-  # List all rules for blacklisting keys for the given project.
+  # List blocked keys
+  # List all rules for blocking keys for the given project.
   # @param project_id Project ID
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)

data/spec/api/glossaries_api_spec.rb

@@ -21,8 +21,8 @@ describe 'GlossariesApi' do
   end
 
   # unit tests for glossaries_list
-  # List glossaries
-  # List all glossaries the current user has access to.
+  # List term bases
+  # List all term bases (previously: glossaries) the current user has access to.
   # @param account_id Account ID
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
@@ -36,8 +36,8 @@ describe 'GlossariesApi' do
   end
 
   # unit tests for glossary_create
-  # Create a glossary
-  # Create a new glossary.
+  # Create a term base
+  # Create a new term base (previously: glossary).
   # @param account_id Account ID
   # @param glossary_create_parameters 
   # @param [Hash] opts the optional parameters
@@ -50,8 +50,8 @@ describe 'GlossariesApi' do
   end
 
   # unit tests for glossary_delete
-  # Delete a glossary
-  # Delete an existing glossary.
+  # Delete a term base
+  # Delete an existing term base (previously: glossary).
   # @param account_id Account ID
   # @param id ID
   # @param [Hash] opts the optional parameters
@@ -64,8 +64,8 @@ describe 'GlossariesApi' do
   end
 
   # unit tests for glossary_show
-  # Get a single glossary
-  # Get details on a single glossary.
+  # Get a single term base
+  # Get details on a single term base (previously: glossary).
   # @param account_id Account ID
   # @param id ID
   # @param [Hash] opts the optional parameters
@@ -78,8 +78,8 @@ describe 'GlossariesApi' do
   end
 
   # unit tests for glossary_update
-  # Update a glossary
-  # Update an existing glossary.
+  # Update a term base
+  # Update an existing term base (previously: glossary).
   # @param account_id Account ID
   # @param id ID
   # @param glossary_update_parameters 

data/spec/api/glossary_term_translations_api_spec.rb

@@ -21,8 +21,8 @@ describe 'GlossaryTermTranslationsApi' do
   end
 
   # unit tests for glossary_term_translation_create
-  # Create a glossary term translation
-  # Create a new glossary term translation.
+  # Create a translation for a term
+  # Create a new translation for a term in a term base (previously: glossary).
   # @param account_id Account ID
   # @param glossary_id Glossary ID
   # @param term_id Term ID
@@ -37,8 +37,8 @@ describe 'GlossaryTermTranslationsApi' do
   end
 
   # unit tests for glossary_term_translation_delete
-  # Delete a glossary term translation
-  # Delete an existing glossary term translation.
+  # Delete a translation for a term
+  # Delete an existing translation of a term in a term base (previously: glossary).
   # @param account_id Account ID
   # @param glossary_id Glossary ID
   # @param term_id Term ID
@@ -53,8 +53,8 @@ describe 'GlossaryTermTranslationsApi' do
   end
 
   # unit tests for glossary_term_translation_update
-  # Update a glossary term translation
-  # Update an existing glossary term translation.
+  # Update a translation for a term
+  # Update an existing translation for a term in a term base (previously: glossary).
   # @param account_id Account ID
   # @param glossary_id Glossary ID
   # @param term_id Term ID

data/spec/api/glossary_terms_api_spec.rb

@@ -21,8 +21,8 @@ describe 'GlossaryTermsApi' do
   end
 
   # unit tests for glossary_term_create
-  # Create a glossary term
-  # Create a new glossary term.
+  # Create a term
+  # Create a new term in a term base (previously: glossary).
   # @param account_id Account ID
   # @param glossary_id Glossary ID
   # @param glossary_term_create_parameters 
@@ -36,8 +36,8 @@ describe 'GlossaryTermsApi' do
   end
 
   # unit tests for glossary_term_delete
-  # Delete a glossary term
-  # Delete an existing glossary term.
+  # Delete a term
+  # Delete an existing term in a term base (previously: glossary).
   # @param account_id Account ID
   # @param glossary_id Glossary ID
   # @param id ID
@@ -51,8 +51,8 @@ describe 'GlossaryTermsApi' do
   end
 
   # unit tests for glossary_term_show
-  # Get a single glossary term
-  # Get details on a single glossary term.
+  # Get a single term
+  # Get details for a single term in the term base (previously: glossary).
   # @param account_id Account ID
   # @param glossary_id Glossary ID
   # @param id ID
@@ -66,8 +66,8 @@ describe 'GlossaryTermsApi' do
   end
 
   # unit tests for glossary_term_update
-  # Update a glossary term
-  # Update an existing glossary term.
+  # Update a term
+  # Update an existing term in a term base (previously: glossary).
   # @param account_id Account ID
   # @param glossary_id Glossary ID
   # @param id ID
@@ -82,8 +82,8 @@ describe 'GlossaryTermsApi' do
   end
 
   # unit tests for glossary_terms_list
-  # List glossary terms
-  # List all glossary terms the current user has access to.
+  # List terms
+  # List all terms in term bases (previously: glossary) that the current user has access to.
   # @param account_id Account ID
   # @param glossary_id Glossary ID
   # @param [Hash] opts the optional parameters

data/spec/api/job_comments_api_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Phrase::JobCommentsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'JobCommentsApi' do
+  before do
+    # run before each test
+    @api_instance = Phrase::JobCommentsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of JobCommentsApi' do
+    it 'should create an instance of JobCommentsApi' do
+      expect(@api_instance).to be_instance_of(Phrase::JobCommentsApi)
+    end
+  end
+
+  # unit tests for job_comment_create
+  # Create a job comment
+  # Create a new comment for a job.
+  # @param project_id Project ID
+  # @param job_id Job ID
+  # @param job_comment_create_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [JobComment]
+  describe 'job_comment_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 job_comment_delete
+  # Delete a job comment
+  # Delete an existing job comment.
+  # @param project_id Project ID
+  # @param job_id Job ID
+  # @param id ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @option opts [String] :branch specify the branch to use
+  # @return [nil]
+  describe 'job_comment_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 job_comment_show
+  # Get a single job comment
+  # Get details on a single job comment.
+  # @param project_id Project ID
+  # @param job_id Job ID
+  # @param id ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @option opts [String] :branch specify the branch to use
+  # @return [Object]
+  describe 'job_comment_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 job_comment_update
+  # Update a job comment
+  # Update an existing job comment.
+  # @param project_id Project ID
+  # @param key_id Translation Key ID
+  # @param id ID
+  # @param job_comment_update_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [Object]
+  describe 'job_comment_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 job_comments_list
+  # List job comments
+  # List all comments for a job.
+  # @param project_id Project ID
+  # @param job_id Job ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @option opts [String] :branch specify the branch to use
+  # @return [Array<Object>]
+  describe 'job_comments_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/api/screenshots_api_spec.rb

@@ -24,9 +24,12 @@ describe 'ScreenshotsApi' do
   # Create a screenshot
   # Create a new screenshot.
   # @param project_id Project ID
-  # @param screenshot_create_parameters 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @option opts [String] :branch specify the branch to use
+  # @option opts [String] :name Name of the screenshot
+  # @option opts [String] :description Description of the screenshot
+  # @option opts [File] :filename Screenshot file
   # @return [Screenshot]
   describe 'screenshot_create test' do
     it 'should work' do

data/spec/api/versions_history_api_spec.rb

@@ -38,7 +38,7 @@ describe 'VersionsHistoryApi' do
 
   # unit tests for versions_list
   # List all versions
-  # List all versions for the given translation.
+  # List all changes done to a given translation.
   # @param project_id Project ID
   # @param translation_id Translation ID
   # @param [Hash] opts the optional parameters

data/spec/api/webhook_deliveries_api_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Phrase::WebhookDeliveriesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'WebhookDeliveriesApi' do
+  before do
+    # run before each test
+    @api_instance = Phrase::WebhookDeliveriesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of WebhookDeliveriesApi' do
+    it 'should create an instance of WebhookDeliveriesApi' do
+      expect(@api_instance).to be_instance_of(Phrase::WebhookDeliveriesApi)
+    end
+  end
+
+  # unit tests for webhook_deliveries_list
+  # List webhook deliveries
+  # List all webhook deliveries for the given webhook_id.
+  # @param project_id Project ID
+  # @param webhook_id Webhook ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @option opts [String] :response_status_codes List of Response Status Codes
+  # @return [Array<WebhookDelivery>]
+  describe 'webhook_deliveries_list 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 webhook_deliveries_redeliver
+  # Redeliver a single webhook delivery
+  # Trigger an individual webhook delivery to be redelivered.
+  # @param project_id Project ID
+  # @param webhook_id Webhook ID
+  # @param id ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [WebhookDelivery]
+  describe 'webhook_deliveries_redeliver 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 webhook_deliveries_show
+  # Get a single webhook delivery
+  # Get all information about a single webhook delivery for the given ID.
+  # @param project_id Project ID
+  # @param webhook_id Webhook ID
+  # @param id ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [WebhookDelivery]
+  describe 'webhook_deliveries_show test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end