phrase 2.7.0 → 2.8.0

data/docs/WebhookDeliveriesApi.md

@@ -0,0 +1,206 @@
+# Phrase::WebhookDeliveriesApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**webhook_deliveries_list**](WebhookDeliveriesApi.md#webhook_deliveries_list) | **GET** /projects/{project_id}/webhooks/{webhook_id}/deliveries | List webhook deliveries
+[**webhook_deliveries_redeliver**](WebhookDeliveriesApi.md#webhook_deliveries_redeliver) | **POST** /projects/{project_id}/webhooks/{webhook_id}/deliveries/{id}/redeliver | Redeliver a single webhook delivery
+[**webhook_deliveries_show**](WebhookDeliveriesApi.md#webhook_deliveries_show) | **GET** /projects/{project_id}/webhooks/{webhook_id}/deliveries/{id} | Get a single webhook delivery
+
+
+
+## webhook_deliveries_list
+
+> Array<WebhookDelivery> webhook_deliveries_list(project_id, webhook_id, opts)
+
+List webhook deliveries
+
+List all webhook deliveries for the given webhook_id.
+
+### 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::WebhookDeliveriesApi.new
+project_id = 'project_id_example' # String | Project ID
+webhook_id = 'webhook_id_example' # String | Webhook ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  response_status_codes: 'response_status_codes_example' # String | List of Response Status Codes
+}
+
+begin
+  #List webhook deliveries
+  result = api_instance.webhook_deliveries_list(project_id, webhook_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling WebhookDeliveriesApi->webhook_deliveries_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **webhook_id** | **String**| Webhook ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **response_status_codes** | **String**| List of Response Status Codes | [optional] 
+
+### Return type
+
+Response<([**Array&lt;WebhookDelivery&gt;**](WebhookDelivery.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## webhook_deliveries_redeliver
+
+> WebhookDelivery webhook_deliveries_redeliver(project_id, webhook_id, id, opts)
+
+Redeliver a single webhook delivery
+
+Trigger an individual webhook delivery to be redelivered.
+
+### 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::WebhookDeliveriesApi.new
+project_id = 'project_id_example' # String | Project ID
+webhook_id = 'webhook_id_example' # String | Webhook ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Redeliver a single webhook delivery
+  result = api_instance.webhook_deliveries_redeliver(project_id, webhook_id, id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling WebhookDeliveriesApi->webhook_deliveries_redeliver: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **webhook_id** | **String**| Webhook ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**WebhookDelivery**](WebhookDelivery.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## webhook_deliveries_show
+
+> WebhookDelivery webhook_deliveries_show(project_id, webhook_id, id, opts)
+
+Get a single webhook delivery
+
+Get all information about a single webhook delivery for the given ID.
+
+### 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::WebhookDeliveriesApi.new
+project_id = 'project_id_example' # String | Project ID
+webhook_id = 'webhook_id_example' # String | Webhook ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Get a single webhook delivery
+  result = api_instance.webhook_deliveries_show(project_id, webhook_id, id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling WebhookDeliveriesApi->webhook_deliveries_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **webhook_id** | **String**| Webhook ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**WebhookDelivery**](WebhookDelivery.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/WebhookDelivery.md

@@ -0,0 +1,29 @@
+# Phrase::WebhookDelivery
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**webhook_id** | **String** |  | [optional] 
+**response_status_code** | **Integer** |  | [optional] 
+**delivered_at** | **DateTime** |  | [optional] 
+**duration_ms** | **Integer** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::WebhookDelivery.new(id: null,
+                                 webhook_id: null,
+                                 response_status_code: null,
+                                 delivered_at: null,
+                                 duration_ms: null,
+                                 created_at: null,
+                                 updated_at: null)
+```
+
+

data/lib/phrase/api/blacklisted_keys_api.rb

@@ -7,8 +7,8 @@ module Phrase
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # 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 [String] Project ID
     # @param blacklisted_key_create_parameters [BlacklistedKeyCreateParameters] 
     # @param [Hash] opts the optional parameters
@@ -19,8 +19,8 @@ module Phrase
       data
     end
 
-    # 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 [String] Project ID
     # @param blacklisted_key_create_parameters [BlacklistedKeyCreateParameters] 
     # @param [Hash] opts the optional parameters
@@ -81,8 +81,8 @@ module Phrase
       return response, status_code, headers
     end
 
-    # 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 [String] Project ID
     # @param id [String] ID
     # @param [Hash] opts the optional parameters
@@ -93,8 +93,8 @@ module Phrase
       data
     end
 
-    # 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 [String] Project ID
     # @param id [String] ID
     # @param [Hash] opts the optional parameters
@@ -151,8 +151,8 @@ module Phrase
       return response, status_code, headers
     end
 
-    # 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 [String] Project ID
     # @param id [String] ID
     # @param [Hash] opts the optional parameters
@@ -163,8 +163,8 @@ module Phrase
       data
     end
 
-    # 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 [String] Project ID
     # @param id [String] ID
     # @param [Hash] opts the optional parameters
@@ -223,8 +223,8 @@ module Phrase
       return response, status_code, headers
     end
 
-    # 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 [String] Project ID
     # @param id [String] ID
     # @param blacklisted_key_update_parameters [BlacklistedKeyUpdateParameters] 
@@ -236,8 +236,8 @@ module Phrase
       data
     end
 
-    # 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 [String] Project ID
     # @param id [String] ID
     # @param blacklisted_key_update_parameters [BlacklistedKeyUpdateParameters] 
@@ -303,8 +303,8 @@ module Phrase
       return response, status_code, headers
     end
 
-    # 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 [String] Project ID
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
@@ -317,8 +317,8 @@ module Phrase
       data
     end
 
-    # 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 [String] Project ID
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)

data/lib/phrase/api/glossaries_api.rb

@@ -7,8 +7,8 @@ module Phrase
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # 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 [String] Account ID
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
@@ -20,8 +20,8 @@ module Phrase
       data
     end
 
-    # 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 [String] Account ID
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
@@ -79,8 +79,8 @@ module Phrase
       return response, status_code, headers
     end
 
-    # Create a glossary
-    # Create a new glossary.
+    # Create a term base
+    # Create a new term base (previously: glossary).
     # @param account_id [String] Account ID
     # @param glossary_create_parameters [GlossaryCreateParameters] 
     # @param [Hash] opts the optional parameters
@@ -91,8 +91,8 @@ module Phrase
       data
     end
 
-    # Create a glossary
-    # Create a new glossary.
+    # Create a term base
+    # Create a new term base (previously: glossary).
     # @param account_id [String] Account ID
     # @param glossary_create_parameters [GlossaryCreateParameters] 
     # @param [Hash] opts the optional parameters
@@ -153,8 +153,8 @@ module Phrase
       return response, status_code, headers
     end
 
-    # Delete a glossary
-    # Delete an existing glossary.
+    # Delete a term base
+    # Delete an existing term base (previously: glossary).
     # @param account_id [String] Account ID
     # @param id [String] ID
     # @param [Hash] opts the optional parameters
@@ -165,8 +165,8 @@ module Phrase
       data
     end
 
-    # Delete a glossary
-    # Delete an existing glossary.
+    # Delete a term base
+    # Delete an existing term base (previously: glossary).
     # @param account_id [String] Account ID
     # @param id [String] ID
     # @param [Hash] opts the optional parameters
@@ -223,8 +223,8 @@ module Phrase
       return response, status_code, headers
     end
 
-    # 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 [String] Account ID
     # @param id [String] ID
     # @param [Hash] opts the optional parameters
@@ -235,8 +235,8 @@ module Phrase
       data
     end
 
-    # 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 [String] Account ID
     # @param id [String] ID
     # @param [Hash] opts the optional parameters
@@ -295,8 +295,8 @@ module Phrase
       return response, status_code, headers
     end
 
-    # Update a glossary
-    # Update an existing glossary.
+    # Update a term base
+    # Update an existing term base (previously: glossary).
     # @param account_id [String] Account ID
     # @param id [String] ID
     # @param glossary_update_parameters [GlossaryUpdateParameters] 
@@ -308,8 +308,8 @@ module Phrase
       data
     end
 
-    # Update a glossary
-    # Update an existing glossary.
+    # Update a term base
+    # Update an existing term base (previously: glossary).
     # @param account_id [String] Account ID
     # @param id [String] ID
     # @param glossary_update_parameters [GlossaryUpdateParameters] 

data/lib/phrase/api/glossary_term_translations_api.rb

@@ -7,8 +7,8 @@ module Phrase
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # 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 [String] Account ID
     # @param glossary_id [String] Glossary ID
     # @param term_id [String] Term ID
@@ -21,8 +21,8 @@ module Phrase
       data
     end
 
-    # 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 [String] Account ID
     # @param glossary_id [String] Glossary ID
     # @param term_id [String] Term ID
@@ -93,8 +93,8 @@ module Phrase
       return response, status_code, headers
     end
 
-    # 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 [String] Account ID
     # @param glossary_id [String] Glossary ID
     # @param term_id [String] Term ID
@@ -107,8 +107,8 @@ module Phrase
       data
     end
 
-    # 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 [String] Account ID
     # @param glossary_id [String] Glossary ID
     # @param term_id [String] Term ID
@@ -175,8 +175,8 @@ module Phrase
       return response, status_code, headers
     end
 
-    # 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 [String] Account ID
     # @param glossary_id [String] Glossary ID
     # @param term_id [String] Term ID
@@ -190,8 +190,8 @@ module Phrase
       data
     end
 
-    # 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 [String] Account ID
     # @param glossary_id [String] Glossary ID
     # @param term_id [String] Term ID

data/lib/phrase/api/glossary_terms_api.rb

@@ -7,8 +7,8 @@ module Phrase
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # 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 [String] Account ID
     # @param glossary_id [String] Glossary ID
     # @param glossary_term_create_parameters [GlossaryTermCreateParameters] 
@@ -20,8 +20,8 @@ module Phrase
       data
     end
 
-    # 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 [String] Account ID
     # @param glossary_id [String] Glossary ID
     # @param glossary_term_create_parameters [GlossaryTermCreateParameters] 
@@ -87,8 +87,8 @@ module Phrase
       return response, status_code, headers
     end
 
-    # 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 [String] Account ID
     # @param glossary_id [String] Glossary ID
     # @param id [String] ID
@@ -100,8 +100,8 @@ module Phrase
       data
     end
 
-    # 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 [String] Account ID
     # @param glossary_id [String] Glossary ID
     # @param id [String] ID
@@ -163,8 +163,8 @@ module Phrase
       return response, status_code, headers
     end
 
-    # 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 [String] Account ID
     # @param glossary_id [String] Glossary ID
     # @param id [String] ID
@@ -176,8 +176,8 @@ module Phrase
       data
     end
 
-    # 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 [String] Account ID
     # @param glossary_id [String] Glossary ID
     # @param id [String] ID
@@ -241,8 +241,8 @@ module Phrase
       return response, status_code, headers
     end
 
-    # 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 [String] Account ID
     # @param glossary_id [String] Glossary ID
     # @param id [String] ID
@@ -255,8 +255,8 @@ module Phrase
       data
     end
 
-    # 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 [String] Account ID
     # @param glossary_id [String] Glossary ID
     # @param id [String] ID
@@ -327,8 +327,8 @@ module Phrase
       return response, status_code, headers
     end
 
-    # 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 [String] Account ID
     # @param glossary_id [String] Glossary ID
     # @param [Hash] opts the optional parameters
@@ -341,8 +341,8 @@ module Phrase
       data
     end
 
-    # 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 [String] Account ID
     # @param glossary_id [String] Glossary ID
     # @param [Hash] opts the optional parameters