Skip to content

Commit

Permalink
Deploying from phrase/openapi@ce2ed948
Browse files Browse the repository at this point in the history
  • Loading branch information
Phrase committed Jan 2, 2024
1 parent d46117b commit 3498464
Show file tree
Hide file tree
Showing 17 changed files with 703 additions and 82 deletions.
6 changes: 6 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ docs/CommentsListParameters.md
docs/CurrentUser.md
docs/CustomMetadataApi.md
docs/CustomMetadataDataType.md
docs/CustomMetadataPropertiesCreateParameters.md
docs/CustomMetadataPropertiesUpdateParameters.md
docs/CustomMetadataProperty.md
docs/CustomMetadataPropertyCreate422Response.md
docs/CustomMetadataPropertyCreate422ResponseErrorsInner.md
Expand Down Expand Up @@ -341,6 +343,8 @@ lib/phrase/models/comment_update_parameters.rb
lib/phrase/models/comments_list_parameters.rb
lib/phrase/models/current_user.rb
lib/phrase/models/custom_metadata_data_type.rb
lib/phrase/models/custom_metadata_properties_create_parameters.rb
lib/phrase/models/custom_metadata_properties_update_parameters.rb
lib/phrase/models/custom_metadata_property.rb
lib/phrase/models/custom_metadata_property_create422_response.rb
lib/phrase/models/custom_metadata_property_create422_response_errors_inner.rb
Expand Down Expand Up @@ -592,6 +596,8 @@ spec/models/comment_update_parameters_spec.rb
spec/models/comments_list_parameters_spec.rb
spec/models/current_user_spec.rb
spec/models/custom_metadata_data_type_spec.rb
spec/models/custom_metadata_properties_create_parameters_spec.rb
spec/models/custom_metadata_properties_update_parameters_spec.rb
spec/models/custom_metadata_property_create422_response_errors_inner_spec.rb
spec/models/custom_metadata_property_create422_response_spec.rb
spec/models/custom_metadata_property_spec.rb
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,8 @@ Class | Method | HTTP request | Description
- [Phrase::CommentsListParameters](docs/CommentsListParameters.md)
- [Phrase::CurrentUser](docs/CurrentUser.md)
- [Phrase::CustomMetadataDataType](docs/CustomMetadataDataType.md)
- [Phrase::CustomMetadataPropertiesCreateParameters](docs/CustomMetadataPropertiesCreateParameters.md)
- [Phrase::CustomMetadataPropertiesUpdateParameters](docs/CustomMetadataPropertiesUpdateParameters.md)
- [Phrase::CustomMetadataProperty](docs/CustomMetadataProperty.md)
- [Phrase::CustomMetadataPropertyCreate422Response](docs/CustomMetadataPropertyCreate422Response.md)
- [Phrase::CustomMetadataPropertyCreate422ResponseErrorsInner](docs/CustomMetadataPropertyCreate422ResponseErrorsInner.md)
Expand Down
38 changes: 12 additions & 26 deletions docs/CustomMetadataApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Response<([**Array&lt;CustomMetadataProperty&gt;**](CustomMetadataProperty.md))>

## custom_metadata_property_create

> CustomMetadataProperty custom_metadata_property_create(account_id, name, data_type, opts)
> CustomMetadataProperty custom_metadata_property_create(account_id, custom_metadata_properties_create_parameters, opts)
Create a property

Expand All @@ -173,18 +173,14 @@ 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
custom_metadata_properties_create_parameters = Phrase::CustomMetadataPropertiesCreateParameters.new({name: 'Fruit', data_type: Phrase::CustomMetadataDataType::BOOLEAN}) # CustomMetadataPropertiesCreateParameters |
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)
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
#Create a property
result = api_instance.custom_metadata_property_create(account_id, name, data_type, opts)
result = api_instance.custom_metadata_property_create(account_id, custom_metadata_properties_create_parameters, opts)
pp result
rescue Phrase::ApiError => e
puts "Exception when calling CustomMetadataApi->custom_metadata_property_create: #{e}"
Expand All @@ -197,12 +193,8 @@ end
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 |
**custom_metadata_properties_create_parameters** | [**CustomMetadataPropertiesCreateParameters**](CustomMetadataPropertiesCreateParameters.md)| |
**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

Expand All @@ -214,7 +206,7 @@ Response<([**CustomMetadataProperty**](CustomMetadataProperty.md))>

### HTTP request headers

- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: application/json


Expand Down Expand Up @@ -283,7 +275,7 @@ Response<([**CustomMetadataProperty**](CustomMetadataProperty.md))>

## custom_metadata_property_update

> CustomMetadataProperty custom_metadata_property_update(account_id, id, opts)
> CustomMetadataProperty custom_metadata_property_update(account_id, id, custom_metadata_properties_update_parameters, opts)
Update a property

