phrase 0.4.31 → 1.0.3

data/spec/api/jobs_api_spec.rb

@@ -0,0 +1,177 @@
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Phrase::JobsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'JobsApi' do
+  before do
+    # run before each test
+    @api_instance = Phrase::JobsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of JobsApi' do
+    it 'should create an instance of JobsApi' do
+      expect(@api_instance).to be_instance_of(Phrase::JobsApi)
+    end
+  end
+
+  # unit tests for job_complete
+  # Complete a job
+  # Mark a job as completed.
+  # @param project_id Project ID
+  # @param id ID
+  # @param job_complete_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [JobDetails]
+  describe 'job_complete 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_create
+  # Create a job
+  # Create a new job.
+  # @param project_id Project ID
+  # @param job_create_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [JobDetails]
+  describe 'job_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_delete
+  # Delete a job
+  # Delete an existing job.
+  # @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 'job_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_keys_create
+  # Add keys to job
+  # Add multiple keys to a existing job.
+  # @param project_id Project ID
+  # @param id ID
+  # @param job_keys_create_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [JobDetails]
+  describe 'job_keys_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_keys_delete
+  # Remove keys from job
+  # Remove multiple keys from existing job.
+  # @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
+  # @option opts [Array<String>] :translation_key_ids ids of keys that should added to the job
+  # @return [nil]
+  describe 'job_keys_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_reopen
+  # Reopen a job
+  # Mark a job as uncompleted.
+  # @param project_id Project ID
+  # @param id ID
+  # @param job_reopen_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [JobDetails]
+  describe 'job_reopen 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_show
+  # Get a single job
+  # Get details on a single job 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 [JobDetails]
+  describe 'job_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_start
+  # Start a job
+  # Starts an existing job in state draft.
+  # @param project_id Project ID
+  # @param id ID
+  # @param job_start_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [JobDetails]
+  describe 'job_start 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_update
+  # Update a job
+  # Update an existing job.
+  # @param project_id Project ID
+  # @param id ID
+  # @param job_update_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [JobDetails]
+  describe 'job_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 jobs_list
+  # List jobs
+  # List all jobs 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 allows you to specify a page size up to 100 items, 25 by default
+  # @option opts [String] :branch specify the branch to use
+  # @option opts [String] :owned_by filter by user owning job
+  # @option opts [String] :assigned_to filter by user assigned to job
+  # @option opts [String] :state filter by state of job Valid states are &lt;code&gt;draft&lt;/code&gt;, &lt;code&gt;in_progress&lt;/code&gt;, &lt;code&gt;completed&lt;/code&gt;
+  # @return [Array<Job>]
+  describe 'jobs_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/keys_api_spec.rb

@@ -0,0 +1,162 @@
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Phrase::KeysApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'KeysApi' do
+  before do
+    # run before each test
+    @api_instance = Phrase::KeysApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of KeysApi' do
+    it 'should create an instance of KeysApi' do
+      expect(@api_instance).to be_instance_of(Phrase::KeysApi)
+    end
+  end
+
+  # unit tests for key_create
+  # Create a key
+  # Create a new key.
+  # @param project_id Project ID
+  # @param key_create_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [TranslationKeyDetails]
+  describe 'key_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 key_delete
+  # Delete a key
+  # Delete an existing key.
+  # @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 'key_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 key_show
+  # Get a single key
+  # Get details on a single key 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 [TranslationKeyDetails]
+  describe 'key_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 key_update
+  # Update a key
+  # Update an existing key.
+  # @param project_id Project ID
+  # @param id ID
+  # @param key_update_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [TranslationKeyDetails]
+  describe 'key_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 keys_delete
+  # Delete collection of keys
+  # Delete all keys matching query. Same constraints as list. Please limit the number of affected keys to about 1,000 as you might experience timeouts otherwise.
+  # @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 [String] :branch specify the branch to use
+  # @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name</code> for text queries on exact key names - whitespaces need to be prefixed with a backspace (\\\"\\\\\\\")</li>   <li><code>tags:tag_name</code> to filter for keys with certain tags</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. 
+  # @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
+  # @return [AffectedResources]
+  describe 'keys_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 keys_list
+  # List keys
+  # List all keys for the given project. Alternatively you can POST requests to /search.
+  # @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 allows you to specify a page size up to 100 items, 25 by default
+  # @option opts [String] :branch specify the branch to use
+  # @option opts [String] :sort Sort by field. Can be one of: 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 do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name</code> for text queries on exact key names - whitespaces need to be prefixed with a backspace (\\\"\\\\\\\")</li>   <li><code>tags:tag_name</code> to filter for keys with certain tags</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. 
+  # @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
+  # @return [Array<TranslationKey>]
+  describe 'keys_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 keys_search
+  # Search keys
+  # Search keys for the given project matching query.
+  # @param project_id Project ID
+  # @param keys_search_parameters 
+  # @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 allows you to specify a page size up to 100 items, 25 by default
+  # @return [Array<TranslationKey>]
+  describe 'keys_search 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 keys_tag
+  # Add tags to collection of keys
+  # Tags all keys matching query. Same constraints as list.
+  # @param project_id Project ID
+  # @param keys_tag_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [AffectedResources]
+  describe 'keys_tag 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 keys_untag
+  # Remove tags from collection of keys
+  # Removes specified tags from keys matching query.
+  # @param project_id Project ID
+  # @param keys_untag_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [AffectedResources]
+  describe 'keys_untag 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

