Skip to content

Commit

Permalink
Deploying from phrase/openapi@08d9846b
Browse files Browse the repository at this point in the history
  • Loading branch information
Phrase committed Apr 4, 2024
1 parent 54addfa commit d368a54
Show file tree
Hide file tree
Showing 8 changed files with 97 additions and 61 deletions.
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@4b0e0dd5,
screenshot: [B@59a8891e,
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@608c36a6,
screenshot: [B@f054e29,
remove_screenshot: null,
unformatted: null,
xml_space_preserve: null,
Expand Down
40 changes: 24 additions & 16 deletions docs/LinkedKeysApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Method | HTTP request | Description

## key_links_batch_destroy

> key_links_batch_destroy(account_id, key_links_batch_destroy_parameters, opts)
> key_links_batch_destroy(project_id, id, key_links_batch_destroy_parameters, opts)
Batch unlink child keys from a parent key

Expand All @@ -36,7 +36,8 @@ Phrase.configure do |config|
end

api_instance = Phrase::LinkedKeysApi.new
account_id = 'account_id_example' # String | Account ID
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | Parent Translation Key ID
key_links_batch_destroy_parameters = Phrase::KeyLinksBatchDestroyParameters.new({child_key_ids: ["child_key_id1", "child_key_id2"]}) # KeyLinksBatchDestroyParameters |
opts = {
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
Expand All @@ -45,7 +46,7 @@ opts = {

begin
#Batch unlink child keys from a parent key
api_instance.key_links_batch_destroy(account_id, key_links_batch_destroy_parameters, opts)
api_instance.key_links_batch_destroy(project_id, id, key_links_batch_destroy_parameters, opts)
rescue Phrase::ApiError => e
puts "Exception when calling LinkedKeysApi->key_links_batch_destroy: #{e}"
end
Expand All @@ -56,7 +57,8 @@ end

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**account_id** | **String**| Account ID |
**project_id** | **String**| Project ID |
**id** | **String**| Parent Translation Key ID |
**key_links_batch_destroy_parameters** | [**KeyLinksBatchDestroyParameters**](KeyLinksBatchDestroyParameters.md)| |
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
**unlink_parent** | **Boolean**| Whether to unlink the parent key as well and unmark it as linked-key. | [optional]
Expand All @@ -77,7 +79,7 @@ Response<(nil (empty response body))>

## key_links_create

> KeyLink key_links_create(account_id, key_links_create_parameters, opts)
> KeyLink key_links_create(project_id, id, key_links_create_parameters, opts)
Link child keys to a parent key

Expand All @@ -100,15 +102,16 @@ Phrase.configure do |config|
end

api_instance = Phrase::LinkedKeysApi.new
account_id = 'account_id_example' # String | Account ID
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | Parent Translation Key ID
key_links_create_parameters = Phrase::KeyLinksCreateParameters.new({child_key_ids: ["child_key_id1", "child_key_id2"]}) # KeyLinksCreateParameters |
opts = {
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
#Link child keys to a parent key
result = api_instance.key_links_create(account_id, key_links_create_parameters, opts)
result = api_instance.key_links_create(project_id, id, key_links_create_parameters, opts)
pp result
rescue Phrase::ApiError => e
puts "Exception when calling LinkedKeysApi->key_links_create: #{e}"
Expand All @@ -120,7 +123,8 @@ end

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**account_id** | **String**| Account ID |
**project_id** | **String**| Project ID |
**id** | **String**| Parent Translation Key ID |
**key_links_create_parameters** | [**KeyLinksCreateParameters**](KeyLinksCreateParameters.md)| |
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]

Expand All @@ -140,7 +144,7 @@ Response<([**KeyLink**](KeyLink.md))>

## key_links_destroy

> key_links_destroy(account_id, child_key_id, opts)
> key_links_destroy(project_id, id, child_key_id, opts)
Unlink a child key from a parent key

Expand All @@ -163,15 +167,16 @@ Phrase.configure do |config|
end

api_instance = Phrase::LinkedKeysApi.new
account_id = 'account_id_example' # String | Account ID
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | Parent Translation Key ID
child_key_id = 'child_key_id_example' # String | The ID of the child key to unlink.
opts = {
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
#Unlink a child key from a parent key
api_instance.key_links_destroy(account_id, child_key_id, opts)
api_instance.key_links_destroy(project_id, id, child_key_id, opts)
rescue Phrase::ApiError => e
puts "Exception when calling LinkedKeysApi->key_links_destroy: #{e}"
end
Expand All @@ -182,7 +187,8 @@ end

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**account_id** | **String**| Account ID |
**project_id** | **String**| Project ID |
**id** | **String**| Parent Translation Key ID |
**child_key_id** | **String**| The ID of the child key to unlink. |
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]

Expand All @@ -202,7 +208,7 @@ Response<(nil (empty response body))>

## key_links_index

> KeyLink key_links_index(account_id, opts)
> KeyLink key_links_index(project_id, id, opts)
Retrieve all child keys linked to a specific parent key

Expand All @@ -225,14 +231,15 @@ Phrase.configure do |config|
end

api_instance = Phrase::LinkedKeysApi.new
account_id = 'account_id_example' # String | Account ID
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | Parent Translation Key ID
opts = {
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
#Retrieve all child keys linked to a specific parent key
result = api_instance.key_links_index(account_id, opts)
result = api_instance.key_links_index(project_id, id, opts)
pp result
rescue Phrase::ApiError => e
puts "Exception when calling LinkedKeysApi->key_links_index: #{e}"
Expand All @@ -244,7 +251,8 @@ end

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**account_id** | **String**| Account ID |
**project_id** | **String**| Project ID |
**id** | **String**| Parent Translation Key ID |
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]

### Return type
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@7d80f543,
project_image: [B@2c890ee3,
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@2531c319,
project_image: [B@62068fa5,
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@315edc50)
filename: [B@3db2665d)
```


Loading

0 comments on commit d368a54

Please sign in to comment.