phrase 1.0.6 → 1.0.11
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +9 -3
- data/docs/BranchName.md +17 -0
- data/docs/Invitation.md +5 -1
- data/docs/InvitationCreateParameters.md +4 -0
- data/docs/InvitationUpdateParameters.md +4 -0
- data/docs/Job.md +5 -3
- data/docs/JobDetails.md +4 -2
- data/docs/JobLocale.md +3 -1
- data/docs/LocalesApi.md +2 -0
- 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/ScreenshotsApi.md +3 -1
- data/docs/Webhook.md +2 -0
- data/docs/WebhookCreateParameters.md +5 -1
- data/docs/WebhookUpdateParameters.md +5 -1
- data/lib/phrase.rb +5 -0
- data/lib/phrase/api/locales_api.rb +3 -0
- data/lib/phrase/api/members_api.rb +80 -0
- data/lib/phrase/api/screenshots_api.rb +3 -0
- data/lib/phrase/api_client.rb +2 -0
- data/lib/phrase/models/branch_name.rb +194 -0
- data/lib/phrase/models/invitation.rb +26 -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/job.rb +22 -13
- data/lib/phrase/models/job_details.rb +19 -10
- data/lib/phrase/models/job_locale.rb +13 -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/webhook.rb +10 -1
- data/lib/phrase/models/webhook_create_parameters.rb +24 -4
- data/lib/phrase/models/webhook_update_parameters.rb +24 -4
- data/lib/phrase/version.rb +1 -1
- data/spec/api/locales_api_spec.rb +1 -0
- data/spec/api/members_api_spec.rb +15 -0
- data/spec/api/screenshots_api_spec.rb +1 -0
- data/spec/models/branch_name_spec.rb +29 -0
- data/spec/models/invitation_create_parameters_spec.rb +12 -0
- data/spec/models/invitation_spec.rb +12 -0
- data/spec/models/invitation_update_parameters_spec.rb +12 -0
- data/spec/models/job_details_spec.rb +9 -3
- data/spec/models/job_locale_spec.rb +6 -0
- data/spec/models/job_spec.rb +9 -3
- 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/webhook_create_parameters_spec.rb +12 -0
- data/spec/models/webhook_spec.rb +6 -0
- data/spec/models/webhook_update_parameters_spec.rb +12 -0
- metadata +182 -162
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 45c88312fc99c777087d2256ed62bb7214e7975d35c94b6009b6de16ce52badb
|
4
|
+
data.tar.gz: d3ef0a73a994c0ed6c06172cd2f95fb46e9ad419cde1a1040965cea420f438dd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 34144375558920d59506076f076e2dcfb82107eb7894254e81e1527e543a34aaae6b3055d151de6b9e843add51b1d96b6d5e48bce9e59f2b2dbfc772b065555b
|
7
|
+
data.tar.gz: 3de8db3b78370971dfb8a0ef3392d428e1751ecd1050713c5d0d4c55d8293b0ba266772118a22723b5eb6c15cbe3fd3d45c649807d6b1d6f0003194ffabb1995
|
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: 1.0.
|
10
|
+
- Package version: 1.0.11
|
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-1.0.
|
59
|
+
gem install ./phrase-1.0.11.gem
|
60
60
|
```
|
61
61
|
|
62
|
-
(for development, run `gem install --dev ./phrase-1.0.
|
62
|
+
(for development, run `gem install --dev ./phrase-1.0.11.gem` to install the development dependencies)
|
63
63
|
|
64
64
|
## Getting Started
|
65
65
|
|
@@ -206,6 +206,7 @@ Class | Method | HTTP request | Description
|
|
206
206
|
*Phrase::MembersApi* | [**member_delete**](docs/MembersApi.md#member_delete) | **DELETE** /accounts/{account_id}/members/{id} | Remove a user from the account
|
207
207
|
*Phrase::MembersApi* | [**member_show**](docs/MembersApi.md#member_show) | **GET** /accounts/{account_id}/members/{id} | Get single member
|
208
208
|
*Phrase::MembersApi* | [**member_update**](docs/MembersApi.md#member_update) | **PATCH** /accounts/{account_id}/members/{id} | Update a member
|
209
|
+
*Phrase::MembersApi* | [**member_update_settings**](docs/MembersApi.md#member_update_settings) | **PATCH** /projects/{project_id}/members/{id} | Update a member's project settings
|
209
210
|
*Phrase::MembersApi* | [**members_list**](docs/MembersApi.md#members_list) | **GET** /accounts/{account_id}/members | List members
|
210
211
|
*Phrase::OrdersApi* | [**order_confirm**](docs/OrdersApi.md#order_confirm) | **PATCH** /projects/{project_id}/orders/{id}/confirm | Confirm an order
|
211
212
|
*Phrase::OrdersApi* | [**order_create**](docs/OrdersApi.md#order_create) | **POST** /projects/{project_id}/orders | Create a new order
|
@@ -314,6 +315,7 @@ Class | Method | HTTP request | Description
|
|
314
315
|
- [Phrase::Branch](docs/Branch.md)
|
315
316
|
- [Phrase::BranchCreateParameters](docs/BranchCreateParameters.md)
|
316
317
|
- [Phrase::BranchMergeParameters](docs/BranchMergeParameters.md)
|
318
|
+
- [Phrase::BranchName](docs/BranchName.md)
|
317
319
|
- [Phrase::BranchUpdateParameters](docs/BranchUpdateParameters.md)
|
318
320
|
- [Phrase::Comment](docs/Comment.md)
|
319
321
|
- [Phrase::CommentCreateParameters](docs/CommentCreateParameters.md)
|
@@ -375,7 +377,11 @@ Class | Method | HTTP request | Description
|
|
375
377
|
- [Phrase::LocaleStatistics](docs/LocaleStatistics.md)
|
376
378
|
- [Phrase::LocaleUpdateParameters](docs/LocaleUpdateParameters.md)
|
377
379
|
- [Phrase::Member](docs/Member.md)
|
380
|
+
- [Phrase::MemberProjectDetail](docs/MemberProjectDetail.md)
|
381
|
+
- [Phrase::MemberProjectDetailProjectRoles](docs/MemberProjectDetailProjectRoles.md)
|
382
|
+
- [Phrase::MemberSpaces](docs/MemberSpaces.md)
|
378
383
|
- [Phrase::MemberUpdateParameters](docs/MemberUpdateParameters.md)
|
384
|
+
- [Phrase::MemberUpdateSettingsParameters](docs/MemberUpdateSettingsParameters.md)
|
379
385
|
- [Phrase::OrderConfirmParameters](docs/OrderConfirmParameters.md)
|
380
386
|
- [Phrase::OrderCreateParameters](docs/OrderCreateParameters.md)
|
381
387
|
- [Phrase::Project](docs/Project.md)
|
data/docs/BranchName.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# Phrase::BranchName
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'Phrase'
|
13
|
+
|
14
|
+
instance = Phrase::BranchName.new(name: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/Invitation.md
CHANGED
@@ -10,10 +10,12 @@ 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]
|
14
15
|
**created_at** | **DateTime** | | [optional]
|
15
16
|
**updated_at** | **DateTime** | | [optional]
|
16
17
|
**accepted_at** | **DateTime** | | [optional]
|
18
|
+
**spaces** | [**Array<MemberSpaces>**](MemberSpaces.md) | | [optional]
|
17
19
|
|
18
20
|
## Code Sample
|
19
21
|
|
@@ -26,10 +28,12 @@ instance = Phrase::Invitation.new(id: null,
|
|
26
28
|
state: null,
|
27
29
|
projects: null,
|
28
30
|
locales: null,
|
31
|
+
default_locale_codes: null,
|
29
32
|
permissions: null,
|
30
33
|
created_at: null,
|
31
34
|
updated_at: null,
|
32
|
-
accepted_at: null
|
35
|
+
accepted_at: null,
|
36
|
+
spaces: null)
|
33
37
|
```
|
34
38
|
|
35
39
|
|
@@ -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
|
|
data/docs/Job.md
CHANGED
@@ -10,9 +10,10 @@ Name | Type | Description | Notes
|
|
10
10
|
**due_date** | **DateTime** | | [optional]
|
11
11
|
**state** | **String** | | [optional]
|
12
12
|
**ticket_url** | **String** | | [optional]
|
13
|
+
**project** | [**ProjectShort**](ProjectShort.md) | | [optional]
|
14
|
+
**branch** | [**BranchName**](BranchName.md) | | [optional]
|
13
15
|
**created_at** | **DateTime** | | [optional]
|
14
16
|
**updated_at** | **DateTime** | | [optional]
|
15
|
-
**project** | [**ProjectShort**](ProjectShort.md) | | [optional]
|
16
17
|
|
17
18
|
## Code Sample
|
18
19
|
|
@@ -25,9 +26,10 @@ instance = Phrase::Job.new(id: null,
|
|
25
26
|
due_date: null,
|
26
27
|
state: null,
|
27
28
|
ticket_url: null,
|
29
|
+
project: null,
|
30
|
+
branch: null,
|
28
31
|
created_at: null,
|
29
|
-
updated_at: null
|
30
|
-
project: null)
|
32
|
+
updated_at: null)
|
31
33
|
```
|
32
34
|
|
33
35
|
|
data/docs/JobDetails.md
CHANGED
@@ -10,9 +10,10 @@ Name | Type | Description | Notes
|
|
10
10
|
**due_date** | **DateTime** | | [optional]
|
11
11
|
**state** | **String** | | [optional]
|
12
12
|
**ticket_url** | **String** | | [optional]
|
13
|
+
**project** | [**ProjectShort**](ProjectShort.md) | | [optional]
|
14
|
+
**branch** | [**BranchName**](BranchName.md) | | [optional]
|
13
15
|
**created_at** | **DateTime** | | [optional]
|
14
16
|
**updated_at** | **DateTime** | | [optional]
|
15
|
-
**project** | [**ProjectShort**](ProjectShort.md) | | [optional]
|
16
17
|
**owner** | [**UserPreview**](UserPreview.md) | | [optional]
|
17
18
|
**job_tag_name** | **String** | | [optional]
|
18
19
|
**locales** | [**Array<LocalePreview>**](LocalePreview.md) | | [optional]
|
@@ -29,9 +30,10 @@ instance = Phrase::JobDetails.new(id: null,
|
|
29
30
|
due_date: null,
|
30
31
|
state: null,
|
31
32
|
ticket_url: null,
|
33
|
+
project: null,
|
34
|
+
branch: null,
|
32
35
|
created_at: null,
|
33
36
|
updated_at: null,
|
34
|
-
project: null,
|
35
37
|
owner: null,
|
36
38
|
job_tag_name: null,
|
37
39
|
locales: null,
|
data/docs/JobLocale.md
CHANGED
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**job** | [**JobPreview**](JobPreview.md) | | [optional]
|
9
9
|
**locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
|
10
10
|
**users** | [**Array<UserPreview>**](UserPreview.md) | | [optional]
|
11
|
+
**completed** | **Boolean** | | [optional]
|
11
12
|
|
12
13
|
## Code Sample
|
13
14
|
|
@@ -17,7 +18,8 @@ require 'Phrase'
|
|
17
18
|
instance = Phrase::JobLocale.new(id: null,
|
18
19
|
job: null,
|
19
20
|
locale: null,
|
20
|
-
users: null
|
21
|
+
users: null,
|
22
|
+
completed: null)
|
21
23
|
```
|
22
24
|
|
23
25
|
|
data/docs/LocalesApi.md
CHANGED
@@ -174,6 +174,7 @@ opts = {
|
|
174
174
|
tags: 'feature1,feature2', # String | Limit results to keys tagged with a list of comma separated tag names.
|
175
175
|
tag: 'feature', # String | Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead
|
176
176
|
include_empty_translations: true, # Boolean | Indicates whether keys without translations should be included in the output as well.
|
177
|
+
exclude_empty_zero_forms: true, # Boolean | Indicates whether zero forms should be included when empty in pluralized keys.
|
177
178
|
include_translated_keys: true, # Boolean | Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
|
178
179
|
keep_notranslate_tags: true, # Boolean | Indicates whether [NOTRANSLATE] tags should be kept.
|
179
180
|
convert_emoji: true, # Boolean | This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.
|
@@ -206,6 +207,7 @@ Name | Type | Description | Notes
|
|
206
207
|
**tags** | **String**| Limit results to keys tagged with a list of comma separated tag names. | [optional]
|
207
208
|
**tag** | **String**| Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead | [optional]
|
208
209
|
**include_empty_translations** | **Boolean**| Indicates whether keys without translations should be included in the output as well. | [optional]
|
210
|
+
**exclude_empty_zero_forms** | **Boolean**| Indicates whether zero forms should be included when empty in pluralized keys. | [optional]
|
209
211
|
**include_translated_keys** | **Boolean**| Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys. | [optional]
|
210
212
|
**keep_notranslate_tags** | **Boolean**| Indicates whether [NOTRANSLATE] tags should be kept. | [optional]
|
211
213
|
**convert_emoji** | **Boolean**| This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively. | [optional]
|
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
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Phrase::MemberProjectDetailProjectRoles
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**project_id** | **String** | | [optional]
|
8
|
+
**role** | **String** | | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'Phrase'
|
14
|
+
|
15
|
+
instance = Phrase::MemberProjectDetailProjectRoles.new(project_id: null,
|
16
|
+
role: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# Phrase::MemberSpaces
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**name** | **String** | | [optional]
|
9
|
+
**created_at** | [**AnyType**](.md) | | [optional]
|
10
|
+
**updated_at** | [**AnyType**](.md) | | [optional]
|
11
|
+
**projects_count** | **Integer** | | [optional]
|
12
|
+
|
13
|
+
## Code Sample
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'Phrase'
|
17
|
+
|
18
|
+
instance = Phrase::MemberSpaces.new(id: null,
|
19
|
+
name: null,
|
20
|
+
created_at: null,
|
21
|
+
updated_at: null,
|
22
|
+
projects_count: null)
|
23
|
+
```
|
24
|
+
|
25
|
+
|
@@ -7,6 +7,8 @@ Name | Type | Description | Notes
|
|
7
7
|
**role** | **String** | Member role, can be any of of Manager, Developer, Translator | [optional]
|
8
8
|
**project_ids** | **String** | List of project ids the user has access to. | [optional]
|
9
9
|
**locale_ids** | **String** | List of locale ids the user has access to. | [optional]
|
10
|
+
**default_locale_codes** | **Array<String>** | List of default locales for the user. | [optional]
|
11
|
+
**space_ids** | **Array<String>** | List of spaces the user is assigned to. | [optional]
|
10
12
|
**permissions** | **Hash<String, String>** | Additional permissions depending on member role. Available permissions are <code>create_upload</code> and <code>review_translations</code> | [optional]
|
11
13
|
|
12
14
|
## Code Sample
|
@@ -17,6 +19,8 @@ require 'Phrase'
|
|
17
19
|
instance = Phrase::MemberUpdateParameters.new(role: Developer,
|
18
20
|
project_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
|
19
21
|
locale_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
|
22
|
+
default_locale_codes: ["en","fi"],
|
23
|
+
space_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],
|
20
24
|
permissions: {"create_upload":true,"review_translations":true})
|
21
25
|
```
|
22
26
|
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Phrase::MemberUpdateSettingsParameters
|
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::MemberUpdateSettingsParameters.new(project_role: Developer,
|
16
|
+
locale_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"])
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/MembersApi.md
CHANGED
@@ -7,6 +7,7 @@ Method | HTTP request | Description
|
|
7
7
|
[**member_delete**](MembersApi.md#member_delete) | **DELETE** /accounts/{account_id}/members/{id} | Remove a user from the account
|
8
8
|
[**member_show**](MembersApi.md#member_show) | **GET** /accounts/{account_id}/members/{id} | Get single member
|
9
9
|
[**member_update**](MembersApi.md#member_update) | **PATCH** /accounts/{account_id}/members/{id} | Update a member
|
10
|
+
[**member_update_settings**](MembersApi.md#member_update_settings) | **PATCH** /projects/{project_id}/members/{id} | Update a member's project settings
|
10
11
|
[**members_list**](MembersApi.md#members_list) | **GET** /accounts/{account_id}/members | List members
|
11
12
|
|
12
13
|
|
@@ -201,6 +202,71 @@ Response<([**Member**](Member.md))>
|
|
201
202
|
- **Accept**: application/json
|
202
203
|
|
203
204
|
|
205
|
+
## member_update_settings
|
206
|
+
|
207
|
+
> MemberProjectDetail member_update_settings(project_id, id, member_update_settings_parameters, opts)
|
208
|
+
|
209
|
+
Update a member's project settings
|
210
|
+
|
211
|
+
Update user settings in the project. Access token scope must include <code>team.manage</code>.
|
212
|
+
|
213
|
+
### Example
|
214
|
+
|
215
|
+
```ruby
|
216
|
+
# load the gem
|
217
|
+
require 'phrase'
|
218
|
+
# setup authorization
|
219
|
+
Phrase.configure do |config|
|
220
|
+
# Configure HTTP basic authorization: Basic
|
221
|
+
config.username = 'YOUR USERNAME'
|
222
|
+
config.password = 'YOUR PASSWORD'
|
223
|
+
|
224
|
+
# Configure API key authorization: Token
|
225
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
226
|
+
config.api_key_prefix['Authorization'] = 'token'
|
227
|
+
end
|
228
|
+
|
229
|
+
api_instance = Phrase::MembersApi.new
|
230
|
+
project_id = 'project_id_example' # String | Project ID
|
231
|
+
id = 'id_example' # String | ID
|
232
|
+
member_update_settings_parameters = Phrase::MemberUpdateSettingsParameters.new # MemberUpdateSettingsParameters |
|
233
|
+
opts = {
|
234
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
235
|
+
}
|
236
|
+
|
237
|
+
begin
|
238
|
+
#Update a member's project settings
|
239
|
+
result = api_instance.member_update_settings(project_id, id, member_update_settings_parameters, opts)
|
240
|
+
pp result
|
241
|
+
rescue Phrase::ApiError => e
|
242
|
+
puts "Exception when calling MembersApi->member_update_settings: #{e}"
|
243
|
+
end
|
244
|
+
```
|
245
|
+
|
246
|
+
### Parameters
|
247
|
+
|
248
|
+
|
249
|
+
Name | Type | Description | Notes
|
250
|
+
------------- | ------------- | ------------- | -------------
|
251
|
+
**project_id** | **String**| Project ID |
|
252
|
+
**id** | **String**| ID |
|
253
|
+
**member_update_settings_parameters** | [**MemberUpdateSettingsParameters**](MemberUpdateSettingsParameters.md)| |
|
254
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
255
|
+
|
256
|
+
### Return type
|
257
|
+
|
258
|
+
Response<([**MemberProjectDetail**](MemberProjectDetail.md))>
|
259
|
+
|
260
|
+
### Authorization
|
261
|
+
|
262
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
263
|
+
|
264
|
+
### HTTP request headers
|
265
|
+
|
266
|
+
- **Content-Type**: application/json
|
267
|
+
- **Accept**: application/json
|
268
|
+
|
269
|
+
|
204
270
|
## members_list
|
205
271
|
|
206
272
|
> Array<Member> members_list(account_id, opts)
|