Skip to content

Commit

Permalink
Deploying from phrase/openapi@d810e9eb
Browse files Browse the repository at this point in the history
  • Loading branch information
Phrase committed Apr 23, 2024
1 parent 2caae10 commit ad7dec5
Show file tree
Hide file tree
Showing 100 changed files with 288 additions and 222 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ Class | Method | HTTP request | Description
*GlossaryTermsApi* | [**glossary_term_show**](docs/GlossaryTermsApi.md#glossary_term_show) | **GET** /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} | Get a single term
*GlossaryTermsApi* | [**glossary_term_update**](docs/GlossaryTermsApi.md#glossary_term_update) | **PATCH** /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} | Update a term
*GlossaryTermsApi* | [**glossary_terms_list**](docs/GlossaryTermsApi.md#glossary_terms_list) | **GET** /accounts/{account_id}/glossaries/{glossary_id}/terms | List terms
*ICUApi* | [**icu_skeleton**](docs/ICUApi.md#icu_skeleton) | **POST** /icu/skeleton | Build icu skeletons
*ICUApi* | [**icu_skeleton**](docs/ICUApi.md#icu_skeleton) | **POST** /icu/skeleton | Build ICU skeletons
*InvitationsApi* | [**invitation_create**](docs/InvitationsApi.md#invitation_create) | **POST** /accounts/{account_id}/invitations | Create a new invitation
*InvitationsApi* | [**invitation_delete**](docs/InvitationsApi.md#invitation_delete) | **DELETE** /accounts/{account_id}/invitations/{id} | Delete an invitation
*InvitationsApi* | [**invitation_resend**](docs/InvitationsApi.md#invitation_resend) | **POST** /accounts/{account_id}/invitations/{id}/resend | Resend an invitation
Expand Down Expand Up @@ -285,7 +285,7 @@ Class | Method | HTTP request | Description
*LinkedKeysApi* | [**key_links_batch_destroy**](docs/LinkedKeysApi.md#key_links_batch_destroy) | **DELETE** /projects/{project_id}/keys/{id}/key_links | Batch unlink child keys from a parent key
*LinkedKeysApi* | [**key_links_create**](docs/LinkedKeysApi.md#key_links_create) | **POST** /projects/{project_id}/keys/{id}/key_links | Link child keys to a parent key
*LinkedKeysApi* | [**key_links_destroy**](docs/LinkedKeysApi.md#key_links_destroy) | **DELETE** /projects/{project_id}/keys/{id}/key_links/{child_key_id} | Unlink a child key from a parent key
*LinkedKeysApi* | [**key_links_index**](docs/LinkedKeysApi.md#key_links_index) | **GET** /projects/{project_id}/keys/{id}/key_links | Retrieve all child keys linked to a specific parent key
*LinkedKeysApi* | [**key_links_index**](docs/LinkedKeysApi.md#key_links_index) | **GET** /projects/{project_id}/keys/{id}/key_links | List child keys of a parent key
*LocalesApi* | [**account_locales**](docs/LocalesApi.md#account_locales) | **GET** /accounts/{id}/locales | List locales used in account
*LocalesApi* | [**locale_create**](docs/LocalesApi.md#locale_create) | **POST** /projects/{project_id}/locales | Create a locale
*LocalesApi* | [**locale_delete**](docs/LocalesApi.md#locale_delete) | **DELETE** /projects/{project_id}/locales/{id} | Delete a locale
Expand Down
2 changes: 1 addition & 1 deletion docs/AuthorizationCreateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**note** | **str** | A note to help you remember what the access is used for. | [optional]
**note** | **str** | A note to help you remember what the access is used for. |
**scopes** | **List[str]** | A list of scopes that the access can be used for. | [optional]
**expires_at** | **datetime** | Expiration date for the authorization token. Null means no expiration date (default). | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/BlacklistedKeyCreateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Blocked key name | [optional]
**name** | **str** | Blocked key name |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/BranchCreateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name of the branch | [optional]
**name** | **str** | Name of the branch |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
4 changes: 2 additions & 2 deletions docs/DistributionCreateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name of the distribution | [optional]
**project_id** | **str** | Project id the distribution should be assigned to. | [optional]
**name** | **str** | Name of the distribution |
**project_id** | **str** | Project id the distribution should be assigned to. |
**platforms** | **List[str]** | List of platforms the distribution should support. Valid values are: * `android` * `ios` * `flutter` * `i18next` * `rails` | [optional]
**locale_ids** | **List[str]** | List of locale ids that will be part of distribution releases | [optional]
**format_options** | **Dict[str, str]** | Additional formatting and render options. Only <code>enclose_in_cdata</code> is available for platform <code>android</code>. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/FigmaAttachmentCreateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**branch** | **str** | specify the branch to use | [optional]
**url** | **str** | Figma file url | [optional]
**url** | **str** | Figma file url |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/GlossaryCreateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name of the glossary | [optional]
**name** | **str** | Name of the glossary |
**project_ids** | **str** | List of project ids the glossary should be assigned to. | [optional]
**space_ids** | **List[str]** | List of space ids the glossary should be assigned to. | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/GlossaryTermCreateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**term** | **str** | Glossary term | [optional]
**term** | **str** | Glossary term |
**description** | **str** | Description of term | [optional]
**translatable** | **bool** | Indicates whether the term should be used for all languages or can be translated | [optional]
**case_sensitive** | **bool** | Indicates whether the term is case sensitive | [optional]
Expand Down
4 changes: 2 additions & 2 deletions docs/GlossaryTermTranslationCreateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**locale_code** | **str** | Identifies the language for this translation | [optional]
**content** | **str** | The content of the translation | [optional]
**locale_code** | **str** | Identifies the language for this translation |
**content** | **str** | The content of the translation |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
8 changes: 4 additions & 4 deletions docs/ICUApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ All URIs are relative to *https://api.phrase.com/v2*

Method | HTTP request | Description
------------- | ------------- | -------------
[**icu_skeleton**](ICUApi.md#icu_skeleton) | **POST** /icu/skeleton | Build icu skeletons
[**icu_skeleton**](ICUApi.md#icu_skeleton) | **POST** /icu/skeleton | Build ICU skeletons


# **icu_skeleton**
> Icu icu_skeleton(icu_skeleton_parameters, x_phrase_app_otp=x_phrase_app_otp)
Build icu skeletons
Build ICU skeletons

Returns icu skeletons for multiple locale codes based on a source content.
Returns ICU skeletons for multiple locale codes based on a source content.

### Example

Expand All @@ -35,7 +35,7 @@ with phrase_api.ApiClient(configuration) as api_client:
x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)

try:
# Build icu skeletons
# Build ICU skeletons
api_response = api_instance.icu_skeleton(icu_skeleton_parameters, x_phrase_app_otp=x_phrase_app_otp)
pprint(api_response)
except ApiException as e:
Expand Down
4 changes: 2 additions & 2 deletions docs/InvitationCreateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | The email of the invited user. The <code>email</code> can not be updated once created. Create a new invitation for each unique email. | [optional]
**role** | **str** | Invitiation role, can be any of Manager, Developer, Translator. | [optional]
**email** | **str** | The email of the invited user. The <code>email</code> can not be updated once created. Create a new invitation for each unique email. |
**role** | **str** | Invitiation role, can be any of Manager, Developer, Translator. |
**project_ids** | **str** | List of project ids the invited user has access to. | [optional]
**locale_ids** | **str** | List of locale ids the invited user has access to. | [optional]
**space_ids** | **List[str]** | List of spaces the user is assigned to. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/JobCreateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**branch** | **str** | specify the branch to use | [optional]
**name** | **str** | Job name | [optional]
**name** | **str** | Job name |
**source_locale_id** | **str** | The API id of the source language | [optional]
**briefing** | **str** | Briefing for the translators | [optional]
**due_date** | **datetime** | Date the job should be finished | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/KeyCreateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**branch** | **str** | specify the branch to use | [optional]
**name** | **str** | Key name | [optional]
**name** | **str** | Key name |
**description** | **str** | Key description (usually includes contextual information for translators) | [optional]
**plural** | **bool** | Indicates whether key supports pluralization | [optional]
**name_plural** | **str** | Plural name for the key (used in some file formats, e.g. Gettext) | [optional]
Expand Down
14 changes: 7 additions & 7 deletions docs/KeyLink.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created_at** | **datetime** | The timestamp when the link was created. |
**updated_at** | **datetime** | The timestamp when the link was last updated. |
**created_by** | [**UserPreview**](UserPreview.md) | |
**updated_by** | [**UserPreview**](UserPreview.md) | |
**account** | [**Account**](Account.md) | |
**parent** | [**KeyPreview**](KeyPreview.md) | |
**children** | [**List[KeyPreview]**](KeyPreview.md) | The child translation keys linked to the parent. |
**created_at** | **datetime** | The timestamp when the link was created. | [optional]
**updated_at** | **datetime** | The timestamp when the link was last updated. | [optional]
**created_by** | [**UserPreview**](UserPreview.md) | | [optional]
**updated_by** | [**UserPreview**](UserPreview.md) | | [optional]
**account** | [**Account**](Account.md) | | [optional]
**parent** | [**KeyPreview**](KeyPreview.md) | | [optional]
**children** | [**List[KeyPreview]**](KeyPreview.md) | The child translation keys linked to the parent. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
1 change: 1 addition & 0 deletions docs/KeyLinksBatchDestroyParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**child_key_ids** | **List[str]** | The IDs of the child keys to unlink from the parent key. |
**unlink_parent** | **bool** | Whether to unlink the parent key as well and unmark it as linked-key. | [optional] [default to False]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
12 changes: 5 additions & 7 deletions docs/LinkedKeysApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ Method | HTTP request | Description
[**key_links_batch_destroy**](LinkedKeysApi.md#key_links_batch_destroy) | **DELETE** /projects/{project_id}/keys/{id}/key_links | Batch unlink child keys from a parent key
[**key_links_create**](LinkedKeysApi.md#key_links_create) | **POST** /projects/{project_id}/keys/{id}/key_links | Link child keys to a parent key
[**key_links_destroy**](LinkedKeysApi.md#key_links_destroy) | **DELETE** /projects/{project_id}/keys/{id}/key_links/{child_key_id} | Unlink a child key from a parent key
[**key_links_index**](LinkedKeysApi.md#key_links_index) | **GET** /projects/{project_id}/keys/{id}/key_links | Retrieve all child keys linked to a specific parent key
[**key_links_index**](LinkedKeysApi.md#key_links_index) | **GET** /projects/{project_id}/keys/{id}/key_links | List child keys of a parent key


# **key_links_batch_destroy**
> key_links_batch_destroy(project_id, id, key_links_batch_destroy_parameters, x_phrase_app_otp=x_phrase_app_otp, unlink_parent=unlink_parent)
> key_links_batch_destroy(project_id, id, key_links_batch_destroy_parameters, x_phrase_app_otp=x_phrase_app_otp)
Batch unlink child keys from a parent key

Expand All @@ -38,11 +38,10 @@ with phrase_api.ApiClient(configuration) as api_client:
id = 'id_example' # str | Parent Translation Key ID (required)
key_links_batch_destroy_parameters = phrase_api.KeyLinksBatchDestroyParameters() # KeyLinksBatchDestroyParameters | (required)
x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)
unlink_parent = True # bool | Whether to unlink the parent key as well and unmark it as linked-key.

try:
# Batch unlink child keys from a parent key
api_instance.key_links_batch_destroy(project_id, id, key_links_batch_destroy_parameters, x_phrase_app_otp=x_phrase_app_otp, unlink_parent=unlink_parent)
api_instance.key_links_batch_destroy(project_id, id, key_links_batch_destroy_parameters, x_phrase_app_otp=x_phrase_app_otp)
except ApiException as e:
print("Exception when calling LinkedKeysApi->key_links_batch_destroy: %s\n" % e)
```
Expand All @@ -56,7 +55,6 @@ Name | Type | Description | Notes
**id** | **str**| Parent Translation Key ID |
**key_links_batch_destroy_parameters** | [**KeyLinksBatchDestroyParameters**](KeyLinksBatchDestroyParameters.md)| |
**x_phrase_app_otp** | **str**| Two-Factor-Authentication token (optional) | [optional]
**unlink_parent** | **bool**| Whether to unlink the parent key as well and unmark it as linked-key. | [optional]

### Return type

Expand Down Expand Up @@ -217,7 +215,7 @@ void (empty response body)
# **key_links_index**
> KeyLink key_links_index(project_id, id, x_phrase_app_otp=x_phrase_app_otp)
Retrieve all child keys linked to a specific parent key
List child keys of a parent key

Returns detailed information about a parent key, including its linked child keys.

Expand All @@ -243,7 +241,7 @@ with phrase_api.ApiClient(configuration) as api_client:
x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)

try:
# Retrieve all child keys linked to a specific parent key
# List child keys of a parent key
api_response = api_instance.key_links_index(project_id, id, x_phrase_app_otp=x_phrase_app_otp)
pprint(api_response)
except ApiException as e:
Expand Down
6 changes: 3 additions & 3 deletions docs/LocaleCreateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**branch** | **str** | specify the branch to use | [optional]
**name** | **str** | Locale name | [optional]
**code** | **str** | Locale ISO code | [optional]
**name** | **str** | Locale name |
**code** | **str** | Locale ISO code |
**default** | **bool** | Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale. | [optional]
**main** | **bool** | Indicates whether locale is a main locale. Main locales are part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Verification System</a> feature. | [optional]
**rtl** | **bool** | Indicates whether locale is a RTL (Right-to-Left) locale. | [optional]
**source_locale_id** | **str** | Source locale. Can be the name or public id of the locale. Preferred is the public id. | [optional]
**source_locale_id** | **str** | Source locale. Can be the name or id of the locale. Preferred is id. | [optional]
**fallback_locale_id** | **str** | Fallback locale for empty translations. Can be a locale name or id. | [optional]
**unverify_new_translations** | **bool** | Indicates that new translations for this locale should be marked as unverified. Part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature. | [optional]
**unverify_updated_translations** | **bool** | Indicates that updated translations for this locale should be marked as unverified. Part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/LocaleUpdateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Name | Type | Description | Notes
**default** | **bool** | Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale. | [optional]
**main** | **bool** | Indicates whether locale is a main locale. Main locales are part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Verification System</a> feature. | [optional]
**rtl** | **bool** | Indicates whether locale is a RTL (Right-to-Left) locale. | [optional]
**source_locale_id** | **str** | Source locale. Can be the name or public id of the locale. Preferred is the public id. | [optional]
**source_locale_id** | **str** | Source locale. Can be the name or id of the locale. Preferred is id. | [optional]
**fallback_locale_id** | **str** | Fallback locale for empty translations. Can be a locale name or id. | [optional]
**unverify_new_translations** | **bool** | Indicates that new translations for this locale should be marked as unverified. Part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature. | [optional]
**unverify_updated_translations** | **bool** | Indicates that updated translations for this locale should be marked as unverified. Part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature. | [optional]
Expand Down
Loading

0 comments on commit ad7dec5

Please sign in to comment.