phrase 2.7.2 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d45d77a489a122ea07543533c12e768ec5ce0998474d536afff2daade998f869
-  data.tar.gz: 19cc3226385f60568d0d4f3d45947e578e928f28b1656d9c11929381793de217
+  metadata.gz: 8bb4fc7c6855bcfd49fc954eafb1934a07e0d6aebee908d470df181533cd61e2
+  data.tar.gz: 4d5c2ec6151ceadb08ddb5d7d1f28c830896a7ea7271f61cc3ba3cd459bb21d4
 SHA512:
-  metadata.gz: 4e592fc085a9e53b7e7bcbeae4cdb199517959687634a98216ba268468699e061e5b5fd978596a2febbd1653a22a8f0393cdb0c9d36c8509dd5cf14225a96732
-  data.tar.gz: 650ed49f24f422a5e24af79f0e1c95ab3e4f04a160e2a037c88b4a7299a6434f3290307e079da3e62c9f52b4948db460d3156ad439024f5addd516e05b5aa793
+  metadata.gz: 8e306daabbd11fc612258f771889b906412d20e6e575ca067aeec9dfa003e9dcf61158b2b9d0cd023052c63d9e199b1a0ff60e6a08a0b7d5e78a3d88183c3939
+  data.tar.gz: 95193d84b529261332602a1427cfed5cd70b0869215294553e292426aae8f0bc8f678eabb3bd8081b3b8a3bf0498311f6054a0bb226da7429199a1d40b8714f5

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: 2.7.2
+- Package version: 2.8.0
 - 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-2.7.2.gem
