phrase 1.0.3 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a2a3ba240b5fe6192611ada80af8b0e4801f5d8b3719537257c63acff09d41e
-  data.tar.gz: 61a4a7f0c7a3dabd110a1b5c9c585c59238977a5cbdcf52f6139e8d2bac3d9de
+  metadata.gz: 786cd863ec921dca3b5e1cb94b076fd60d161c941b851dcda43e81be41d00c29
+  data.tar.gz: 7b190b38c23011e0587d7fe0096ebffc546e8760bf87977c4e69f65361fbbfad
 SHA512:
-  metadata.gz: 7a798dcbf704b4b174f4cf7aca3df46abea328efd23dcd0668c23c775e79f73ebaf1dfa2620cfb06e0db2eb20aa12d5b94be4ba4dfb8d817d17f82fa856c2540
-  data.tar.gz: 36f134b201a9d3c770a413b67bad3418fe2ad9b1e254dc0de6fdce651f21ff0a2b02df37d40edf2176698f4a91119486bda4163820ee01d7c470a52ca7a837cc
+  metadata.gz: 842413258da9682e4c40f6d98cb5dc2de6c1f046bf00d27f9923686ad8a9316eb694f84d96e29764c995cbbbc19e10d868759c4372956fab35d5f8050a5872cc
+  data.tar.gz: 5190235afcfa191f12002945acb66646a9bbbb16b7965ebed8bc0e4201a8a3b17f80b041e56b2ee6b241594eb397d715e2d0e3b760ab1f7708305d175058f34b

data/README.md

@@ -7,7 +7,7 @@ Phrase is a translation management platform for software projects. You can colla
 ## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 1.0.3
+- Package version: 1.0.8
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
 
@@ -56,10 +56,10 @@ gem build phrase.gemspec
 Then install the gem locally:
 
 ```shell
-gem install ./phrase-1.0.3.gem
+gem install ./phrase-1.0.8.gem
 ```
 