Expand All @@ -308,17 +300,14 @@ end
api_instance = Phrase::CustomMetadataApi.new
account_id = 'account_id_example' # String | Account ID
id = 'id_example' # String | ID
custom_metadata_properties_update_parameters = Phrase::CustomMetadataPropertiesUpdateParameters.new # CustomMetadataPropertiesUpdateParameters |
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)
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
#Update a property
result = api_instance.custom_metadata_property_update(account_id, id, opts)
result = api_instance.custom_metadata_property_update(account_id, id, custom_metadata_properties_update_parameters, opts)
pp result
rescue Phrase::ApiError => e
puts "Exception when calling CustomMetadataApi->custom_metadata_property_update: #{e}"
Expand All @@ -332,11 +321,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**account_id** | **String**| Account ID |
**id** | **String**| ID |
**custom_metadata_properties_update_parameters** | [**CustomMetadataPropertiesUpdateParameters**](CustomMetadataPropertiesUpdateParameters.md)| |
**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

Expand All @@ -348,6 +334,6 @@ Response<([**CustomMetadataProperty**](CustomMetadataProperty.md))>

### HTTP request headers

- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: application/json

25 changes: 25 additions & 0 deletions docs/CustomMetadataPropertiesCreateParameters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Phrase::CustomMetadataPropertiesCreateParameters

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | name of the property |
**data_type** | [**CustomMetadataDataType**](CustomMetadataDataType.md) | |
**project_ids** | **Array&lt;String&gt;** | ids of projects that the property belongs to | [optional]
**description** | **String** | description of property | [optional]
**value_options** | **Array&lt;String&gt;** | value options of property (only applies to single or multi select properties) | [optional]

## Code Sample

```ruby
require 'Phrase'

instance = Phrase::CustomMetadataPropertiesCreateParameters.new(name: Fruit,
data_type: null,
project_ids: [&quot;abcd1234cdef1234abcd1234cdef1234&quot;,&quot;abcd1234cdef1234abcd1234cdef4321&quot;],
description: A healthy snack for all ages,
value_options: [&quot;Apple&quot;,&quot;Banana&quot;,&quot;Coconut&quot;])
```


23 changes: 23 additions & 0 deletions docs/CustomMetadataPropertiesUpdateParameters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Phrase::CustomMetadataPropertiesUpdateParameters

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | name of the property | [optional]
**project_ids** | **Array&lt;String&gt;** | ids of projects that the property belongs to | [optional]
**description** | **String** | description of property | [optional]
**value_options** | **Array&lt;String&gt;** | value options of property (only applies to single or multi select properties) | [optional]

## Code Sample

```ruby
require 'Phrase'

instance = Phrase::CustomMetadataPropertiesUpdateParameters.new(name: Fruit,
project_ids: [&quot;abcd1234cdef1234abcd1234cdef1234&quot;,&quot;abcd1234cdef1234abcd1234cdef4321&quot;],
description: A healthy snack for all ages,
value_options: [&quot;Apple&quot;,&quot;Banana&quot;,&quot;Coconut&quot;])
```


2 changes: 1 addition & 1 deletion docs/KeyCreateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
data_type: number,
tags: awesome-feature,needs-proofreading,
max_characters_allowed: 140,
screenshot: [B@20865ff2,
screenshot: [B@73dbb666,
remove_screenshot: null,
unformatted: null,
default_translation_content: Default translation content,
Expand Down
2 changes: 1 addition & 1 deletion docs/KeyUpdateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
data_type: number,
tags: awesome-feature,needs-proofreading,
max_characters_allowed: 140,
screenshot: [B@1a7c593b,
screenshot: [B@1bf5745,
remove_screenshot: null,
unformatted: null,
xml_space_preserve: null,
Expand Down
2 changes: 1 addition & 1 deletion docs/ProjectCreateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
main_format: yml,
media: Python,
shares_translation_memory: true,
project_image: [B@5c96d290,
project_image: [B@2cf065e9,
remove_project_image: null,
account_id: abcd1234,
point_of_contact: abcd1234,
Expand Down
2 changes: 1 addition & 1 deletion docs/ProjectUpdateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
main_format: yml,
media: Python,
shares_translation_memory: true,
project_image: [B@3e908a0b,
project_image: [B@d9fe131,
remove_project_image: false,
workflow: review,
machine_translation_enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion docs/ScreenshotUpdateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ require 'Phrase'
instance = Phrase::ScreenshotUpdateParameters.new(branch: my-feature-branch,
name: A screenshot name,
description: A screenshot description,
filename: [B@4aee166d)
filename: [B@5c2b5f27)
```


2 changes: 2 additions & 0 deletions lib/phrase.rb
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@
require 'phrase/models/comments_list_parameters'
require 'phrase/models/current_user'
require 'phrase/models/custom_metadata_data_type'
require 'phrase/models/custom_metadata_properties_create_parameters'
require 'phrase/models/custom_metadata_properties_update_parameters'
require 'phrase/models/custom_metadata_property'
require 'phrase/models/custom_metadata_property_create422_response'
require 'phrase/models/custom_metadata_property_create422_response_errors_inner'
Expand Down
Loading

0 comments on commit 3498464

Please sign in to comment.