+gem install ./phrase-2.8.0.gem
 ```
 
-(for development, run `gem install --dev ./phrase-2.7.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./phrase-2.8.0.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -324,6 +324,9 @@ Class | Method | HTTP request | Description
 *Phrase::VariablesApi* | [**variables_list**](docs/VariablesApi.md#variables_list) | **GET** /projects/{project_id}/variables | List variables
 *Phrase::VersionsHistoryApi* | [**version_show**](docs/VersionsHistoryApi.md#version_show) | **GET** /projects/{project_id}/translations/{translation_id}/versions/{id} | Get a single version
 *Phrase::VersionsHistoryApi* | [**versions_list**](docs/VersionsHistoryApi.md#versions_list) | **GET** /projects/{project_id}/translations/{translation_id}/versions | List all versions
+*Phrase::WebhookDeliveriesApi* | [**webhook_deliveries_list**](docs/WebhookDeliveriesApi.md#webhook_deliveries_list) | **GET** /projects/{project_id}/webhooks/{webhook_id}/deliveries | List webhook deliveries
+*Phrase::WebhookDeliveriesApi* | [**webhook_deliveries_redeliver**](docs/WebhookDeliveriesApi.md#webhook_deliveries_redeliver) | **POST** /projects/{project_id}/webhooks/{webhook_id}/deliveries/{id}/redeliver | Redeliver a single webhook delivery
+*Phrase::WebhookDeliveriesApi* | [**webhook_deliveries_show**](docs/WebhookDeliveriesApi.md#webhook_deliveries_show) | **GET** /projects/{project_id}/webhooks/{webhook_id}/deliveries/{id} | Get a single webhook delivery
 *Phrase::WebhooksApi* | [**webhook_create**](docs/WebhooksApi.md#webhook_create) | **POST** /projects/{project_id}/webhooks | Create a webhook
 *Phrase::WebhooksApi* | [**webhook_delete**](docs/WebhooksApi.md#webhook_delete) | **DELETE** /projects/{project_id}/webhooks/{id} | Delete a webhook
 *Phrase::WebhooksApi* | [**webhook_show**](docs/WebhooksApi.md#webhook_show) | **GET** /projects/{project_id}/webhooks/{id} | Get a single webhook
@@ -525,6 +528,7 @@ Class | Method | HTTP request | Description
  - [Phrase::VariableUpdateParameters](docs/VariableUpdateParameters.md)
  - [Phrase::Webhook](docs/Webhook.md)
  - [Phrase::WebhookCreateParameters](docs/WebhookCreateParameters.md)
+ - [Phrase::WebhookDelivery](docs/WebhookDelivery.md)
  - [Phrase::WebhookUpdateParameters](docs/WebhookUpdateParameters.md)
 
 

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/webhook_deliveries_api.rb

@@ -0,0 +1,241 @@
+require 'cgi'
+
+module Phrase
+  class WebhookDeliveriesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List webhook deliveries
+    # List all webhook deliveries for the given webhook_id.
+    # @param project_id [String] Project ID
+    # @param webhook_id [String] Webhook ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @option opts [String] :response_status_codes List of Response Status Codes
+    # @return [Array<WebhookDelivery>]
+    def webhook_deliveries_list(project_id, webhook_id, opts = {})
+      data, _status_code, _headers = webhook_deliveries_list_with_http_info(project_id, webhook_id, opts)
+      data
+    end
+
+    # List webhook deliveries
+    # List all webhook deliveries for the given webhook_id.
+    # @param project_id [String] Project ID
+    # @param webhook_id [String] Webhook ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @option opts [String] :response_status_codes List of Response Status Codes
+    # @return [Array<(Response<(Array<WebhookDelivery>)>, Integer, Hash)>] Response<(Array<WebhookDelivery>)> data, response status code and response headers
+    def webhook_deliveries_list_with_http_info(project_id, webhook_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookDeliveriesApi.webhook_deliveries_list ...'
+      end
+      # verify the required parameter 'project_id' is set
+      if @api_client.config.client_side_validation && project_id.nil?
+        fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhookDeliveriesApi.webhook_deliveries_list"
+      end
+      # verify the required parameter 'webhook_id' is set
+      if @api_client.config.client_side_validation && webhook_id.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhookDeliveriesApi.webhook_deliveries_list"
+      end
+      # resource path
+      local_var_path = '/projects/{project_id}/webhooks/{webhook_id}/deliveries'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'webhook_id' + '}', CGI.escape(webhook_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'response_status_codes'] = opts[:'response_status_codes'] if !opts[:'response_status_codes'].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<WebhookDelivery>' 
+
+      # 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: WebhookDeliveriesApi#webhook_deliveries_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      response = ::Phrase::Response.new(data, headers)
+      return response, status_code, headers
+    end
+
+    # Redeliver a single webhook delivery
+    # Trigger an individual webhook delivery to be redelivered.
+    # @param project_id [String] Project ID
+    # @param webhook_id [String] Webhook ID
+    # @param id [String] ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @return [WebhookDelivery]
+    def webhook_deliveries_redeliver(project_id, webhook_id, id, opts = {})
+      data, _status_code, _headers = webhook_deliveries_redeliver_with_http_info(project_id, webhook_id, id, opts)
+      data
+    end
+
+    # Redeliver a single webhook delivery
+    # Trigger an individual webhook delivery to be redelivered.
+    # @param project_id [String] Project ID
+    # @param webhook_id [String] Webhook ID
+    # @param id [String] ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @return [Array<(Response<(WebhookDelivery)>, Integer, Hash)>] Response<(WebhookDelivery)> data, response status code and response headers
+    def webhook_deliveries_redeliver_with_http_info(project_id, webhook_id, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookDeliveriesApi.webhook_deliveries_redeliver ...'
+      end
+      # verify the required parameter 'project_id' is set
+      if @api_client.config.client_side_validation && project_id.nil?
+        fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhookDeliveriesApi.webhook_deliveries_redeliver"
+      end
+      # verify the required parameter 'webhook_id' is set
+      if @api_client.config.client_side_validation && webhook_id.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhookDeliveriesApi.webhook_deliveries_redeliver"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling WebhookDeliveriesApi.webhook_deliveries_redeliver"
+      end
+      # resource path
+      local_var_path = '/projects/{project_id}/webhooks/{webhook_id}/deliveries/{id}/redeliver'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'webhook_id' + '}', CGI.escape(webhook_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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] || 'WebhookDelivery' 
+
+      # 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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WebhookDeliveriesApi#webhook_deliveries_redeliver\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      response = ::Phrase::Response.new(data, headers)
+      return response, status_code, headers
+    end
+
+    # Get a single webhook delivery
+    # Get all information about a single webhook delivery for the given ID.
+    # @param project_id [String] Project ID
+    # @param webhook_id [String] Webhook ID
+    # @param id [String] ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @return [WebhookDelivery]
+    def webhook_deliveries_show(project_id, webhook_id, id, opts = {})
+      data, _status_code, _headers = webhook_deliveries_show_with_http_info(project_id, webhook_id, id, opts)
+      data
+    end
+
+    # Get a single webhook delivery
+    # Get all information about a single webhook delivery for the given ID.
+    # @param project_id [String] Project ID
+    # @param webhook_id [String] Webhook ID
+    # @param id [String] ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+    # @return [Array<(Response<(WebhookDelivery)>, Integer, Hash)>] Response<(WebhookDelivery)> data, response status code and response headers
+    def webhook_deliveries_show_with_http_info(project_id, webhook_id, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookDeliveriesApi.webhook_deliveries_show ...'
+      end
+      # verify the required parameter 'project_id' is set
+      if @api_client.config.client_side_validation && project_id.nil?
+        fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhookDeliveriesApi.webhook_deliveries_show"
+      end
+      # verify the required parameter 'webhook_id' is set
+      if @api_client.config.client_side_validation && webhook_id.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhookDeliveriesApi.webhook_deliveries_show"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling WebhookDeliveriesApi.webhook_deliveries_show"
+      end
+      # resource path
+      local_var_path = '/projects/{project_id}/webhooks/{webhook_id}/deliveries/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'webhook_id' + '}', CGI.escape(webhook_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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] || 'WebhookDelivery' 
+
+      # 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: WebhookDeliveriesApi#webhook_deliveries_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      response = ::Phrase::Response.new(data, headers)
+      return response, status_code, headers
+    end
+  end
+end