phrase 2.15.0 → 2.17.0

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]
@@ -53,7 +53,7 @@ describe 'LocalesApi' do
   # Delete a locale
   # Delete an existing locale.
   # @param project_id Project ID
-  # @param id ID
+  # @param id Locale ID or locale name
   # @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
@@ -68,7 +68,7 @@ describe 'LocalesApi' do
   # Download a locale
   # Download a locale in a specific file format.
   # @param project_id Project ID
-  # @param id ID
+  # @param id Locale ID or locale name
   # @param [Hash] opts the optional parameters
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
   # @option opts [String] :if_modified_since Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
@@ -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
 
@@ -100,7 +120,7 @@ describe 'LocalesApi' do
   # Get a single locale
   # Get details on a single locale for a given project.
   # @param project_id Project ID
-  # @param id ID
+  # @param id Locale ID or locale name
   # @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
@@ -115,8 +135,8 @@ describe 'LocalesApi' do
   # Update a locale
   # Update an existing locale.
   # @param project_id Project ID
-  # @param id ID
-  # @param locale_update_parameters 
+  # @param id Locale ID or locale name
+  # @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/translations_api_spec.rb

@@ -220,7 +220,7 @@ describe 'TranslationsApi' do
   # @option opts [String] :branch specify the branch to use
   # @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
   # @option opts [String] :order Order direction. Can be one of: asc, desc.
-  # @option opts [String] :q Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul>   <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>tags:XYZ</code> for tags on the translation</li>   <li><code>unverified:{true|false}</code> for verification status</li>   <li><code>excluded:{true|false}</code> for exclusion status</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. 
+  # @option opts [String] :q Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul>   <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>tags:XYZ</code> for tags on the translation</li>   <li><code>unverified:{true|false}</code> for verification status</li>   <li><code>excluded:{true|false}</code> for exclusion status</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>reviewed_after:2013-02-21T00:00:00Z</code> for fetching translations that were reviewed after the given timestamp</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. 
   # @return [Array<Translation>]
   describe 'translations_list test' do
     it 'should work' do

data/spec/api/uploads_api_spec.rb

@@ -41,10 +41,25 @@ describe 'UploadsApi' do
   # @option opts [Object] :format_options Additional options available for specific formats. See our format guide for complete list.
   # @option opts [Boolean] :autotranslate If set, translations for the uploaded language will be fetched automatically.
   # @option opts [Boolean] :mark_reviewed Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
+  # @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/figma_attachment_create_parameters_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Phrase::FigmaAttachmentCreateParameters
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'FigmaAttachmentCreateParameters' do
+  before do
+    # run before each test
+    @instance = Phrase::FigmaAttachmentCreateParameters.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FigmaAttachmentCreateParameters' do
+    it 'should create an instance of FigmaAttachmentCreateParameters' do
+      expect(@instance).to be_instance_of(Phrase::FigmaAttachmentCreateParameters)
+    end
+  end
+  describe 'test attribute "branch"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "url"' 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/figma_attachment_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Phrase::FigmaAttachment
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'FigmaAttachment' do
+  before do
+    # run before each test
+    @instance = Phrase::FigmaAttachment.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FigmaAttachment' do
+    it 'should create an instance of FigmaAttachment' do
+      expect(@instance).to be_instance_of(Phrase::FigmaAttachment)
+    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 "url"' 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

data/spec/models/figma_attachment_update_parameters_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Phrase::FigmaAttachmentUpdateParameters
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'FigmaAttachmentUpdateParameters' do
+  before do
+    # run before each test
+    @instance = Phrase::FigmaAttachmentUpdateParameters.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FigmaAttachmentUpdateParameters' do
+    it 'should create an instance of FigmaAttachmentUpdateParameters' do
+      expect(@instance).to be_instance_of(Phrase::FigmaAttachmentUpdateParameters)
+    end
+  end
+  describe 'test attribute "branch"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "url"' 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/upload_create_parameters_spec.rb

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

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 # load the gem
 require 'phrase'
+require 'webmock/rspec'
 
 # The following  was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.