phrase 2.16.0 → 2.18.0

data/lib/phrase/models/figma_attachment_update_parameters.rb

@@ -0,0 +1,205 @@
+require 'date'
+
+module Phrase
+  class FigmaAttachmentUpdateParameters
+    # specify the branch to use
+    attr_accessor :branch
+
+    # Figma file url
+    attr_accessor :url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'branch' => :'branch',
+        :'url' => :'url'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'branch' => :'String',
+        :'url' => :'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::FigmaAttachmentUpdateParameters` 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::FigmaAttachmentUpdateParameters`. 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?(:'branch')
+        self.branch = attributes[:'branch']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      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 &&
+          branch == o.branch &&
+          url == o.url
+    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
+      [branch, url].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/replies_list_parameters.rb

@@ -11,12 +11,16 @@ module Phrase
     # Specify filters to find comments by
     attr_accessor :filters
 
+    # Specify ordering of comments
+    attr_accessor :order
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'branch' => :'branch',
         :'query' => :'query',
-        :'filters' => :'filters'
+        :'filters' => :'filters',
+        :'order' => :'order'
       }
     end
 
@@ -25,7 +29,8 @@ module Phrase
       {
         :'branch' => :'String',
         :'query' => :'String',
-        :'filters' => :'Array<String>'
+        :'filters' => :'Array<String>',
+        :'order' => :'String'
       }
     end
 
@@ -63,6 +68,10 @@ module Phrase
           self.filters = value
         end
       end
+
+      if attributes.key?(:'order')
+        self.order = attributes[:'order']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -85,7 +94,8 @@ module Phrase
       self.class == o.class &&
           branch == o.branch &&
           query == o.query &&
-          filters == o.filters
+          filters == o.filters &&
+          order == o.order
     end
 
     # @see the `==` method
@@ -97,7 +107,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [branch, query, filters].hash
+      [branch, query, filters, order].hash
     end
 
     # Builds the object from hash

data/lib/phrase/version.rb

@@ -1,3 +1,3 @@
 module Phrase
-  VERSION = '2.16.0'
+  VERSION = '2.18.0'
 end

data/lib/phrase.rb

@@ -43,6 +43,9 @@ require 'phrase/models/distribution_create_parameters'
 require 'phrase/models/distribution_preview'
 require 'phrase/models/distribution_update_parameters'
 require 'phrase/models/document'
+require 'phrase/models/figma_attachment'
+require 'phrase/models/figma_attachment_create_parameters'
+require 'phrase/models/figma_attachment_update_parameters'
 require 'phrase/models/format'
 require 'phrase/models/github_sync_export_parameters'
 require 'phrase/models/github_sync_import_parameters'
@@ -226,6 +229,7 @@ require 'phrase/api/comment_replies_api'
 require 'phrase/api/comments_api'
 require 'phrase/api/distributions_api'
 require 'phrase/api/documents_api'
+require 'phrase/api/figma_attachments_api'
 require 'phrase/api/formats_api'
 require 'phrase/api/git_hub_sync_api'
 require 'phrase/api/git_lab_sync_api'
@@ -240,6 +244,7 @@ require 'phrase/api/job_template_locales_api'
 require 'phrase/api/job_templates_api'
 require 'phrase/api/jobs_api'
 require 'phrase/api/keys_api'
+require 'phrase/api/keys_figma_attachments_api'
 require 'phrase/api/locales_api'
 require 'phrase/api/members_api'
 require 'phrase/api/notification_groups_api'

data/spec/api/comment_replies_api_spec.rb

@@ -34,6 +34,7 @@ describe 'CommentRepliesApi' do
   # @option opts [String] :branch specify the branch to use
   # @option opts [String] :query Search query for comment messages
   # @option opts [Array<String>] :filters Specify the filter for the comments
+  # @option opts [String] :order Order direction. Can be one of: asc, desc.
   # @return [Array<Comment>]
   describe 'replies_list test' do
     it 'should work' do

data/spec/api/comments_api_spec.rb

@@ -147,6 +147,7 @@ describe 'CommentsApi' do
   # @option opts [String] :query Search query for comment messages
   # @option opts [Array<String>] :locale_ids Search comments by their assigned locales
   # @option opts [Array<String>] :filters Specify the filter for the comments
+  # @option opts [String] :order Order direction. Can be one of: asc, desc.
   # @return [Array<Comment>]
   describe 'comments_list test' do
     it 'should work' do