-(for development, run `gem install --dev ./phrase-1.0.3.gem` to install the development dependencies)
+(for development, run `gem install --dev ./phrase-1.0.8.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -186,6 +186,7 @@ Class | Method | HTTP request | Description
 *Phrase::JobsApi* | [**job_show**](docs/JobsApi.md#job_show) | **GET** /projects/{project_id}/jobs/{id} | Get a single job
 *Phrase::JobsApi* | [**job_start**](docs/JobsApi.md#job_start) | **POST** /projects/{project_id}/jobs/{id}/start | Start a job
 *Phrase::JobsApi* | [**job_update**](docs/JobsApi.md#job_update) | **PATCH** /projects/{project_id}/jobs/{id} | Update a job
+*Phrase::JobsApi* | [**jobs_by_account**](docs/JobsApi.md#jobs_by_account) | **GET** /accounts/{account_id}/jobs | List account jobs
 *Phrase::JobsApi* | [**jobs_list**](docs/JobsApi.md#jobs_list) | **GET** /projects/{project_id}/jobs | List jobs
 *Phrase::KeysApi* | [**key_create**](docs/KeysApi.md#key_create) | **POST** /projects/{project_id}/keys | Create a key
 *Phrase::KeysApi* | [**key_delete**](docs/KeysApi.md#key_delete) | **DELETE** /projects/{project_id}/keys/{id} | Delete a key

data/docs/Job.md

@@ -9,8 +9,10 @@ Name | Type | Description | Notes
 **briefing** | **String** |  | [optional] 
 **due_date** | **DateTime** |  | [optional] 
 **state** | **String** |  | [optional] 
+**ticket_url** | **String** |  | [optional] 
 **created_at** | **DateTime** |  | [optional] 
 **updated_at** | **DateTime** |  | [optional] 
+**project** | [**ProjectShort**](ProjectShort.md) |  | [optional] 
 
 ## Code Sample
 
@@ -22,8 +24,10 @@ instance = Phrase::Job.new(id: null,
                                  briefing: null,
                                  due_date: null,
                                  state: null,
+                                 ticket_url: null,
                                  created_at: null,
-                                 updated_at: null)
+                                 updated_at: null,
+                                 project: null)
 ```
 
 

data/docs/JobCreateParameters.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **name** | **String** | Job name | [optional] 
 **briefing** | **String** | Briefing for the translators | [optional] 
 **due_date** | **DateTime** | Date the job should be finished | [optional] 
+**ticket_url** | **String** | URL to a ticket for this job (e.g. Jira, Trello) | [optional] 
 **tags** | **Array<String>** | tags of keys that should be included within the job | [optional] 
 **translation_key_ids** | **Array<String>** | ids of keys that should be included within the job | [optional] 
 
@@ -20,6 +21,7 @@ instance = Phrase::JobCreateParameters.new(branch: my-feature-branch,
                                  name: de,
                                  briefing: de-DE,
                                  due_date: null,
+                                 ticket_url: https://example.atlassian.net/browse/FOO,
                                  tags: ["myUploadTag"],
                                  translation_key_ids: ["abcd1234cdef1234abcd1234cdef1234"])
 ```

data/docs/JobDetails.md

@@ -9,8 +9,10 @@ Name | Type | Description | Notes
 **briefing** | **String** |  | [optional] 
 **due_date** | **DateTime** |  | [optional] 
 **state** | **String** |  | [optional] 
+**ticket_url** | **String** |  | [optional] 
 **created_at** | **DateTime** |  | [optional] 
 **updated_at** | **DateTime** |  | [optional] 
+**project** | [**ProjectShort**](ProjectShort.md) |  | [optional] 
 **owner** | [**UserPreview**](UserPreview.md) |  | [optional] 
 **job_tag_name** | **String** |  | [optional] 
 **locales** | [**Array<LocalePreview>**](LocalePreview.md) |  | [optional] 
@@ -26,8 +28,10 @@ instance = Phrase::JobDetails.new(id: null,
                                  briefing: null,
                                  due_date: null,
                                  state: null,
+                                 ticket_url: null,
                                  created_at: null,
                                  updated_at: null,
+                                 project: null,
                                  owner: null,
                                  job_tag_name: null,
                                  locales: null,

data/docs/JobUpdateParameters.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **name** | **String** | Job name | [optional] 
 **briefing** | **String** | Briefing for the translators | [optional] 
 **due_date** | **DateTime** | Date the job should be finished | [optional] 
+**ticket_url** | **String** | URL to a ticket for this job (e.g. Jira, Trello) | [optional] 
 
 ## Code Sample
 
@@ -17,7 +18,8 @@ require 'Phrase'
 instance = Phrase::JobUpdateParameters.new(branch: my-feature-branch,
                                  name: de,
                                  briefing: de-DE,
-                                 due_date: null)
+                                 due_date: null,
+                                 ticket_url: https://example.atlassian.net/browse/FOO)
 ```
 
 

data/docs/JobsApi.md

@@ -13,6 +13,7 @@ Method | HTTP request | Description
 [**job_show**](JobsApi.md#job_show) | **GET** /projects/{project_id}/jobs/{id} | Get a single job
 [**job_start**](JobsApi.md#job_start) | **POST** /projects/{project_id}/jobs/{id}/start | Start a job
 [**job_update**](JobsApi.md#job_update) | **PATCH** /projects/{project_id}/jobs/{id} | Update a job
+[**jobs_by_account**](JobsApi.md#jobs_by_account) | **GET** /accounts/{account_id}/jobs | List account jobs
 [**jobs_list**](JobsApi.md#jobs_list) | **GET** /projects/{project_id}/jobs | List jobs
 
 
@@ -600,6 +601,77 @@ Response<([**JobDetails**](JobDetails.md))>
 - **Accept**: application/json
 
 
+## jobs_by_account
+
+> Array&lt;Job&gt; jobs_by_account(account_id, opts)
+
+List account jobs
+
+List all jobs for the given account.
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::JobsApi.new
+account_id = 'account_id_example' # String | Account ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  page: 1, # Integer | Page number
+  per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
+  owned_by: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user owning job
+  assigned_to: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user assigned to job
+  state: 'completed' # String | filter by state of job Valid states are <code>draft</code>, <code>in_progress</code>, <code>completed</code>
+}
+
+begin
+  #List account jobs
+  result = api_instance.jobs_by_account(account_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobsApi->jobs_by_account: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **page** | **Integer**| Page number | [optional] 
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional] 
+ **owned_by** | **String**| filter by user owning job | [optional] 
+ **assigned_to** | **String**| filter by user assigned to job | [optional] 
+ **state** | **String**| 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; | [optional] 
+
+### Return type
+
+Response<([**Array&lt;Job&gt;**](Job.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## jobs_list
 
 > Array&lt;Job&gt; jobs_list(project_id, opts)

data/docs/ScreenshotsApi.md

@@ -294,7 +294,8 @@ project_id = 'project_id_example' # String | Project ID
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
   page: 1, # Integer | Page number
-  per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
+  per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
+  key_id: 'abcd1234cdef1234abcd1234cdef1234' # String | filter by key
 }
 
 begin
@@ -315,6 +316,7 @@ Name | Type | Description  | Notes
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
  **page** | **Integer**| Page number | [optional] 
  **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional] 
+ **key_id** | **String**| filter by key | [optional] 
 
 ### Return type
 

data/docs/WebhookCreateParameters.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **callback_url** | **String** | Callback URL to send requests to | [optional] 
+**secret** | **String** | Webhook secret used to calculate signature. If empty, the default project secret will be used. | [optional] 
 **description** | **String** | Webhook description | [optional] 
 **events** | **String** | List of event names to trigger the webhook (separated by comma) | [optional] 
 **active** | **Boolean** | Whether webhook is active or inactive | [optional] 
@@ -15,6 +16,7 @@ Name | Type | Description | Notes
 require 'Phrase'
 
 instance = Phrase::WebhookCreateParameters.new(callback_url: http://example.com/hooks/phraseapp-notifications,
+                                 secret: secr3t,
                                  description: My webhook for chat notifications,
                                  events: locales:create,translations:update,
                                  active: null)

data/docs/WebhookUpdateParameters.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **callback_url** | **String** | Callback URL to send requests to | [optional] 
+**secret** | **String** | Webhook secret used to calculate signature. If empty, the default project secret will be used. | [optional] 
 **description** | **String** | Webhook description | [optional] 
 **events** | **String** | List of event names to trigger the webhook (separated by comma) | [optional] 
 **active** | **Boolean** | Whether webhook is active or inactive | [optional] 
@@ -15,6 +16,7 @@ Name | Type | Description | Notes
 require 'Phrase'
 
 instance = Phrase::WebhookUpdateParameters.new(callback_url: http://example.com/hooks/phraseapp-notifications,
+                                 secret: secr3t,
                                  description: My webhook for chat notifications,
                                  events: locales:create,translations:update,
                                  active: null)

data/lib/phrase/api/jobs_api.rb

@@ -705,6 +705,87 @@ module Phrase
       return response, status_code, headers
     end
 
+    # List account jobs
+    # List all jobs for the given account.
+    # @param account_id [String] 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 allows you to specify a page size up to 100 items, 25 by default
+    # @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 <code>draft</code>, <code>in_progress</code>, <code>completed</code>
+    # @return [Array<Job>]
+    def jobs_by_account(account_id, opts = {})
+      data, _status_code, _headers = jobs_by_account_with_http_info(account_id, opts)
+      data
+    end
+
+    # List account jobs
+    # List all jobs for the given account.
+    # @param account_id [String] 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 allows you to specify a page size up to 100 items, 25 by default
+    # @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<(Response<(Array<Job>)>, Integer, Hash)>] Response<(Array<Job>)> data, response status code and response headers
+    def jobs_by_account_with_http_info(account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobsApi.jobs_by_account ...'
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling JobsApi.jobs_by_account"
+      end
+      # resource path
+      local_var_path = '/accounts/{account_id}/jobs'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'owned_by'] = opts[:'owned_by'] if !opts[:'owned_by'].nil?
+      query_params[:'assigned_to'] = opts[:'assigned_to'] if !opts[:'assigned_to'].nil?
+      query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<Job>' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: JobsApi#jobs_by_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      response = ::Phrase::Response.new(data, headers)
+      return response, status_code, headers
+    end
+
     # List jobs
     # List all jobs for the given project.
     # @param project_id [String] Project ID

data/lib/phrase/api/screenshots_api.rb

@@ -310,6 +310,7 @@ module Phrase
     # @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] :key_id filter by key
     # @return [Array<Screenshot>]
     def screenshots_list(project_id, opts = {})
       data, _status_code, _headers = screenshots_list_with_http_info(project_id, opts)
@@ -323,6 +324,7 @@ module Phrase
     # @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] :key_id filter by key
     # @return [Array<(Response<(Array<Screenshot>)>, Integer, Hash)>] Response<(Array<Screenshot>)> data, response status code and response headers
     def screenshots_list_with_http_info(project_id, opts = {})
       if @api_client.config.debugging
@@ -339,6 +341,7 @@ module Phrase
       query_params = opts[:query_params] || {}
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'key_id'] = opts[:'key_id'] if !opts[:'key_id'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/phrase/api_client.rb

@@ -128,9 +128,11 @@ module Phrase
         data = {}
         form_params.each do |key, value|
           case value
-          when ::File, ::Array, nil
-            # let typhoeus handle File, Array and nil parameters
+          when ::File, ::Tempfile, ::Array, nil
+            # let typhoeus handle File, Tempfile, Array and nil parameters
             data[key] = value
+          when ::Hash
+            data[key] = build_request_body(header_params, value, body)
           else
             data[key] = value.to_s
           end

data/lib/phrase/models/job.rb

@@ -12,10 +12,14 @@ module Phrase
 
     attr_accessor :state
 
+    attr_accessor :ticket_url
+
     attr_accessor :created_at
 
     attr_accessor :updated_at
 
+    attr_accessor :project
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -24,8 +28,10 @@ module Phrase
         :'briefing' => :'briefing',
         :'due_date' => :'due_date',
         :'state' => :'state',
+        :'ticket_url' => :'ticket_url',
         :'created_at' => :'created_at',
-        :'updated_at' => :'updated_at'
+        :'updated_at' => :'updated_at',
+        :'project' => :'project'
       }
     end
 
@@ -37,8 +43,10 @@ module Phrase
         :'briefing' => :'String',
         :'due_date' => :'DateTime',
         :'state' => :'String',
+        :'ticket_url' => :'String',
         :'created_at' => :'DateTime',
-        :'updated_at' => :'DateTime'
+        :'updated_at' => :'DateTime',
+        :'project' => :'ProjectShort'
       }
     end
 
@@ -83,6 +91,10 @@ module Phrase
         self.state = attributes[:'state']
       end
 
+      if attributes.key?(:'ticket_url')
+        self.ticket_url = attributes[:'ticket_url']
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -90,6 +102,10 @@ module Phrase
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       end
+
+      if attributes.key?(:'project')
+        self.project = attributes[:'project']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -115,8 +131,10 @@ module Phrase
           briefing == o.briefing &&
           due_date == o.due_date &&
           state == o.state &&
+          ticket_url == o.ticket_url &&
           created_at == o.created_at &&
-          updated_at == o.updated_at
+          updated_at == o.updated_at &&
+          project == o.project
     end
 
     # @see the `==` method
@@ -128,7 +146,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, briefing, due_date, state, created_at, updated_at].hash
+      [id, name, briefing, due_date, state, ticket_url, created_at, updated_at, project].hash
     end
 
     # Builds the object from hash