@@ -0,0 +1,126 @@
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Phrase::LocalesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'LocalesApi' do
+  before do
+    # run before each test
+    @api_instance = Phrase::LocalesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of LocalesApi' do
+    it 'should create an instance of LocalesApi' do
+      expect(@api_instance).to be_instance_of(Phrase::LocalesApi)
+    end
+  end
+
+  # unit tests for locale_create
+  # Create a locale
+  # Create a new locale.
+  # @param project_id Project ID
+  # @param locale_create_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [LocaleDetails]
+  describe 'locale_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 locale_delete
+  # Delete a locale
+  # Delete an existing locale.
+  # @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 'locale_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 locale_download
+  # Download a locale
+  # Download a locale in a specific file format.
+  # @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
+  # @option opts [String] :file_format File format name. See the format guide for all supported file formats.
+  # @option opts [String] :tags Limit results to keys tagged with a list of comma separated tag names.
+  # @option opts [String] :tag Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead
+  # @option opts [Boolean] :include_empty_translations Indicates whether keys without translations should be included in the output as well.
+  # @option opts [Boolean] :include_translated_keys Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
+  # @option opts [Boolean] :keep_notranslate_tags Indicates whether [NOTRANSLATE] tags should be kept.
+  # @option opts [Boolean] :convert_emoji This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.
+  # @option opts [Object] :format_options Additional formatting and render options. See the <a href=\"https://help.phrase.com/help/supported-platforms-and-formats\">format guide</a> for a list of options available for each format. Specify format options like this: <code>...&format_options[foo]=bar</code>
+  # @option opts [String] :encoding Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\".
+  # @option opts [Boolean] :skip_unverified_translations Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with <code>include_unverified_translations</code>.
+  # @option opts [Boolean] :include_unverified_translations if set to false unverified translations are excluded
+  # @option opts [Boolean] :use_last_reviewed_version If set to true the last reviewed version of a translation is used. This is only available if the review workflow (currently in beta) is enabled for the project.
+  # @option opts [String] :fallback_locale_id If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to <code>true</code>.
+  # @return [nil]
+  describe 'locale_download 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 locale_show
+  # Get a single locale
+  # Get details on a single locale 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 [LocaleDetails]
+  describe 'locale_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 locale_update
+  # Update a locale
+  # Update an existing locale.
+  # @param project_id Project ID
+  # @param id ID
+  # @param locale_update_parameters 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+  # @return [LocaleDetails]
+  describe 'locale_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 locales_list
+  # List locales
+  # List all locales 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 allows you to specify a page size up to 100 items, 25 by default
+  # @option opts [String] :branch specify the branch to use
+  # @return [Array<Locale>]
+  describe 'locales_list test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end