data/spec/api/figma_attachments_api_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Phrase::FigmaAttachmentsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'FigmaAttachmentsApi' do
+  before do
+    # run before each test
+    @api_instance = Phrase::FigmaAttachmentsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FigmaAttachmentsApi' do
+    it 'should create an instance of FigmaAttachmentsApi' do
+      expect(@api_instance).to be_instance_of(Phrase::FigmaAttachmentsApi)
+    end
+  end
+
+  # unit tests for figma_attachment_create
+  # Create a Figma attachment
+  # Create a new Figma attachment.
+  # @param project_id Project ID
+  # @param figma_attachment_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
+  # @return [FigmaAttachment]
+  describe 'figma_attachment_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 figma_attachment_delete
+  # Delete a Figma attachment
+  # Delete an existing Figma attachment.
+  # @param project_id Project 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 'figma_attachment_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 figma_attachment_show
+  # Get a single Figma attachment
+  # Get details on a single Figma attachment for a given project.
+  # @param project_id Project 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 [FigmaAttachment]
+  describe 'figma_attachment_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 figma_attachment_update
+  # Update a Figma attachment
+  # Update an existing Figma attachment.
+  # @param project_id Project ID
+  # @param id ID
+  # @param figma_attachment_update_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
+  # @return [FigmaAttachment]
+  describe 'figma_attachment_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 figma_attachments_list
+  # List Figma attachments
+  # List all Figma attachments 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)
+  # @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
+  # @option opts [String] :branch specify the branch to use
+  # @return [Array<FigmaAttachment>]
+  describe 'figma_attachments_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/job_comments_api_spec.rb

@@ -91,6 +91,7 @@ describe 'JobCommentsApi' do
   # @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] :order Order direction. Can be one of: asc, desc.
   # @return [Array<JobComment>]
   describe 'job_comments_list test' do
     it 'should work' do

data/spec/api/keys_figma_attachments_api_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Phrase::KeysFigmaAttachmentsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'KeysFigmaAttachmentsApi' do
+  before do
+    # run before each test
+    @api_instance = Phrase::KeysFigmaAttachmentsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of KeysFigmaAttachmentsApi' do
+    it 'should create an instance of KeysFigmaAttachmentsApi' do
+      expect(@api_instance).to be_instance_of(Phrase::KeysFigmaAttachmentsApi)
+    end
+  end
+
+  # unit tests for figma_attachment_attach_to_key
+  # Attach the Figma attachment to a key
+  # Attach the Figma attachment to a key
+  # @param project_id Project ID
+  # @param figma_attachment_id Figma attachment 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 'figma_attachment_attach_to_key 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 figma_attachment_detach_from_key
+  # Detach the Figma attachment from a key
+  # Detach the Figma attachment from a key
+  # @param project_id Project ID
+  # @param figma_attachment_id Figma attachment 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 'figma_attachment_detach_from_key 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/locales_api_spec.rb

@@ -39,7 +39,7 @@ describe 'LocalesApi' do
   # Create a locale
   # Create a new locale.
   # @param project_id Project ID
-  # @param locale_create_parameters 
+  # @param locale_create_parameters
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
   # @return [LocaleDetails]
@@ -91,8 +91,28 @@ describe 'LocalesApi' do
   # @option opts [String] :source_locale_id Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a <code>tag</code> parameter indicating a specific job.
   # @return [File]
   describe 'locale_download test' do
+    let(:project_id) { 'project_id_example' }
+    let(:id) { 'id_example' }
+    let(:opts) { {
+      branch: 'branch_example',
+      format_options: {foo: 'bar'},
+    } }
+
+    before do
+      stub_request(:any, /.*phrase.com/)
+        .to_return(status: 200, body: "foo", headers: {
+          'Content-Type' => 'application/octet-stream',
+          'Content-Disposition' => 'attachment; filename="test.txt"',
+        })
+    end
+
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      locale = @api_instance.locale_download(project_id, id, opts)
+      expect(a_request(:get, "https://api.phrase.com/v2/projects/project_id_example/locales/id_example/download").with(query: {branch: "branch_example", format_options: {foo: "bar"}})).
+        to have_been_made
+
+      expect(locale).to be_instance_of(Phrase::Response)
+      expect(File.read(locale.data)).to eq("foo")
     end
   end
 
@@ -116,7 +136,7 @@ describe 'LocalesApi' do
   # Update an existing locale.
   # @param project_id Project ID
   # @param id Locale ID or locale name
