phrase 1.0.10 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +25 -9
- data/docs/CurrentUser.md +31 -0
- data/docs/Invitation.md +9 -1
- data/docs/InvitationCreateParameters.md +4 -0
- data/docs/InvitationUpdateParameters.md +4 -0
- data/docs/InvitationUpdateSettingsParameters.md +19 -0
- data/docs/InvitationsApi.md +66 -0
- data/docs/JobLocale.md +5 -1
- data/docs/KeysApi.md +5 -5
- data/docs/LocalesApi.md +5 -4
- data/docs/Member.md +7 -1
- data/docs/MemberProjectDetail.md +35 -0
- data/docs/MemberProjectDetailProjectRoles.md +19 -0
- data/docs/MemberSpaces.md +25 -0
- data/docs/MemberUpdateParameters.md +4 -0
- data/docs/MemberUpdateSettingsParameters.md +19 -0
- data/docs/MembersApi.md +66 -0
- data/docs/ProjectUpdateParameters.md +43 -9
- data/docs/ScreenshotCreateParameters.md +3 -1
- data/docs/ScreenshotMarkerCreateParameters.md +3 -1
- data/docs/ScreenshotMarkerUpdateParameters.md +3 -1
- data/docs/ScreenshotMarkersApi.md +9 -3
- data/docs/ScreenshotUpdateParameters.md +3 -1
- data/docs/ScreenshotsApi.md +8 -2
- data/docs/TranslationsApi.md +25 -25
- data/docs/UsersApi.md +2 -2
- data/docs/Variable.md +23 -0
- data/docs/VariableCreateParameters.md +19 -0
- data/docs/VariableUpdateParameters.md +19 -0
- data/docs/VariablesApi.md +331 -0
- data/lib/phrase.rb +10 -0
- data/lib/phrase/api/invitations_api.rb +80 -0
- data/lib/phrase/api/keys_api.rb +6 -6
- data/lib/phrase/api/locales_api.rb +5 -3
- data/lib/phrase/api/members_api.rb +80 -0
- data/lib/phrase/api/screenshot_markers_api.rb +9 -0
- data/lib/phrase/api/screenshots_api.rb +9 -0
- data/lib/phrase/api/translations_api.rb +35 -35
- data/lib/phrase/api/users_api.rb +3 -3
- data/lib/phrase/api/variables_api.rb +378 -0
- data/lib/phrase/models/current_user.rb +257 -0
- data/lib/phrase/models/invitation.rb +48 -4
- data/lib/phrase/models/invitation_create_parameters.rb +25 -1
- data/lib/phrase/models/invitation_update_parameters.rb +25 -1
- data/lib/phrase/models/invitation_update_settings_parameters.rb +207 -0
- data/lib/phrase/models/job_locale.rb +22 -4
- data/lib/phrase/models/member.rb +35 -4
- data/lib/phrase/models/member_project_detail.rb +285 -0
- data/lib/phrase/models/member_project_detail_project_roles.rb +203 -0
- data/lib/phrase/models/member_spaces.rb +230 -0
- data/lib/phrase/models/member_update_parameters.rb +25 -1
- data/lib/phrase/models/member_update_settings_parameters.rb +207 -0
- data/lib/phrase/models/project_update_parameters.rb +183 -13
- data/lib/phrase/models/screenshot_create_parameters.rb +11 -1
- data/lib/phrase/models/screenshot_marker_create_parameters.rb +11 -1
- data/lib/phrase/models/screenshot_marker_update_parameters.rb +11 -1
- data/lib/phrase/models/screenshot_update_parameters.rb +11 -1
- data/lib/phrase/models/variable.rb +221 -0
- data/lib/phrase/models/variable_create_parameters.rb +205 -0
- data/lib/phrase/models/variable_update_parameters.rb +205 -0
- data/lib/phrase/version.rb +1 -1
- data/spec/api/invitations_api_spec.rb +15 -0
- data/spec/api/keys_api_spec.rb +2 -2
- data/spec/api/locales_api_spec.rb +1 -1
- data/spec/api/members_api_spec.rb +15 -0
- data/spec/api/screenshot_markers_api_spec.rb +3 -0
- data/spec/api/screenshots_api_spec.rb +3 -0
- data/spec/api/translations_api_spec.rb +10 -10
- data/spec/api/users_api_spec.rb +1 -1
- data/spec/api/variables_api_spec.rb +95 -0
- data/spec/models/current_user_spec.rb +71 -0
- data/spec/models/invitation_create_parameters_spec.rb +12 -0
- data/spec/models/invitation_spec.rb +24 -0
- data/spec/models/invitation_update_parameters_spec.rb +12 -0
- data/spec/models/invitation_update_settings_parameters_spec.rb +35 -0
- data/spec/models/job_locale_spec.rb +12 -0
- data/spec/models/member_project_detail_project_roles_spec.rb +35 -0
- data/spec/models/member_project_detail_spec.rb +83 -0
- data/spec/models/member_spaces_spec.rb +53 -0
- data/spec/models/member_spec.rb +18 -0
- data/spec/models/member_update_parameters_spec.rb +12 -0
- data/spec/models/member_update_settings_parameters_spec.rb +35 -0
- data/spec/models/project_update_parameters_spec.rb +103 -1
- data/spec/models/screenshot_create_parameters_spec.rb +6 -0
- data/spec/models/screenshot_marker_create_parameters_spec.rb +6 -0
- data/spec/models/screenshot_marker_update_parameters_spec.rb +6 -0
- data/spec/models/screenshot_update_parameters_spec.rb +6 -0
- data/spec/models/variable_create_parameters_spec.rb +35 -0
- data/spec/models/variable_spec.rb +47 -0
- data/spec/models/variable_update_parameters_spec.rb +35 -0
- metadata +203 -163
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1e59f0b86fbb8c281e8c41892c24797cb0e74c6491c6226003fe6e93a0d2d2e5
|
4
|
+
data.tar.gz: 5ccd88c3044eb45af04bb35cef1cf4baf151900a1c223a38891dc8bd96bb5df1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1b73a93e0771c2779dfe2a773255eb644ffb0bd2b7a4627b22f30986feae49e8413f56a5b66934758350c4559a8351c95d69baff54806d4f82d5bec25a407cb6
|
7
|
+
data.tar.gz: af6d04c26da5c0e3f651fa924760d3fd3b28d97e4144e21f763a6375148dc28e118f8a1b14b564d7aa8e6ef1525fd0c2c21dd86312c90d1e8fb003aae9593117
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Phrase is a translation management platform for software projects. You can colla
|
|
7
7
|
## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version:
|
10
|
+
- Package version: 2.0.0
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
|
13
13
|
|
@@ -56,10 +56,10 @@ gem build phrase.gemspec
|
|
56
56
|
Then install the gem locally:
|
57
57
|
|
58
58
|
```shell
|
59
|
-
gem install ./phrase-
|
59
|
+
gem install ./phrase-2.0.0.gem
|
60
60
|
```
|
61
61
|
|
62
|
-
(for development, run `gem install --dev ./phrase-
|
62
|
+
(for development, run `gem install --dev ./phrase-2.0.0.gem` to install the development dependencies)
|
63
63
|
|
64
64
|
## Getting Started
|
65
65
|
|
@@ -169,6 +169,7 @@ Class | Method | HTTP request | Description
|
|
169
169
|
*Phrase::InvitationsApi* | [**invitation_resend**](docs/InvitationsApi.md#invitation_resend) | **POST** /accounts/{account_id}/invitations/{id}/resend | Resend an invitation
|
170
170
|
*Phrase::InvitationsApi* | [**invitation_show**](docs/InvitationsApi.md#invitation_show) | **GET** /accounts/{account_id}/invitations/{id} | Get a single invitation
|
171
171
|
*Phrase::InvitationsApi* | [**invitation_update**](docs/InvitationsApi.md#invitation_update) | **PATCH** /accounts/{account_id}/invitations/{id} | Update an invitation
|
172
|
+
*Phrase::InvitationsApi* | [**invitation_update_settings**](docs/InvitationsApi.md#invitation_update_settings) | **PATCH** /projects/{project_id}/invitations/{id} | Update a member's invitation access
|
172
173
|
*Phrase::InvitationsApi* | [**invitations_list**](docs/InvitationsApi.md#invitations_list) | **GET** /accounts/{account_id}/invitations | List invitations
|
173
174
|
*Phrase::JobLocalesApi* | [**job_locale_complete**](docs/JobLocalesApi.md#job_locale_complete) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/complete | Complete a job locale
|
174
175
|
*Phrase::JobLocalesApi* | [**job_locale_delete**](docs/JobLocalesApi.md#job_locale_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/locales/{id} | Delete a job locale
|
@@ -192,7 +193,7 @@ Class | Method | HTTP request | Description
|
|
192
193
|
*Phrase::KeysApi* | [**key_delete**](docs/KeysApi.md#key_delete) | **DELETE** /projects/{project_id}/keys/{id} | Delete a key
|
193
194
|
*Phrase::KeysApi* | [**key_show**](docs/KeysApi.md#key_show) | **GET** /projects/{project_id}/keys/{id} | Get a single key
|
194
195
|
*Phrase::KeysApi* | [**key_update**](docs/KeysApi.md#key_update) | **PATCH** /projects/{project_id}/keys/{id} | Update a key
|
195
|
-
*Phrase::KeysApi* | [**
|
196
|
+
*Phrase::KeysApi* | [**keys_delete_collection**](docs/KeysApi.md#keys_delete_collection) | **DELETE** /projects/{project_id}/keys | Delete collection of keys
|
196
197
|
*Phrase::KeysApi* | [**keys_list**](docs/KeysApi.md#keys_list) | **GET** /projects/{project_id}/keys | List keys
|
197
198
|
*Phrase::KeysApi* | [**keys_search**](docs/KeysApi.md#keys_search) | **POST** /projects/{project_id}/keys/search | Search keys
|
198
199
|
*Phrase::KeysApi* | [**keys_tag**](docs/KeysApi.md#keys_tag) | **PATCH** /projects/{project_id}/keys/tag | Add tags to collection of keys
|
@@ -206,6 +207,7 @@ Class | Method | HTTP request | Description
|
|
206
207
|
*Phrase::MembersApi* | [**member_delete**](docs/MembersApi.md#member_delete) | **DELETE** /accounts/{account_id}/members/{id} | Remove a user from the account
|
207
208
|
*Phrase::MembersApi* | [**member_show**](docs/MembersApi.md#member_show) | **GET** /accounts/{account_id}/members/{id} | Get single member
|
208
209
|
*Phrase::MembersApi* | [**member_update**](docs/MembersApi.md#member_update) | **PATCH** /accounts/{account_id}/members/{id} | Update a member
|
210
|
+
*Phrase::MembersApi* | [**member_update_settings**](docs/MembersApi.md#member_update_settings) | **PATCH** /projects/{project_id}/members/{id} | Update a member's project settings
|
209
211
|
*Phrase::MembersApi* | [**members_list**](docs/MembersApi.md#members_list) | **GET** /accounts/{account_id}/members | List members
|
210
212
|
*Phrase::OrdersApi* | [**order_confirm**](docs/OrdersApi.md#order_confirm) | **PATCH** /projects/{project_id}/orders/{id}/confirm | Confirm an order
|
211
213
|
*Phrase::OrdersApi* | [**order_create**](docs/OrdersApi.md#order_create) | **POST** /projects/{project_id}/orders | Create a new order
|
@@ -271,17 +273,22 @@ Class | Method | HTTP request | Description
|
|
271
273
|
*Phrase::TranslationsApi* | [**translation_verify**](docs/TranslationsApi.md#translation_verify) | **PATCH** /projects/{project_id}/translations/{id}/verify | Verify a translation
|
272
274
|
*Phrase::TranslationsApi* | [**translations_by_key**](docs/TranslationsApi.md#translations_by_key) | **GET** /projects/{project_id}/keys/{key_id}/translations | List translations by key
|
273
275
|
*Phrase::TranslationsApi* | [**translations_by_locale**](docs/TranslationsApi.md#translations_by_locale) | **GET** /projects/{project_id}/locales/{locale_id}/translations | List translations by locale
|
274
|
-
*Phrase::TranslationsApi* | [**
|
275
|
-
*Phrase::TranslationsApi* | [**
|
276
|
+
*Phrase::TranslationsApi* | [**translations_exclude_collection**](docs/TranslationsApi.md#translations_exclude_collection) | **PATCH** /projects/{project_id}/translations/exclude | Set exclude from export flag on translations selected by query
|
277
|
+
*Phrase::TranslationsApi* | [**translations_include_collection**](docs/TranslationsApi.md#translations_include_collection) | **PATCH** /projects/{project_id}/translations/include | Remove exlude from import flag from translations selected by query
|
276
278
|
*Phrase::TranslationsApi* | [**translations_list**](docs/TranslationsApi.md#translations_list) | **GET** /projects/{project_id}/translations | List all translations
|
277
|
-
*Phrase::TranslationsApi* | [**
|
279
|
+
*Phrase::TranslationsApi* | [**translations_review_collection**](docs/TranslationsApi.md#translations_review_collection) | **PATCH** /projects/{project_id}/translations/review | Review translations selected by query
|
278
280
|
*Phrase::TranslationsApi* | [**translations_search**](docs/TranslationsApi.md#translations_search) | **POST** /projects/{project_id}/translations/search | Search translations
|
279
|
-
*Phrase::TranslationsApi* | [**
|
280
|
-
*Phrase::TranslationsApi* | [**
|
281
|
+
*Phrase::TranslationsApi* | [**translations_unverify_collection**](docs/TranslationsApi.md#translations_unverify_collection) | **PATCH** /projects/{project_id}/translations/unverify | Mark translations selected by query as unverified
|
282
|
+
*Phrase::TranslationsApi* | [**translations_verify_collection**](docs/TranslationsApi.md#translations_verify_collection) | **PATCH** /projects/{project_id}/translations/verify | Verify translations selected by query
|
281
283
|
*Phrase::UploadsApi* | [**upload_create**](docs/UploadsApi.md#upload_create) | **POST** /projects/{project_id}/uploads | Upload a new file
|
282
284
|
*Phrase::UploadsApi* | [**upload_show**](docs/UploadsApi.md#upload_show) | **GET** /projects/{project_id}/uploads/{id} | View upload details
|
283
285
|
*Phrase::UploadsApi* | [**uploads_list**](docs/UploadsApi.md#uploads_list) | **GET** /projects/{project_id}/uploads | List uploads
|
284
286
|
*Phrase::UsersApi* | [**show_user**](docs/UsersApi.md#show_user) | **GET** /user | Show current User
|
287
|
+
*Phrase::VariablesApi* | [**variable_create**](docs/VariablesApi.md#variable_create) | **POST** /projects/{project_id}/variables | Create a variable
|
288
|
+
*Phrase::VariablesApi* | [**variable_delete**](docs/VariablesApi.md#variable_delete) | **DELETE** /projects/{project_id}/variables/{name} | Delete a variable
|
289
|
+
*Phrase::VariablesApi* | [**variable_show**](docs/VariablesApi.md#variable_show) | **GET** /projects/{project_id}/variables/{name} | Get a single variable
|
290
|
+
*Phrase::VariablesApi* | [**variable_update**](docs/VariablesApi.md#variable_update) | **PATCH** /projects/{project_id}/variables/{name} | Update a variable
|
291
|
+
*Phrase::VariablesApi* | [**variables_list**](docs/VariablesApi.md#variables_list) | **GET** /projects/{project_id}/variables | List variables
|
285
292
|
*Phrase::VersionsHistoryApi* | [**version_show**](docs/VersionsHistoryApi.md#version_show) | **GET** /projects/{project_id}/translations/{translation_id}/versions/{id} | Get a single version
|
286
293
|
*Phrase::VersionsHistoryApi* | [**versions_list**](docs/VersionsHistoryApi.md#versions_list) | **GET** /projects/{project_id}/translations/{translation_id}/versions | List all versions
|
287
294
|
*Phrase::WebhooksApi* | [**webhook_create**](docs/WebhooksApi.md#webhook_create) | **POST** /projects/{project_id}/webhooks | Create a webhook
|
@@ -320,6 +327,7 @@ Class | Method | HTTP request | Description
|
|
320
327
|
- [Phrase::CommentCreateParameters](docs/CommentCreateParameters.md)
|
321
328
|
- [Phrase::CommentMarkReadParameters](docs/CommentMarkReadParameters.md)
|
322
329
|
- [Phrase::CommentUpdateParameters](docs/CommentUpdateParameters.md)
|
330
|
+
- [Phrase::CurrentUser](docs/CurrentUser.md)
|
323
331
|
- [Phrase::Distribution](docs/Distribution.md)
|
324
332
|
- [Phrase::DistributionCreateParameters](docs/DistributionCreateParameters.md)
|
325
333
|
- [Phrase::DistributionPreview](docs/DistributionPreview.md)
|
@@ -347,6 +355,7 @@ Class | Method | HTTP request | Description
|
|
347
355
|
- [Phrase::Invitation](docs/Invitation.md)
|
348
356
|
- [Phrase::InvitationCreateParameters](docs/InvitationCreateParameters.md)
|
349
357
|
- [Phrase::InvitationUpdateParameters](docs/InvitationUpdateParameters.md)
|
358
|
+
- [Phrase::InvitationUpdateSettingsParameters](docs/InvitationUpdateSettingsParameters.md)
|
350
359
|
- [Phrase::Job](docs/Job.md)
|
351
360
|
- [Phrase::JobCompleteParameters](docs/JobCompleteParameters.md)
|
352
361
|
- [Phrase::JobCreateParameters](docs/JobCreateParameters.md)
|
@@ -376,7 +385,11 @@ Class | Method | HTTP request | Description
|
|
376
385
|
- [Phrase::LocaleStatistics](docs/LocaleStatistics.md)
|
377
386
|
- [Phrase::LocaleUpdateParameters](docs/LocaleUpdateParameters.md)
|
378
387
|
- [Phrase::Member](docs/Member.md)
|
388
|
+
- [Phrase::MemberProjectDetail](docs/MemberProjectDetail.md)
|
389
|
+
- [Phrase::MemberProjectDetailProjectRoles](docs/MemberProjectDetailProjectRoles.md)
|
390
|
+
- [Phrase::MemberSpaces](docs/MemberSpaces.md)
|
379
391
|
- [Phrase::MemberUpdateParameters](docs/MemberUpdateParameters.md)
|
392
|
+
- [Phrase::MemberUpdateSettingsParameters](docs/MemberUpdateSettingsParameters.md)
|
380
393
|
- [Phrase::OrderConfirmParameters](docs/OrderConfirmParameters.md)
|
381
394
|
- [Phrase::OrderCreateParameters](docs/OrderCreateParameters.md)
|
382
395
|
- [Phrase::Project](docs/Project.md)
|
@@ -448,6 +461,9 @@ Class | Method | HTTP request | Description
|
|
448
461
|
- [Phrase::UploadSummary](docs/UploadSummary.md)
|
449
462
|
- [Phrase::User](docs/User.md)
|
450
463
|
- [Phrase::UserPreview](docs/UserPreview.md)
|
464
|
+
- [Phrase::Variable](docs/Variable.md)
|
465
|
+
- [Phrase::VariableCreateParameters](docs/VariableCreateParameters.md)
|
466
|
+
- [Phrase::VariableUpdateParameters](docs/VariableUpdateParameters.md)
|
451
467
|
- [Phrase::Webhook](docs/Webhook.md)
|
452
468
|
- [Phrase::WebhookCreateParameters](docs/WebhookCreateParameters.md)
|
453
469
|
- [Phrase::WebhookUpdateParameters](docs/WebhookUpdateParameters.md)
|
data/docs/CurrentUser.md
ADDED
@@ -0,0 +1,31 @@
|
|
1
|
+
# Phrase::CurrentUser
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**username** | **String** | | [optional]
|
9
|
+
**name** | **String** | | [optional]
|
10
|
+
**email** | **String** | | [optional]
|
11
|
+
**position** | **String** | | [optional]
|
12
|
+
**language** | **String** | | [optional]
|
13
|
+
**created_at** | **DateTime** | | [optional]
|
14
|
+
**updated_at** | **DateTime** | | [optional]
|
15
|
+
|
16
|
+
## Code Sample
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'Phrase'
|
20
|
+
|
21
|
+
instance = Phrase::CurrentUser.new(id: null,
|
22
|
+
username: null,
|
23
|
+
name: null,
|
24
|
+
email: null,
|
25
|
+
position: null,
|
26
|
+
language: null,
|
27
|
+
created_at: null,
|
28
|
+
updated_at: null)
|
29
|
+
```
|
30
|
+
|
31
|
+
|
data/docs/Invitation.md
CHANGED
@@ -10,10 +10,14 @@ Name | Type | Description | Notes
|
|
10
10
|
**state** | **String** | | [optional]
|
11
11
|
**projects** | [**Array<ProjectShort>**](ProjectShort.md) | | [optional]
|
12
12
|
**locales** | [**Array<LocalePreview>**](LocalePreview.md) | | [optional]
|
13
|
+
**default_locale_codes** | **Array<String>** | | [optional]
|
13
14
|
**permissions** | [**Object**](.md) | | [optional]
|
15
|
+
**locale_ids** | **Array<String>** | | [optional]
|
14
16
|
**created_at** | **DateTime** | | [optional]
|
15
17
|
**updated_at** | **DateTime** | | [optional]
|
16
18
|
**accepted_at** | **DateTime** | | [optional]
|
19
|
+
**spaces** | [**Array<MemberSpaces>**](MemberSpaces.md) | | [optional]
|
20
|
+
**project_role** | [**Array<MemberProjectDetailProjectRoles>**](MemberProjectDetailProjectRoles.md) | | [optional]
|
17
21
|
|
18
22
|
## Code Sample
|
19
23
|
|
@@ -26,10 +30,14 @@ instance = Phrase::Invitation.new(id: null,
|
|
26
30
|
state: null,
|
27
31
|
projects: null,
|
28
32
|
locales: null,
|
33
|
+
default_locale_codes: null,
|
29
34
|
permissions: null,
|
35
|
+
locale_ids: null,
|
30
36
|
created_at: null,
|
31
37
|
updated_at: null,
|
32
|
-
accepted_at: null
|
38
|
+
accepted_at: null,
|
39
|
+
spaces: null,
|
40
|
+
project_role: null)
|
33
41
|
```
|
34
42
|
|
35
43
|
|
@@ -8,6 +8,8 @@ Name | Type | Description | Notes
|
|
8
8
|
**role** | **String** | Invitiation role, can be any of Manager, Developer, Translator. | [optional]
|
9
9
|
**project_ids** | **String** | List of project ids the invited user has access to. | [optional]
|
10
10
|
**locale_ids** | **String** | List of locale ids the invited user has access to. | [optional]
|
11
|
+
**space_ids** | **Array<String>** | List of spaces the user is assigned to. | [optional]
|
12
|
+
**default_locale_codes** | **Array<String>** | List of default locales for the user. | [optional]
|
11
13
|
**permissions** | **Hash<String, String>** | Additional permissions depending on invitation role. Available permissions are <code>create_upload</code> and <code>review_translations</code> | [optional]
|
12
14
|
|
13
15
|
## Code Sample
|
@@ -19,6 +21,8 @@ instance = Phrase::InvitationCreateParameters.new(email: example@mail.com,
|
|
19
21
|
role: Developer,
|
20
22
|
project_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
|
21
23
|
locale_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
|
24
|
+
space_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],
|
25
|
+
default_locale_codes: ["en","de"],
|
22
26
|
permissions: {"create_upload":true,"review_translations":true})
|
23
27
|
```
|
24
28
|
|
@@ -7,6 +7,8 @@ Name | Type | Description | Notes
|
|
7
7
|
**role** | **String** | Invitiation role, can be any of Manager, Developer, Translator | [optional]
|
8
8
|
**project_ids** | **String** | List of project ids the invited user has access to | [optional]
|
9
9
|
**locale_ids** | **String** | List of locale ids the invited user has access to | [optional]
|
10
|
+
**space_ids** | **Array<String>** | List of spaces the user is assigned to. | [optional]
|
11
|
+
**default_locale_codes** | **Array<String>** | List of default locales for the user. | [optional]
|
10
12
|
**permissions** | **Hash<String, String>** | Additional permissions depending on invitation role. | [optional]
|
11
13
|
|
12
14
|
## Code Sample
|
@@ -17,6 +19,8 @@ require 'Phrase'
|
|
17
19
|
instance = Phrase::InvitationUpdateParameters.new(role: Invitiation role,
|
18
20
|
project_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
|
19
21
|
locale_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
|
22
|
+
space_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],
|
23
|
+
default_locale_codes: ["en","de"],
|
20
24
|
permissions: {"create_upload":true})
|
21
25
|
```
|
22
26
|
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Phrase::InvitationUpdateSettingsParameters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**project_role** | **String** | Member role, can be any of of Manager, Developer, Translator | [optional]
|
8
|
+
**locale_ids** | **Array<String>** | List of locale ids the user has access to. | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'Phrase'
|
14
|
+
|
15
|
+
instance = Phrase::InvitationUpdateSettingsParameters.new(project_role: Developer,
|
16
|
+
locale_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"])
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/InvitationsApi.md
CHANGED
@@ -9,6 +9,7 @@ Method | HTTP request | Description
|
|
9
9
|
[**invitation_resend**](InvitationsApi.md#invitation_resend) | **POST** /accounts/{account_id}/invitations/{id}/resend | Resend an invitation
|
10
10
|
[**invitation_show**](InvitationsApi.md#invitation_show) | **GET** /accounts/{account_id}/invitations/{id} | Get a single invitation
|
11
11
|
[**invitation_update**](InvitationsApi.md#invitation_update) | **PATCH** /accounts/{account_id}/invitations/{id} | Update an invitation
|
12
|
+
[**invitation_update_settings**](InvitationsApi.md#invitation_update_settings) | **PATCH** /projects/{project_id}/invitations/{id} | Update a member's invitation access
|
12
13
|
[**invitations_list**](InvitationsApi.md#invitations_list) | **GET** /accounts/{account_id}/invitations | List invitations
|
13
14
|
|
14
15
|
|
@@ -329,6 +330,71 @@ Response<([**Invitation**](Invitation.md))>
|
|
329
330
|
- **Accept**: application/json
|
330
331
|
|
331
332
|
|
333
|
+
## invitation_update_settings
|
334
|
+
|
335
|
+
> Invitation invitation_update_settings(project_id, id, invitation_update_settings_parameters, opts)
|
336
|
+
|
337
|
+
Update a member's invitation access
|
338
|
+
|
339
|
+
Update member's settings in the invitations. Access token scope must include <code>team.manage</code>.
|
340
|
+
|
341
|
+
### Example
|
342
|
+
|
343
|
+
```ruby
|
344
|
+
# load the gem
|
345
|
+
require 'phrase'
|
346
|
+
# setup authorization
|
347
|
+
Phrase.configure do |config|
|
348
|
+
# Configure HTTP basic authorization: Basic
|
349
|
+
config.username = 'YOUR USERNAME'
|
350
|
+
config.password = 'YOUR PASSWORD'
|
351
|
+
|
352
|
+
# Configure API key authorization: Token
|
353
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
354
|
+
config.api_key_prefix['Authorization'] = 'token'
|
355
|
+
end
|
356
|
+
|
357
|
+
api_instance = Phrase::InvitationsApi.new
|
358
|
+
project_id = 'project_id_example' # String | Project ID
|
359
|
+
id = 'id_example' # String | ID
|
360
|
+
invitation_update_settings_parameters = Phrase::InvitationUpdateSettingsParameters.new # InvitationUpdateSettingsParameters |
|
361
|
+
opts = {
|
362
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
363
|
+
}
|
364
|
+
|
365
|
+
begin
|
366
|
+
#Update a member's invitation access
|
367
|
+
result = api_instance.invitation_update_settings(project_id, id, invitation_update_settings_parameters, opts)
|
368
|
+
pp result
|
369
|
+
rescue Phrase::ApiError => e
|
370
|
+
puts "Exception when calling InvitationsApi->invitation_update_settings: #{e}"
|
371
|
+
end
|
372
|
+
```
|
373
|
+
|
374
|
+
### Parameters
|
375
|
+
|
376
|
+
|
377
|
+
Name | Type | Description | Notes
|
378
|
+
------------- | ------------- | ------------- | -------------
|
379
|
+
**project_id** | **String**| Project ID |
|
380
|
+
**id** | **String**| ID |
|
381
|
+
**invitation_update_settings_parameters** | [**InvitationUpdateSettingsParameters**](InvitationUpdateSettingsParameters.md)| |
|
382
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
383
|
+
|
384
|
+
### Return type
|
385
|
+
|
386
|
+
Response<([**Invitation**](Invitation.md))>
|
387
|
+
|
388
|
+
### Authorization
|
389
|
+
|
390
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
391
|
+
|
392
|
+
### HTTP request headers
|
393
|
+
|
394
|
+
- **Content-Type**: application/json
|
395
|
+
- **Accept**: application/json
|
396
|
+
|
397
|
+
|
332
398
|
## invitations_list
|
333
399
|
|
334
400
|
> Array<Invitation> invitations_list(account_id, opts)
|
data/docs/JobLocale.md
CHANGED
@@ -9,6 +9,8 @@ Name | Type | Description | Notes
|
|
9
9
|
**locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
|
10
10
|
**users** | [**Array<UserPreview>**](UserPreview.md) | | [optional]
|
11
11
|
**completed** | **Boolean** | | [optional]
|
12
|
+
**translation_completed_at** | **DateTime** | | [optional]
|
13
|
+
**review_completed_at** | **DateTime** | | [optional]
|
12
14
|
|
13
15
|
## Code Sample
|
14
16
|
|
@@ -19,7 +21,9 @@ instance = Phrase::JobLocale.new(id: null,
|
|
19
21
|
job: null,
|
20
22
|
locale: null,
|
21
23
|
users: null,
|
22
|
-
completed: null
|
24
|
+
completed: null,
|
25
|
+
translation_completed_at: null,
|
26
|
+
review_completed_at: null)
|
23
27
|
```
|
24
28
|
|
25
29
|
|
data/docs/KeysApi.md
CHANGED
@@ -8,7 +8,7 @@ Method | HTTP request | Description
|
|
8
8
|
[**key_delete**](KeysApi.md#key_delete) | **DELETE** /projects/{project_id}/keys/{id} | Delete a key
|
9
9
|
[**key_show**](KeysApi.md#key_show) | **GET** /projects/{project_id}/keys/{id} | Get a single key
|
10
10
|
[**key_update**](KeysApi.md#key_update) | **PATCH** /projects/{project_id}/keys/{id} | Update a key
|
11
|
-
[**
|
11
|
+
[**keys_delete_collection**](KeysApi.md#keys_delete_collection) | **DELETE** /projects/{project_id}/keys | Delete collection of keys
|
12
12
|
[**keys_list**](KeysApi.md#keys_list) | **GET** /projects/{project_id}/keys | List keys
|
13
13
|
[**keys_search**](KeysApi.md#keys_search) | **POST** /projects/{project_id}/keys/search | Search keys
|
14
14
|
[**keys_tag**](KeysApi.md#keys_tag) | **PATCH** /projects/{project_id}/keys/tag | Add tags to collection of keys
|
@@ -273,9 +273,9 @@ Response<([**TranslationKeyDetails**](TranslationKeyDetails.md))>
|
|
273
273
|
- **Accept**: application/json
|
274
274
|
|
275
275
|
|
276
|
-
##
|
276
|
+
## keys_delete_collection
|
277
277
|
|
278
|
-
> AffectedResources
|
278
|
+
> AffectedResources keys_delete_collection(project_id, opts)
|
279
279
|
|
280
280
|
Delete collection of keys
|
281
281
|
|
@@ -308,10 +308,10 @@ opts = {
|
|
308
308
|
|
309
309
|
begin
|
310
310
|
#Delete collection of keys
|
311
|
-
result = api_instance.
|
311
|
+
result = api_instance.keys_delete_collection(project_id, opts)
|
312
312
|
pp result
|
313
313
|
rescue Phrase::ApiError => e
|
314
|
-
puts "Exception when calling KeysApi->
|
314
|
+
puts "Exception when calling KeysApi->keys_delete_collection: #{e}"
|
315
315
|
end
|
316
316
|
```
|
317
317
|
|
data/docs/LocalesApi.md
CHANGED
@@ -142,7 +142,7 @@ Response<(nil (empty response body))>
|
|
142
142
|
|
143
143
|
## locale_download
|
144
144
|
|
145
|
-
> locale_download(project_id, id, opts)
|
145
|
+
> File locale_download(project_id, id, opts)
|
146
146
|
|
147
147
|
Download a locale
|
148
148
|
|
@@ -188,7 +188,8 @@ opts = {
|
|
188
188
|
|
189
189
|
begin
|
190
190
|
#Download a locale
|
191
|
-
api_instance.locale_download(project_id, id, opts)
|
191
|
+
result = api_instance.locale_download(project_id, id, opts)
|
192
|
+
pp result
|
192
193
|
rescue Phrase::ApiError => e
|
193
194
|
puts "Exception when calling LocalesApi->locale_download: #{e}"
|
194
195
|
end
|
@@ -220,7 +221,7 @@ Name | Type | Description | Notes
|
|
220
221
|
|
221
222
|
### Return type
|
222
223
|
|
223
|
-
Response<(
|
224
|
+
Response<(**File**)>
|
224
225
|
|
225
226
|
### Authorization
|
226
227
|
|
@@ -229,7 +230,7 @@ Response<(nil (empty response body))>
|
|
229
230
|
### HTTP request headers
|
230
231
|
|
231
232
|
- **Content-Type**: Not defined
|
232
|
-
- **Accept**:
|
233
|
+
- **Accept**: *
|
233
234
|
|
234
235
|
|
235
236
|
## locale_show
|
data/docs/Member.md
CHANGED
@@ -9,6 +9,9 @@ Name | Type | Description | Notes
|
|
9
9
|
**username** | **String** | | [optional]
|
10
10
|
**role** | **String** | | [optional]
|
11
11
|
**projects** | [**Array<ProjectLocales>**](ProjectLocales.md) | | [optional]
|
12
|
+
**permissions** | [**Object**](.md) | | [optional]
|
13
|
+
**default_locale_codes** | **Array<String>** | | [optional]
|
14
|
+
**spaces** | [**Array<MemberSpaces>**](MemberSpaces.md) | | [optional]
|
12
15
|
|
13
16
|
## Code Sample
|
14
17
|
|
@@ -19,7 +22,10 @@ instance = Phrase::Member.new(id: null,
|
|
19
22
|
email: null,
|
20
23
|
username: null,
|
21
24
|
role: null,
|
22
|
-
projects: null
|
25
|
+
projects: null,
|
26
|
+
permissions: null,
|
27
|
+
default_locale_codes: null,
|
28
|
+
spaces: null)
|
23
29
|
```
|
24
30
|
|
25
31
|
|
@@ -0,0 +1,35 @@
|
|
1
|
+
# Phrase::MemberProjectDetail
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**email** | **String** | | [optional]
|
9
|
+
**username** | **String** | | [optional]
|
10
|
+
**role** | **String** | | [optional]
|
11
|
+
**projects** | [**Array<ProjectLocales>**](ProjectLocales.md) | | [optional]
|
12
|
+
**permissions** | [**Object**](.md) | | [optional]
|
13
|
+
**locale_ids** | **Array<String>** | | [optional]
|
14
|
+
**default_locale_codes** | **Array<String>** | | [optional]
|
15
|
+
**spaces** | [**Array<MemberSpaces>**](MemberSpaces.md) | | [optional]
|
16
|
+
**project_roles** | [**Array<MemberProjectDetailProjectRoles>**](MemberProjectDetailProjectRoles.md) | | [optional]
|
17
|
+
|
18
|
+
## Code Sample
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'Phrase'
|
22
|
+
|
23
|
+
instance = Phrase::MemberProjectDetail.new(id: null,
|
24
|
+
email: null,
|
25
|
+
username: null,
|
26
|
+
role: null,
|
27
|
+
projects: null,
|
28
|
+
permissions: null,
|
29
|
+
locale_ids: null,
|
30
|
+
default_locale_codes: null,
|
31
|
+
spaces: null,
|
32
|
+
project_roles: null)
|
33
|
+
```
|
34
|
+
|
35
|
+
|