phrase 1.0.9 → 1.0.14
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 +18 -3
- 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 +3 -1
- 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/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 +9 -0
- data/lib/phrase/api/invitations_api.rb +80 -0
- 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/variables_api.rb +378 -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 +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/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/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/variables_api_spec.rb +95 -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 +6 -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 +196 -160
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: cd67540c8cf537659bbda11940913845ec29e70c5b2c5aae8ee6dc5e22f944f3
|
4
|
+
data.tar.gz: 179d29d173de9ba9aceeccb072555a6d5a1e504325cefd337a90e2effaf9fc3c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c3c7e5b46629caf876d3958f14b74876910fa80ae5a6f63ea38c0803db05fb62fc2881adb8697ecce6ff585740d47cd3f16d6ce6466987f2cfec6c4637926c3e
|
7
|
+
data.tar.gz: b6d99d11907dc532ff3691c0323e3d462245db0e36e8c0953873dee741bbd15bf2735d579bd270f6bcb72d2ec09c9ce8882291fffe7bbc05c1cf2c5ac5564a8a
|
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.14
|
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.14.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.14.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
|
@@ -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
|
@@ -282,6 +284,11 @@ Class | Method | HTTP request | Description
|
|
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
|
@@ -347,6 +354,7 @@ Class | Method | HTTP request | Description
|
|
347
354
|
- [Phrase::Invitation](docs/Invitation.md)
|
348
355
|
- [Phrase::InvitationCreateParameters](docs/InvitationCreateParameters.md)
|
349
356
|
- [Phrase::InvitationUpdateParameters](docs/InvitationUpdateParameters.md)
|
357
|
+
- [Phrase::InvitationUpdateSettingsParameters](docs/InvitationUpdateSettingsParameters.md)
|
350
358
|
- [Phrase::Job](docs/Job.md)
|
351
359
|
- [Phrase::JobCompleteParameters](docs/JobCompleteParameters.md)
|
352
360
|
- [Phrase::JobCreateParameters](docs/JobCreateParameters.md)
|
@@ -376,7 +384,11 @@ Class | Method | HTTP request | Description
|
|
376
384
|
- [Phrase::LocaleStatistics](docs/LocaleStatistics.md)
|
377
385
|
- [Phrase::LocaleUpdateParameters](docs/LocaleUpdateParameters.md)
|
378
386
|
- [Phrase::Member](docs/Member.md)
|
387
|
+
- [Phrase::MemberProjectDetail](docs/MemberProjectDetail.md)
|
388
|
+
- [Phrase::MemberProjectDetailProjectRoles](docs/MemberProjectDetailProjectRoles.md)
|
389
|
+
- [Phrase::MemberSpaces](docs/MemberSpaces.md)
|
379
390
|
- [Phrase::MemberUpdateParameters](docs/MemberUpdateParameters.md)
|
391
|
+
- [Phrase::MemberUpdateSettingsParameters](docs/MemberUpdateSettingsParameters.md)
|
380
392
|
- [Phrase::OrderConfirmParameters](docs/OrderConfirmParameters.md)
|
381
393
|
- [Phrase::OrderCreateParameters](docs/OrderCreateParameters.md)
|
382
394
|
- [Phrase::Project](docs/Project.md)
|
@@ -448,6 +460,9 @@ Class | Method | HTTP request | Description
|
|
448
460
|
- [Phrase::UploadSummary](docs/UploadSummary.md)
|
449
461
|
- [Phrase::User](docs/User.md)
|
450
462
|
- [Phrase::UserPreview](docs/UserPreview.md)
|
463
|
+
- [Phrase::Variable](docs/Variable.md)
|
464
|
+
- [Phrase::VariableCreateParameters](docs/VariableCreateParameters.md)
|
465
|
+
- [Phrase::VariableUpdateParameters](docs/VariableUpdateParameters.md)
|
451
466
|
- [Phrase::Webhook](docs/Webhook.md)
|
452
467
|
- [Phrase::WebhookCreateParameters](docs/WebhookCreateParameters.md)
|
453
468
|
- [Phrase::WebhookUpdateParameters](docs/WebhookUpdateParameters.md)
|
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
@@ -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/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)
|