-  # @param locale_update_parameters 
+  # @param locale_update_parameters
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
   # @return [LocaleDetails]
@@ -138,8 +158,92 @@ describe 'LocalesApi' do
   # @option opts [String] :branch specify the branch to use
   # @return [Array<Locale>]
   describe 'locales_list test' do
+    let(:project_id) { 'project_id_example' }
+    let(:opts) { {
+      branch: 'branch_example',
+    } }
+    let(:response_body) {
+      <<-EOF
+      [
+        {
+          "id": "ae0ce77b64dbf7e8315b5da8ecbb42c0",
+          "name": "de-DE",
+          "code": "de-DE",
+          "default": false,
+          "main": false,
+          "rtl": false,
+          "plural_forms": [
+            "zero",
+            "one",
+            "other"
+          ],
+          "created_at": "2022-10-27T11:03:39Z",
+          "updated_at": "2023-10-05T09:49:28Z",
+          "source_locale": null,
+          "fallback_locale": null
+        },
+        {
+          "id": "95060c3b178252e0c5d1936493e93108",
+          "name": "en-US",
+          "code": "en-US",
+          "default": true,
+          "main": false,
+          "rtl": false,
+          "plural_forms": [
+            "zero",
+            "one",
+            "other"
+          ],
+          "created_at": "2022-10-27T11:03:39Z",
+          "updated_at": "2023-10-05T09:50:20Z",
+          "source_locale": null,
+          "fallback_locale": null
+        },
+        {
+          "id": "97b4b258d9000f256a97276561294b5b",
+          "name": "sh",
+          "code": "sr-Latn-RS",
+          "default": false,
+          "main": false,
+          "rtl": false,
+          "plural_forms": [
+            "zero",
+            "one",
+            "few",
+            "other"
+          ],
+          "created_at": "2022-10-27T11:03:39Z",
+          "updated_at": "2023-05-10T08:22:18Z",
+          "source_locale": null,
+          "fallback_locale": null
+        }
+      ]
+      EOF
+    }
+
+    before do
+      stub_request(:any, /.*phrase.com/)
+        .to_return(status: 200, body: response_body, headers: {
+          'Content-Type' => 'application/json'
+        })
+    end
+
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      locales = @api_instance.locales_list(project_id, opts)
+      expect(a_request(:get, "https://api.phrase.com/v2/projects/project_id_example/locales").with(query: {branch: "branch_example"})).
+        to have_been_made
+
+      expect(locales).to be_instance_of(Phrase::Response)
+      expect(locales.data).to be_instance_of(Array)
+      expect(locales.data.length).to eq(3)
+      expect(locales.data[0]).to be_instance_of(Phrase::Locale)
+      expect(locales.data[0].id).to eq("ae0ce77b64dbf7e8315b5da8ecbb42c0")
+      expect(locales.data[0].name).to eq("de-DE")
+      expect(locales.data[0].code).to eq("de-DE")
+      expect(locales.data[0].default).to eq(false)
+      expect(locales.data[0].plural_forms).to eq(["zero", "one", "other"])
+      expect(locales.data[0].created_at).to eq(DateTime.parse("2022-10-27T11:03:39Z"))
+      expect(locales.data[0].updated_at).to eq(DateTime.parse("2023-10-05T09:49:28Z"))
     end
   end
 

data/spec/api/uploads_api_spec.rb

@@ -44,8 +44,22 @@ describe 'UploadsApi' do
   # @option opts [Boolean] :tag_only_affected_keys Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false`
   # @return [Upload]
   describe 'upload_create test' do
+    let(:response_body) { { data: {} }.to_json }
+    before do
+      stub_request(:any, /.*phrase.com/)
+        .to_return(status: 200, body: response_body, headers: {
+          'Content-Type' => 'application/json'
+        })
+    end
+
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      @api_instance.upload_create('project_id', file: File.new('Gemfile'))
+
+      expect(a_request(:post, 'https://api.phrase.com/v2/projects/project_id/uploads')
+        .with { |req|
+          expect(req.headers['Content-Type']).to eq('multipart/form-data')
+          # expect(req.body).to include('Gemfile')
+        }).to have_been_made
     end
   end
 

data/spec/models/comments_list_parameters_spec.rb

@@ -44,4 +44,10 @@ describe 'CommentsListParameters' do
     end
   end
 
+  describe 'test attribute "order"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end