phrase 1.0.7 → 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.
Files changed (111) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +26 -9
  3. data/docs/BranchName.md +17 -0
  4. data/docs/CurrentUser.md +31 -0
  5. data/docs/Invitation.md +9 -1
  6. data/docs/InvitationCreateParameters.md +4 -0
  7. data/docs/InvitationUpdateParameters.md +4 -0
  8. data/docs/InvitationUpdateSettingsParameters.md +19 -0
  9. data/docs/InvitationsApi.md +66 -0
  10. data/docs/Job.md +5 -3
  11. data/docs/JobDetails.md +4 -2
  12. data/docs/JobLocale.md +7 -1
  13. data/docs/KeysApi.md +5 -5
  14. data/docs/LocalesApi.md +7 -4
  15. data/docs/Member.md +7 -1
  16. data/docs/MemberProjectDetail.md +35 -0
  17. data/docs/MemberProjectDetailProjectRoles.md +19 -0
  18. data/docs/MemberSpaces.md +25 -0
  19. data/docs/MemberUpdateParameters.md +4 -0
  20. data/docs/MemberUpdateSettingsParameters.md +19 -0
  21. data/docs/MembersApi.md +66 -0
  22. data/docs/ProjectUpdateParameters.md +43 -9
  23. data/docs/ScreenshotCreateParameters.md +3 -1
  24. data/docs/ScreenshotMarkerCreateParameters.md +3 -1
  25. data/docs/ScreenshotMarkerUpdateParameters.md +3 -1
  26. data/docs/ScreenshotMarkersApi.md +9 -3
  27. data/docs/ScreenshotUpdateParameters.md +3 -1
  28. data/docs/ScreenshotsApi.md +8 -2
  29. data/docs/TranslationsApi.md +25 -25
  30. data/docs/UsersApi.md +2 -2
  31. data/docs/Variable.md +23 -0
  32. data/docs/VariableCreateParameters.md +19 -0
  33. data/docs/VariableUpdateParameters.md +19 -0
  34. data/docs/VariablesApi.md +331 -0
  35. data/docs/Webhook.md +2 -0
  36. data/docs/WebhookCreateParameters.md +3 -1
  37. data/docs/WebhookUpdateParameters.md +3 -1
  38. data/lib/phrase.rb +11 -0
  39. data/lib/phrase/api/invitations_api.rb +80 -0
  40. data/lib/phrase/api/keys_api.rb +6 -6
  41. data/lib/phrase/api/locales_api.rb +8 -3
  42. data/lib/phrase/api/members_api.rb +80 -0
  43. data/lib/phrase/api/screenshot_markers_api.rb +9 -0
  44. data/lib/phrase/api/screenshots_api.rb +9 -0
  45. data/lib/phrase/api/translations_api.rb +35 -35
  46. data/lib/phrase/api/users_api.rb +3 -3
  47. data/lib/phrase/api/variables_api.rb +378 -0
  48. data/lib/phrase/api_client.rb +2 -0
  49. data/lib/phrase/models/branch_name.rb +194 -0
  50. data/lib/phrase/models/current_user.rb +257 -0
  51. data/lib/phrase/models/invitation.rb +48 -4
  52. data/lib/phrase/models/invitation_create_parameters.rb +25 -1
  53. data/lib/phrase/models/invitation_update_parameters.rb +25 -1
  54. data/lib/phrase/models/invitation_update_settings_parameters.rb +207 -0
  55. data/lib/phrase/models/job.rb +22 -13
  56. data/lib/phrase/models/job_details.rb +19 -10
  57. data/lib/phrase/models/job_locale.rb +31 -4
  58. data/lib/phrase/models/member.rb +35 -4
  59. data/lib/phrase/models/member_project_detail.rb +285 -0
  60. data/lib/phrase/models/member_project_detail_project_roles.rb +203 -0
  61. data/lib/phrase/models/member_spaces.rb +230 -0
  62. data/lib/phrase/models/member_update_parameters.rb +25 -1
  63. data/lib/phrase/models/member_update_settings_parameters.rb +207 -0
  64. data/lib/phrase/models/project_update_parameters.rb +183 -13
  65. data/lib/phrase/models/screenshot_create_parameters.rb +11 -1
  66. data/lib/phrase/models/screenshot_marker_create_parameters.rb +11 -1
  67. data/lib/phrase/models/screenshot_marker_update_parameters.rb +11 -1
  68. data/lib/phrase/models/screenshot_update_parameters.rb +11 -1
  69. data/lib/phrase/models/variable.rb +221 -0
  70. data/lib/phrase/models/variable_create_parameters.rb +205 -0
  71. data/lib/phrase/models/variable_update_parameters.rb +205 -0
  72. data/lib/phrase/models/webhook.rb +10 -1
  73. data/lib/phrase/models/webhook_create_parameters.rb +14 -4
  74. data/lib/phrase/models/webhook_update_parameters.rb +14 -4
  75. data/lib/phrase/version.rb +1 -1
  76. data/spec/api/invitations_api_spec.rb +15 -0
  77. data/spec/api/keys_api_spec.rb +2 -2
  78. data/spec/api/locales_api_spec.rb +2 -1
  79. data/spec/api/members_api_spec.rb +15 -0
  80. data/spec/api/screenshot_markers_api_spec.rb +3 -0
  81. data/spec/api/screenshots_api_spec.rb +3 -0
  82. data/spec/api/translations_api_spec.rb +10 -10
  83. data/spec/api/users_api_spec.rb +1 -1
  84. data/spec/api/variables_api_spec.rb +95 -0
  85. data/spec/models/branch_name_spec.rb +29 -0
  86. data/spec/models/current_user_spec.rb +71 -0
  87. data/spec/models/invitation_create_parameters_spec.rb +12 -0
  88. data/spec/models/invitation_spec.rb +24 -0
  89. data/spec/models/invitation_update_parameters_spec.rb +12 -0
  90. data/spec/models/invitation_update_settings_parameters_spec.rb +35 -0
  91. data/spec/models/job_details_spec.rb +9 -3
  92. data/spec/models/job_locale_spec.rb +18 -0
  93. data/spec/models/job_spec.rb +9 -3
  94. data/spec/models/member_project_detail_project_roles_spec.rb +35 -0
  95. data/spec/models/member_project_detail_spec.rb +83 -0
  96. data/spec/models/member_spaces_spec.rb +53 -0
  97. data/spec/models/member_spec.rb +18 -0
  98. data/spec/models/member_update_parameters_spec.rb +12 -0
  99. data/spec/models/member_update_settings_parameters_spec.rb +35 -0
  100. data/spec/models/project_update_parameters_spec.rb +103 -1
  101. data/spec/models/screenshot_create_parameters_spec.rb +6 -0
  102. data/spec/models/screenshot_marker_create_parameters_spec.rb +6 -0
  103. data/spec/models/screenshot_marker_update_parameters_spec.rb +6 -0
  104. data/spec/models/screenshot_update_parameters_spec.rb +6 -0
  105. data/spec/models/variable_create_parameters_spec.rb +35 -0
  106. data/spec/models/variable_spec.rb +47 -0
  107. data/spec/models/variable_update_parameters_spec.rb +35 -0
  108. data/spec/models/webhook_create_parameters_spec.rb +6 -0
  109. data/spec/models/webhook_spec.rb +6 -0
  110. data/spec/models/webhook_update_parameters_spec.rb +6 -0
  111. metadata +206 -162
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 363818b3fafb57ee99cac2370eaad0ab61a2e1e287092aec2536b48037a7b724
4
- data.tar.gz: b856a73bc10eae5eb9f37aaff1cf4edb96d12d599e2230d3dc2a015e84259c94
3
+ metadata.gz: 1e59f0b86fbb8c281e8c41892c24797cb0e74c6491c6226003fe6e93a0d2d2e5
4
+ data.tar.gz: 5ccd88c3044eb45af04bb35cef1cf4baf151900a1c223a38891dc8bd96bb5df1
5
5
  SHA512:
6
- metadata.gz: ee376ffad0648c64a9f4eec806331afbaf9a65eaaf1577a9fc5192b93abdfcf85fff077a299c942902b983b84b70b2f46102fb27dd1fd499009dc8585dcec1b9
7
- data.tar.gz: e9fd4bc297f45da44232563a52bc812771e58ee9fafcb0893f79ca80a9d7df0544025b4914e7b27e6413035612d2fa16a8f79eb3c2417ae2881968388129a0fd
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: 1.0.7
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-1.0.7.gem
59
+ gem install ./phrase-2.0.0.gem
60
60
  ```
61
61
 
62
- (for development, run `gem install --dev ./phrase-1.0.7.gem` to install the development dependencies)
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* | [**keys_delete**](docs/KeysApi.md#keys_delete) | **DELETE** /projects/{project_id}/keys | Delete collection of keys
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* | [**translations_exclude**](docs/TranslationsApi.md#translations_exclude) | **PATCH** /projects/{project_id}/translations/exclude | Set exclude from export flag on translations selected by query
275
- *Phrase::TranslationsApi* | [**translations_include**](docs/TranslationsApi.md#translations_include) | **PATCH** /projects/{project_id}/translations/include | Remove exlude from import flag from translations selected by query
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* | [**translations_review**](docs/TranslationsApi.md#translations_review) | **PATCH** /projects/{project_id}/translations/review | Review translations selected by query
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* | [**translations_unverify**](docs/TranslationsApi.md#translations_unverify) | **PATCH** /projects/{project_id}/translations/unverify | Mark translations selected by query as unverified
280
- *Phrase::TranslationsApi* | [**translations_verify**](docs/TranslationsApi.md#translations_verify) | **PATCH** /projects/{project_id}/translations/verify | Verify translations selected by query
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
@@ -314,11 +321,13 @@ Class | Method | HTTP request | Description
314
321
  - [Phrase::Branch](docs/Branch.md)
315
322
  - [Phrase::BranchCreateParameters](docs/BranchCreateParameters.md)
316
323
  - [Phrase::BranchMergeParameters](docs/BranchMergeParameters.md)
324
+ - [Phrase::BranchName](docs/BranchName.md)
317
325
  - [Phrase::BranchUpdateParameters](docs/BranchUpdateParameters.md)
318
326
  - [Phrase::Comment](docs/Comment.md)
319
327
  - [Phrase::CommentCreateParameters](docs/CommentCreateParameters.md)
320
328
  - [Phrase::CommentMarkReadParameters](docs/CommentMarkReadParameters.md)
321
329
  - [Phrase::CommentUpdateParameters](docs/CommentUpdateParameters.md)
330
+ - [Phrase::CurrentUser](docs/CurrentUser.md)
322
331
  - [Phrase::Distribution](docs/Distribution.md)
323
332
  - [Phrase::DistributionCreateParameters](docs/DistributionCreateParameters.md)
324
333
  - [Phrase::DistributionPreview](docs/DistributionPreview.md)
@@ -346,6 +355,7 @@ Class | Method | HTTP request | Description
346
355
  - [Phrase::Invitation](docs/Invitation.md)
347
356
  - [Phrase::InvitationCreateParameters](docs/InvitationCreateParameters.md)
348
357
  - [Phrase::InvitationUpdateParameters](docs/InvitationUpdateParameters.md)
358
+ - [Phrase::InvitationUpdateSettingsParameters](docs/InvitationUpdateSettingsParameters.md)
349
359
  - [Phrase::Job](docs/Job.md)
350
360
  - [Phrase::JobCompleteParameters](docs/JobCompleteParameters.md)
351
361
  - [Phrase::JobCreateParameters](docs/JobCreateParameters.md)
@@ -375,7 +385,11 @@ Class | Method | HTTP request | Description
375
385
  - [Phrase::LocaleStatistics](docs/LocaleStatistics.md)
376
386
  - [Phrase::LocaleUpdateParameters](docs/LocaleUpdateParameters.md)
377
387
  - [Phrase::Member](docs/Member.md)
388
+ - [Phrase::MemberProjectDetail](docs/MemberProjectDetail.md)
389
+ - [Phrase::MemberProjectDetailProjectRoles](docs/MemberProjectDetailProjectRoles.md)
390
+ - [Phrase::MemberSpaces](docs/MemberSpaces.md)
378
391
  - [Phrase::MemberUpdateParameters](docs/MemberUpdateParameters.md)
392
+ - [Phrase::MemberUpdateSettingsParameters](docs/MemberUpdateSettingsParameters.md)
379
393
  - [Phrase::OrderConfirmParameters](docs/OrderConfirmParameters.md)
380
394
  - [Phrase::OrderCreateParameters](docs/OrderCreateParameters.md)
381
395
  - [Phrase::Project](docs/Project.md)
@@ -447,6 +461,9 @@ Class | Method | HTTP request | Description
447
461
  - [Phrase::UploadSummary](docs/UploadSummary.md)
448
462
  - [Phrase::User](docs/User.md)
449
463
  - [Phrase::UserPreview](docs/UserPreview.md)
464
+ - [Phrase::Variable](docs/Variable.md)
465
+ - [Phrase::VariableCreateParameters](docs/VariableCreateParameters.md)
466
+ - [Phrase::VariableUpdateParameters](docs/VariableUpdateParameters.md)
450
467
  - [Phrase::Webhook](docs/Webhook.md)
451
468
  - [Phrase::WebhookCreateParameters](docs/WebhookCreateParameters.md)
452
469
  - [Phrase::WebhookUpdateParameters](docs/WebhookUpdateParameters.md)
@@ -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
+
@@ -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
+
@@ -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&lt;Invitation&gt; invitations_list(account_id, opts)
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&lt;LocalePreview&gt;**](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,9 @@ Name | Type | Description | Notes
8
8
  **job** | [**JobPreview**](JobPreview.md) | | [optional]
9
9
  **locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
10
10
  **users** | [**Array&lt;UserPreview&gt;**](UserPreview.md) | | [optional]
11
+ **completed** | **Boolean** | | [optional]
12
+ **translation_completed_at** | **DateTime** | | [optional]
13
+ **review_completed_at** | **DateTime** | | [optional]
11
14
 
12
15
  ## Code Sample
13
16
 
@@ -17,7 +20,10 @@ require 'Phrase'
17
20
  instance = Phrase::JobLocale.new(id: null,
18
21
  job: null,
19
22
  locale: null,
20
- users: null)
23
+ users: null,
24
+ completed: null,
25
+ translation_completed_at: null,
26
+ review_completed_at: null)
21
27
  ```
22
28
 
23
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
- [**keys_delete**](KeysApi.md#keys_delete) | **DELETE** /projects/{project_id}/keys | Delete collection of keys
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
- ## keys_delete
276
+ ## keys_delete_collection
277
277
 
278
- > AffectedResources keys_delete(project_id, opts)
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.keys_delete(project_id, opts)
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->keys_delete: #{e}"
314
+ puts "Exception when calling KeysApi->keys_delete_collection: #{e}"
315
315
  end
316
316
  ```
317
317