phrase 2.19.0 → 2.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0194eaa428c1d460ae9a21903f5c1154607a27bb47a9db3e334f6cd8ea6df1f
-  data.tar.gz: e4c16a36534d72177f9211dba7b023a3c0884c04868430d3844380f13fd54c3d
+  metadata.gz: 3c9e6602de1415c1ef4c28f729079cfa70e3f7992c3ced10ddeb96dd0ec10bf0
+  data.tar.gz: 0b006707561ed1522bff7b484579578810f96104a29cdb30e4578a70b7f7ee31
 SHA512:
-  metadata.gz: 34cd44bb0a48b94a8a5eb4bb56f7c77ddaabd16023c7ff09333dea968601e2215486a8e36ea4b1ccd8a8a48a236cce4c21bcfca0fc2816ec9ab25d65f3cbffa7
-  data.tar.gz: d319dbabcc243faaa428420018ca6725c4d1ac3c953182fbe6240b205942c06ae45bc962480c33fd381d510096edd8ca796510cb4338f997714c337ae923bad3
+  metadata.gz: 171702d0e6a75af786cbcbec72029688b9904c67aff83acdd156c8b1e5b9f8620bcfb6f36c6299cfb2733db8ebd38dd1ab4a58feafbfa112ab6008796ad3fc24
+  data.tar.gz: 868b4c03c4e83a9feeaa217996125fd76c17ce4a5982c6afcb23740cd5a83f0ed8a81e56105f6950c0cca62df06e5b0d5a0727d0d279f8b6edbc6a1b6fb56e75

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [2.21.0](https://github.com/phrase/openapi/compare/ruby-v2.20.0...ruby-v2.21.0) (2023-12-13)
+
+
+### Features
+
+* Add reports locales endpoint to API [TSS-2439] ([#465](https://github.com/phrase/openapi/issues/465)) ([e03aa9f](https://github.com/phrase/openapi/commit/e03aa9f49f031517b36db715fe70e8e0b65a438b))
+* **API:** add Custom Metadata endpoints ([#474](https://github.com/phrase/openapi/issues/474)) ([d407d8b](https://github.com/phrase/openapi/commit/d407d8be5ccddec1afde14a12804a7a616f77d7a))
+* **API:** Add custom_metadata_filters param to locale download endpoint [TSI-2174] ([#478](https://github.com/phrase/openapi/issues/478)) ([3623478](https://github.com/phrase/openapi/commit/3623478fc1518b457ab018b5630a693081637d6e))
+* **API:** Add url field to uploads ([#481](https://github.com/phrase/openapi/issues/481)) ([7332a84](https://github.com/phrase/openapi/commit/7332a84f9958346f2fb28dee4b0353519ef466d5))
+
+## [2.20.0](https://github.com/phrase/openapi/compare/ruby-v2.19.0...ruby-v2.20.0) (2023-11-03)
+
+
+### Features
+
+* [TSI-2083] enable format_options argument for java-client   ([#426](https://github.com/phrase/openapi/issues/426)) ([faa8cb3](https://github.com/phrase/openapi/commit/faa8cb353ba9f1030b9f7cfd46b894b4d6d26e70))
+
 ## [2.19.0](https://github.com/phrase/openapi/compare/ruby-v2.18.0...ruby-v2.19.0) (2023-10-30)
 
 

data/README.md

@@ -7,7 +7,7 @@ Phrase Strings is a translation management platform for software projects. You c
 ## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 2.19.0
+- Package version: 2.21.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.19.0.gem
+gem install ./phrase-2.21.0.gem
 ```
 
-(for development, run `gem install --dev ./phrase-2.19.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./phrase-2.21.0.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -170,6 +170,11 @@ Class | Method | HTTP request | Description
 *Phrase::CommentsApi* | [**comment_show**](docs/CommentsApi.md#comment_show) | **GET** /projects/{project_id}/keys/{key_id}/comments/{id} | Get a single comment
 *Phrase::CommentsApi* | [**comment_update**](docs/CommentsApi.md#comment_update) | **PATCH** /projects/{project_id}/keys/{key_id}/comments/{id} | Update a comment
 *Phrase::CommentsApi* | [**comments_list**](docs/CommentsApi.md#comments_list) | **GET** /projects/{project_id}/keys/{key_id}/comments | List comments
+*Phrase::CustomMetadataApi* | [**custom_metadata_properties_delete**](docs/CustomMetadataApi.md#custom_metadata_properties_delete) | **DELETE** /accounts/{account_id}/custom_metadata/properties/{id} | Destroy property
+*Phrase::CustomMetadataApi* | [**custom_metadata_properties_list**](docs/CustomMetadataApi.md#custom_metadata_properties_list) | **GET** /accounts/{account_id}/custom_metadata/properties | List properties
+*Phrase::CustomMetadataApi* | [**custom_metadata_property_create**](docs/CustomMetadataApi.md#custom_metadata_property_create) | **POST** /accounts/{account_id}/custom_metadata/properties | Create a property
+*Phrase::CustomMetadataApi* | [**custom_metadata_property_show**](docs/CustomMetadataApi.md#custom_metadata_property_show) | **GET** /accounts/{account_id}/custom_metadata/properties/{id} | Get a single property
+*Phrase::CustomMetadataApi* | [**custom_metadata_property_update**](docs/CustomMetadataApi.md#custom_metadata_property_update) | **PATCH** /accounts/{account_id}/custom_metadata/properties/{id} | Update a property
 *Phrase::DistributionsApi* | [**distribution_create**](docs/DistributionsApi.md#distribution_create) | **POST** /accounts/{account_id}/distributions | Create a distribution
 *Phrase::DistributionsApi* | [**distribution_delete**](docs/DistributionsApi.md#distribution_delete) | **DELETE** /accounts/{account_id}/distributions/{id} | Delete a distribution
 *Phrase::DistributionsApi* | [**distribution_show**](docs/DistributionsApi.md#distribution_show) | **GET** /accounts/{account_id}/distributions/{id} | Get a single distribution
@@ -306,6 +311,8 @@ Class | Method | HTTP request | Description
 *Phrase::ReleasesApi* | [**release_show**](docs/ReleasesApi.md#release_show) | **GET** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Get a single release
 *Phrase::ReleasesApi* | [**release_update**](docs/ReleasesApi.md#release_update) | **PATCH** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Update a release
 *Phrase::ReleasesApi* | [**releases_list**](docs/ReleasesApi.md#releases_list) | **GET** /accounts/{account_id}/distributions/{distribution_id}/releases | List releases
+*Phrase::ReportsApi* | [**report_locales_list**](docs/ReportsApi.md#report_locales_list) | **GET** /projects/{project_id}/report/locales | List Locale Reports
+*Phrase::ReportsApi* | [**report_show**](docs/ReportsApi.md#report_show) | **GET** /projects/{project_id}/report | Get Project Report
 *Phrase::ScreenshotMarkersApi* | [**screenshot_marker_create**](docs/ScreenshotMarkersApi.md#screenshot_marker_create) | **POST** /projects/{project_id}/screenshots/{screenshot_id}/markers | Create a screenshot marker
 *Phrase::ScreenshotMarkersApi* | [**screenshot_marker_delete**](docs/ScreenshotMarkersApi.md#screenshot_marker_delete) | **DELETE** /projects/{project_id}/screenshots/{screenshot_id}/markers | Delete a screenshot marker
 *Phrase::ScreenshotMarkersApi* | [**screenshot_marker_show**](docs/ScreenshotMarkersApi.md#screenshot_marker_show) | **GET** /projects/{project_id}/screenshots/{screenshot_id}/markers/{id} | Get a single screenshot marker
@@ -414,6 +421,10 @@ Class | Method | HTTP request | Description
  - [Phrase::CommentUpdateParameters](docs/CommentUpdateParameters.md)
  - [Phrase::CommentsListParameters](docs/CommentsListParameters.md)
  - [Phrase::CurrentUser](docs/CurrentUser.md)
+ - [Phrase::CustomMetadataDataType](docs/CustomMetadataDataType.md)
+ - [Phrase::CustomMetadataProperty](docs/CustomMetadataProperty.md)
+ - [Phrase::CustomMetadataPropertyCreate422Response](docs/CustomMetadataPropertyCreate422Response.md)
+ - [Phrase::CustomMetadataPropertyCreate422ResponseErrorsInner](docs/CustomMetadataPropertyCreate422ResponseErrorsInner.md)
  - [Phrase::Distribution](docs/Distribution.md)
  - [Phrase::DistributionCreateParameters](docs/DistributionCreateParameters.md)
  - [Phrase::DistributionPreview](docs/DistributionPreview.md)
@@ -443,8 +454,6 @@ Class | Method | HTTP request | Description
  - [Phrase::Icu](docs/Icu.md)
  - [Phrase::IcuSkeletonParameters](docs/IcuSkeletonParameters.md)
  - [Phrase::Invitation](docs/Invitation.md)
- - [Phrase::InvitationCreate422Response](docs/InvitationCreate422Response.md)
- - [Phrase::InvitationCreate422ResponseErrorsInner](docs/InvitationCreate422ResponseErrorsInner.md)
  - [Phrase::InvitationCreateParameters](docs/InvitationCreateParameters.md)
  - [Phrase::InvitationUpdateParameters](docs/InvitationUpdateParameters.md)
  - [Phrase::InvitationUpdateSettingsParameters](docs/InvitationUpdateSettingsParameters.md)
@@ -487,6 +496,7 @@ Class | Method | HTTP request | Description
  - [Phrase::LocaleDetails](docs/LocaleDetails.md)
  - [Phrase::LocalePreview](docs/LocalePreview.md)
  - [Phrase::LocalePreview1](docs/LocalePreview1.md)
+ - [Phrase::LocaleReport](docs/LocaleReport.md)
  - [Phrase::LocaleStatistics](docs/LocaleStatistics.md)
  - [Phrase::LocaleTeamPreview](docs/LocaleTeamPreview.md)
  - [Phrase::LocaleUpdateParameters](docs/LocaleUpdateParameters.md)
@@ -512,6 +522,7 @@ Class | Method | HTTP request | Description
  - [Phrase::ProjectCreateParameters](docs/ProjectCreateParameters.md)
  - [Phrase::ProjectDetails](docs/ProjectDetails.md)
  - [Phrase::ProjectLocales](docs/ProjectLocales.md)
+ - [Phrase::ProjectReport](docs/ProjectReport.md)
  - [Phrase::ProjectShort](docs/ProjectShort.md)
  - [Phrase::ProjectUpdateParameters](docs/ProjectUpdateParameters.md)
  - [Phrase::Release](docs/Release.md)

data/docs/CustomMetadataApi.md

@@ -0,0 +1,353 @@
+# Phrase::CustomMetadataApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**custom_metadata_properties_delete**](CustomMetadataApi.md#custom_metadata_properties_delete) | **DELETE** /accounts/{account_id}/custom_metadata/properties/{id} | Destroy property
+[**custom_metadata_properties_list**](CustomMetadataApi.md#custom_metadata_properties_list) | **GET** /accounts/{account_id}/custom_metadata/properties | List properties
+[**custom_metadata_property_create**](CustomMetadataApi.md#custom_metadata_property_create) | **POST** /accounts/{account_id}/custom_metadata/properties | Create a property
+[**custom_metadata_property_show**](CustomMetadataApi.md#custom_metadata_property_show) | **GET** /accounts/{account_id}/custom_metadata/properties/{id} | Get a single property
+[**custom_metadata_property_update**](CustomMetadataApi.md#custom_metadata_property_update) | **PATCH** /accounts/{account_id}/custom_metadata/properties/{id} | Update a property
+
+
+
+## custom_metadata_properties_delete
+
+> custom_metadata_properties_delete(account_id, id, opts)
+
+Destroy property
+
+Destroy a custom metadata property of an account.  This endpoint is only available to accounts with advanced plans or above. 
+
+### 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::CustomMetadataApi.new
+account_id = 'account_id_example' # String | Account ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Destroy property
+  api_instance.custom_metadata_properties_delete(account_id, id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling CustomMetadataApi->custom_metadata_properties_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<(nil (empty response body))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## custom_metadata_properties_list
+
+> Array&lt;CustomMetadataProperty&gt; custom_metadata_properties_list(account_id, opts)
+
+List properties
+
+List all custom metadata properties for an account.  This endpoint is only available to accounts with advanced plans or above. 
+
+### 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::CustomMetadataApi.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)
+  data_type: Phrase::CustomMetadataDataType::BOOLEAN, # CustomMetadataDataType | Data Type of Custom Metadata Property
+  project_id: 'abcd1234cdef1234abcd1234cdef1234', # String | id of project that the properties belong to
+  page: 1, # Integer | Page number
+  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
+  sort: 'updated_at', # String | Sort criteria. Can be one of: name, data_type, created_at.
+  order: 'desc' # String | Order direction. Can be one of: asc, desc.
+}
+
+begin
+  #List properties
+  result = api_instance.custom_metadata_properties_list(account_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling CustomMetadataApi->custom_metadata_properties_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **data_type** | [**CustomMetadataDataType**](.md)| Data Type of Custom Metadata Property | [optional] 
+ **project_id** | **String**| id of project that the properties belong to | [optional] 
+ **page** | **Integer**| Page number | [optional] 
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional] 
+ **sort** | **String**| Sort criteria. Can be one of: name, data_type, created_at. | [optional] 
+ **order** | **String**| Order direction. Can be one of: asc, desc. | [optional] 
+
+### Return type
+
+Response<([**Array&lt;CustomMetadataProperty&gt;**](CustomMetadataProperty.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## custom_metadata_property_create
+
+> CustomMetadataProperty custom_metadata_property_create(account_id, name, data_type, opts)
+
+Create a property
+
+Create a new custom metadata property.
+
+### 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::CustomMetadataApi.new
+account_id = 'account_id_example' # String | Account ID
+name = '["Fruit"]' # String | name of the property
+data_type = Phrase::CustomMetadataDataType::BOOLEAN # CustomMetadataDataType | Data Type of Custom Metadata Property
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  description: '["A healthy snack for all ages"]', # String | description of property
+  project_ids: ['inner_example'], # Array<String> | ids of projects that the property belongs to
+  value_options: ['inner_example'] # Array<String> | value options of property (only applies to single or multi select properties)
+}
+
+begin
+  #Create a property
+  result = api_instance.custom_metadata_property_create(account_id, name, data_type, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling CustomMetadataApi->custom_metadata_property_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID | 
+ **name** | **String**| name of the property | 
+ **data_type** | [**CustomMetadataDataType**](.md)| Data Type of Custom Metadata Property | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **description** | **String**| description of property | [optional] 
+ **project_ids** | [**Array&lt;String&gt;**](String.md)| ids of projects that the property belongs to | [optional] 
+ **value_options** | [**Array&lt;String&gt;**](String.md)| value options of property (only applies to single or multi select properties) | [optional] 
+
+### Return type
+
+Response<([**CustomMetadataProperty**](CustomMetadataProperty.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## custom_metadata_property_show
+
+> CustomMetadataProperty custom_metadata_property_show(account_id, id, opts)
+
+Get a single property
+
+Get details of a single custom property.
+
+### 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::CustomMetadataApi.new
+account_id = 'account_id_example' # String | Account 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 property
+  result = api_instance.custom_metadata_property_show(account_id, id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling CustomMetadataApi->custom_metadata_property_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**CustomMetadataProperty**](CustomMetadataProperty.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## custom_metadata_property_update
+
+> CustomMetadataProperty custom_metadata_property_update(account_id, id, opts)
+
+Update a property
+
+Update an existing custom metadata property.
+
+### 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::CustomMetadataApi.new
+account_id = 'account_id_example' # String | Account ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  name: '["Fruit"]', # String | name of the property
+  description: '["A healthy snack for all ages"]', # String | description of property
+  project_ids: ['inner_example'], # Array<String> | ids of projects that the property belongs to
+  value_options: ['inner_example'] # Array<String> | value options of property (only applies to single or multi select properties)
+}
+
+begin
+  #Update a property
+  result = api_instance.custom_metadata_property_update(account_id, id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling CustomMetadataApi->custom_metadata_property_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **name** | **String**| name of the property | [optional] 
+ **description** | **String**| description of property | [optional] 
+ **project_ids** | [**Array&lt;String&gt;**](String.md)| ids of projects that the property belongs to | [optional] 
+ **value_options** | [**Array&lt;String&gt;**](String.md)| value options of property (only applies to single or multi select properties) | [optional] 
+
+### Return type
+
+Response<([**CustomMetadataProperty**](CustomMetadataProperty.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CustomMetadataDataType.md

@@ -0,0 +1,16 @@
+# Phrase::CustomMetadataDataType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::CustomMetadataDataType.new()
+```
+
+

data/docs/CustomMetadataProperty.md

@@ -0,0 +1,33 @@
+# Phrase::CustomMetadataProperty
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**data_type** | [**CustomMetadataDataType**](CustomMetadataDataType.md) |  | [optional] 
+**user** | [**UserPreview**](UserPreview.md) |  | [optional] 
+**projects** | [**Array<ProjectShort>**](ProjectShort.md) |  | [optional] 
+**value_options** | **Array<String>** |  | [optional] 
+**created_at** | **Time** |  | [optional] 
+**updated_at** | **Time** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::CustomMetadataProperty.new(id: null,
+                                 name: null,
+                                 description: null,
+                                 data_type: null,
+                                 user: null,
+                                 projects: null,
+                                 value_options: null,
+                                 created_at: null,
+                                 updated_at: null)
+```
+
+

data/docs/CustomMetadataPropertyCreate422Response.md

@@ -0,0 +1,19 @@
+# Phrase::CustomMetadataPropertyCreate422Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** |  | [optional] 
+**errors** | [**Array<CustomMetadataPropertyCreate422ResponseErrorsInner>**](CustomMetadataPropertyCreate422ResponseErrorsInner.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::CustomMetadataPropertyCreate422Response.new(message: null,
+                                 errors: null)
+```
+
+

data/docs/{InvitationCreate422ResponseErrorsInner.md → CustomMetadataPropertyCreate422ResponseErrorsInner.md}

@@ -1,4 +1,4 @@
-# Phrase::InvitationCreate422ResponseErrorsInner
+# Phrase::CustomMetadataPropertyCreate422ResponseErrorsInner
 
 ## Properties
 
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'Phrase'
 
-instance = Phrase::InvitationCreate422ResponseErrorsInner.new(resource: null,
+instance = Phrase::CustomMetadataPropertyCreate422ResponseErrorsInner.new(resource: null,
                                  field: null,
                                  message: null)
 ```

data/docs/KeyCreateParameters.md

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
 **original_file** | **String** | Original file attribute. Used in some formats, e.g. XLIFF. | [optional] 
 **localized_format_string** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional] 
 **localized_format_key** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional] 
+**custom_metadata** | **Object** | Custom metadata property name and value pairs to be associated with key. | [optional] 
 
 ## Code Sample
 
@@ -34,14 +35,15 @@ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
                                  data_type: number,
                                  tags: awesome-feature,needs-proofreading,
                                  max_characters_allowed: 140,
-                                 screenshot: [B@4ee5d723,
+                                 screenshot: [B@20865ff2,
                                  remove_screenshot: null,
                                  unformatted: null,
                                  default_translation_content: Default translation content,
                                  xml_space_preserve: null,
                                  original_file: null,
                                  localized_format_string: null,
-                                 localized_format_key: null)
+                                 localized_format_key: null,
+                                 custom_metadata: {"fruit":"Apple","vegetable":"Tomato"})
 ```
 
 

data/docs/KeyUpdateParameters.md

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
 **original_file** | **String** | Original file attribute. Used in some formats, e.g. XLIFF. | [optional] 
 **localized_format_string** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional] 
 **localized_format_key** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional] 
+**custom_metadata** | **Object** | Updates/Creates custom metadata property name and value pairs to be associated with key. If you want to delete a custom metadata property, you can set its value to null. If you want to update a custom metadata property, you can set its value to the new value. | [optional] 
 
 ## Code Sample
 
@@ -33,13 +34,14 @@ instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
                                  data_type: number,
                                  tags: awesome-feature,needs-proofreading,
                                  max_characters_allowed: 140,
-                                 screenshot: [B@6f88319b,
+                                 screenshot: [B@1a7c593b,
                                  remove_screenshot: null,
                                  unformatted: null,
                                  xml_space_preserve: null,
                                  original_file: null,
                                  localized_format_string: null,
-                                 localized_format_key: null)
+                                 localized_format_key: null,
+                                 custom_metadata: {"fruit":"Apple","vegetable":"Tomato"})
 ```
 
 

data/docs/KeysApi.md

@@ -501,7 +501,7 @@ opts = {
   branch: 'my-feature-branch', # String | specify the branch to use
   sort: 'updated_at', # String | Sort by field. Can be one of: name, created_at, updated_at.
   order: 'desc', # String | Order direction. Can be one of: asc, desc.
-  q: 'mykey* translated:true', # String | 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 - spaces, commas, and colons  need to be escaped with double backslashes</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>. 
+  q: 'mykey* translated:true', # String | 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 a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes</li>   <li><code>tags:tag_name,...</code> to filter for keys with certain comma-seperated list of tags</li>   <li><code>uploads:upload_id,...</code> to filter for keys with certain comma-seperated list of uploads</li>   <li><code>job:{true|false}</code> to filter for keys mentioned in an active job</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{&gt;=|&lt;=}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>. 
   locale_id: 'abcd1234abcd1234abcd1234abcd1234' # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
 }
 
@@ -526,7 +526,7 @@ Name | Type | Description  | Notes
  **branch** | **String**| specify the branch to use | [optional] 
  **sort** | **String**| Sort by field. Can be one of: name, created_at, updated_at. | [optional] 
  **order** | **String**| Order direction. Can be one of: asc, desc. | [optional] 
- **q** | **String**| Specify a query to do broad search for keys by name (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt;   &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt;   &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes&lt;/li&gt;   &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt;   &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt;   &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt;   &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id&lt;/code&gt; to filter keys unmentioned within upload&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;.  | [optional] 
+ **q** | **String**| Specify a query to do broad search for keys by name (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt;   &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt;   &lt;li&gt;&lt;code&gt;name:key_name,...&lt;/code&gt; for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt;   &lt;li&gt;&lt;code&gt;tags:tag_name,...&lt;/code&gt; to filter for keys with certain comma-seperated list of tags&lt;/li&gt;   &lt;li&gt;&lt;code&gt;uploads:upload_id,...&lt;/code&gt; to filter for keys with certain comma-seperated list of uploads&lt;/li&gt;   &lt;li&gt;&lt;code&gt;job:{true|false}&lt;/code&gt; to filter for keys mentioned in an active job&lt;/li&gt;   &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt;   &lt;li&gt;&lt;code&gt;updated_at:{&amp;gt;&#x3D;|&amp;lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt;   &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id&lt;/code&gt; to filter keys unmentioned within upload&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;.  | [optional] 
  **locale_id** | **String**| Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional] 
 
 ### Return type

data/docs/KeysSearchParameters.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **branch** | **String** | specify the branch to use | [optional] 
 **sort** | **String** | Sort by field. Can be one of: name, created_at, updated_at. | [optional] 
 **order** | **String** | Order direction. Can be one of: asc, desc. | [optional] 
-**q** | **String** | 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 - spaces, commas, and colons  need to be escaped with double backslashes</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>. Please note: If <code>tags</code> are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys.  | [optional] 
+**q** | **String** | 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 a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes</li>   <li><code>tags:tag_name,...</code> to filter for keys with certain comma-seperated list of tags</li>   <li><code>uploads:upload_id,...</code> to filter for keys with certain comma-seperated list of uploads</li>   <li><code>job:{true|false}</code> to filter for keys mentioned in an active job</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>. Please note: If <code>tags</code> are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys.  | [optional] 
 **locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional] 
 
 ## Code Sample