phrase 1.0.1 → 1.0.2
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 +50 -387
- data/docs/AccountsApi.md +2 -4
- data/docs/AuthorizationsApi.md +10 -14
- data/docs/BitbucketSyncApi.md +3 -6
- data/docs/BlacklistedKeysApi.md +10 -14
- data/docs/BranchesApi.md +12 -18
- data/docs/CommentsApi.md +13 -20
- data/docs/DistributionsApi.md +10 -14
- data/docs/FormatsApi.md +1 -2
- data/docs/GitLabSyncApi.md +7 -14
- data/docs/{GlossaryApi.md → GlossariesApi.md} +26 -30
- data/docs/GlossaryTermTranslationsApi.md +8 -10
- data/docs/GlossaryTermsApi.md +10 -14
- data/docs/InvitationsApi.md +11 -16
- data/docs/JobLocalesApi.md +12 -18
- data/docs/JobsApi.md +15 -24
- data/docs/KeysApi.md +18 -26
- data/docs/KeysSearchParameters.md +1 -1
- data/docs/KeysTagParameters.md +1 -1
- data/docs/KeysUntagParameters.md +1 -1
- data/docs/LocalesApi.md +13 -18
- data/docs/MembersApi.md +4 -8
- data/docs/OrdersApi.md +10 -14
- data/docs/ProjectCreateParameters.md +3 -1
- data/docs/ProjectsApi.md +10 -14
- data/docs/ReleasesApi.md +11 -16
- data/docs/ScreenshotMarkersApi.md +10 -14
- data/docs/ScreenshotsApi.md +10 -14
- data/docs/SpacesApi.md +13 -20
- data/docs/StyleGuidesApi.md +10 -14
- data/docs/TagsApi.md +9 -12
- data/docs/Team.md +29 -0
- data/docs/TeamCreateParameters.md +17 -0
- data/docs/TeamDetail.md +29 -0
- data/docs/TeamUpdateParameters.md +17 -0
- data/docs/TeamsApi.md +721 -0
- data/docs/TeamsProjectsCreateParameters.md +17 -0
- data/docs/TeamsSpacesCreateParameters.md +17 -0
- data/docs/TeamsUsersCreateParameters.md +17 -0
- data/docs/TranslationsApi.md +28 -44
- data/docs/TranslationsExcludeParameters.md +1 -1
- data/docs/TranslationsIncludeParameters.md +1 -1
- data/docs/TranslationsReviewParameters.md +1 -1
- data/docs/TranslationsSearchParameters.md +1 -1
- data/docs/TranslationsUnverifyParameters.md +1 -1
- data/docs/TranslationsVerifyParameters.md +1 -1
- data/docs/UploadCreateParameters.md +2 -2
- data/docs/UploadsApi.md +12 -10
- data/docs/UsersApi.md +1 -2
- data/docs/VersionsHistoryApi.md +2 -4
- data/docs/WebhooksApi.md +11 -16
- data/git_push.sh +2 -2
- data/lib/phrase.rb +9 -1
- data/lib/phrase/api/authorizations_api.rb +10 -8
- data/lib/phrase/api/bitbucket_sync_api.rb +3 -3
- data/lib/phrase/api/blacklisted_keys_api.rb +10 -8
- data/lib/phrase/api/branches_api.rb +16 -14
- data/lib/phrase/api/comments_api.rb +19 -17
- data/lib/phrase/api/distributions_api.rb +10 -8
- data/lib/phrase/api/git_lab_sync_api.rb +3 -3
- data/lib/phrase/api/{glossary_api.rb → glossaries_api.rb} +31 -29
- data/lib/phrase/api/glossary_term_translations_api.rb +10 -8
- data/lib/phrase/api/glossary_terms_api.rb +10 -8
- data/lib/phrase/api/invitations_api.rb +10 -8
- data/lib/phrase/api/job_locales_api.rb +10 -8
- data/lib/phrase/api/jobs_api.rb +13 -11
- data/lib/phrase/api/keys_api.rb +14 -12
- data/lib/phrase/api/locales_api.rb +15 -13
- data/lib/phrase/api/members_api.rb +3 -3
- data/lib/phrase/api/orders_api.rb +10 -8
- data/lib/phrase/api/projects_api.rb +10 -8
- data/lib/phrase/api/releases_api.rb +10 -8
- data/lib/phrase/api/screenshot_markers_api.rb +10 -8
- data/lib/phrase/api/screenshots_api.rb +10 -8
- data/lib/phrase/api/spaces_api.rb +16 -14
- data/lib/phrase/api/style_guides_api.rb +10 -8
- data/lib/phrase/api/tags_api.rb +10 -8
- data/lib/phrase/api/teams_api.rb +840 -0
- data/lib/phrase/api/translations_api.rb +13 -11
- data/lib/phrase/api/uploads_api.rb +13 -5
- data/lib/phrase/api/webhooks_api.rb +13 -11
- data/lib/phrase/models/keys_search_parameters.rb +1 -1
- data/lib/phrase/models/keys_tag_parameters.rb +1 -1
- data/lib/phrase/models/keys_untag_parameters.rb +1 -1
- data/lib/phrase/models/project_create_parameters.rb +14 -4
- data/lib/phrase/models/team.rb +254 -0
- data/lib/phrase/models/team_create_parameters.rb +195 -0
- data/lib/phrase/models/team_detail.rb +254 -0
- data/lib/phrase/models/team_update_parameters.rb +195 -0
- data/lib/phrase/models/teams_projects_create_parameters.rb +195 -0
- data/lib/phrase/models/teams_spaces_create_parameters.rb +195 -0
- data/lib/phrase/models/teams_users_create_parameters.rb +195 -0
- data/lib/phrase/models/translations_exclude_parameters.rb +1 -1
- data/lib/phrase/models/translations_include_parameters.rb +1 -1
- data/lib/phrase/models/translations_review_parameters.rb +1 -1
- data/lib/phrase/models/translations_search_parameters.rb +1 -1
- data/lib/phrase/models/translations_unverify_parameters.rb +1 -1
- data/lib/phrase/models/translations_verify_parameters.rb +1 -1
- data/lib/phrase/models/upload_create_parameters.rb +4 -8
- data/lib/phrase/version.rb +1 -1
- data/spec/api/authorizations_api_spec.rb +1 -1
- data/spec/api/blacklisted_keys_api_spec.rb +1 -1
- data/spec/api/branches_api_spec.rb +1 -1
- data/spec/api/comments_api_spec.rb +1 -1
- data/spec/api/distributions_api_spec.rb +1 -1
- data/spec/api/{glossary_api_spec.rb → glossaries_api_spec.rb} +7 -7
- data/spec/api/glossary_term_translations_api_spec.rb +1 -1
- data/spec/api/glossary_terms_api_spec.rb +1 -1
- data/spec/api/invitations_api_spec.rb +1 -1
- data/spec/api/job_locales_api_spec.rb +1 -1
- data/spec/api/jobs_api_spec.rb +1 -1
- data/spec/api/keys_api_spec.rb +3 -3
- data/spec/api/locales_api_spec.rb +2 -2
- data/spec/api/orders_api_spec.rb +1 -1
- data/spec/api/projects_api_spec.rb +1 -1
- data/spec/api/releases_api_spec.rb +1 -1
- data/spec/api/screenshot_markers_api_spec.rb +1 -1
- data/spec/api/screenshots_api_spec.rb +1 -1
- data/spec/api/spaces_api_spec.rb +1 -1
- data/spec/api/style_guides_api_spec.rb +1 -1
- data/spec/api/tags_api_spec.rb +1 -1
- data/spec/api/teams_api_spec.rb +185 -0
- data/spec/api/translations_api_spec.rb +4 -4
- data/spec/api/uploads_api_spec.rb +3 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/models/project_create_parameters_spec.rb +6 -0
- data/spec/models/team_create_parameters_spec.rb +29 -0
- data/spec/models/team_detail_spec.rb +65 -0
- data/spec/models/team_spec.rb +65 -0
- data/spec/models/team_update_parameters_spec.rb +29 -0
- data/spec/models/teams_projects_create_parameters_spec.rb +29 -0
- data/spec/models/teams_spaces_create_parameters_spec.rb +29 -0
- data/spec/models/teams_users_create_parameters_spec.rb +29 -0
- metadata +183 -151
data/docs/SpacesApi.md
CHANGED
|
@@ -17,7 +17,7 @@ Method | HTTP request | Description
|
|
|
17
17
|
|
|
18
18
|
## space_create
|
|
19
19
|
|
|
20
|
-
> space_create(account_id, space_create_parameters, opts)
|
|
20
|
+
> Space space_create(account_id, space_create_parameters, opts)
|
|
21
21
|
|
|
22
22
|
Create a Space
|
|
23
23
|
|
|
@@ -36,8 +36,7 @@ Phrase.configure do |config|
|
|
|
36
36
|
|
|
37
37
|
# Configure API key authorization: Token
|
|
38
38
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
39
|
-
|
|
40
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
39
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
41
40
|
end
|
|
42
41
|
|
|
43
42
|
api_instance = Phrase::SpacesApi.new
|
|
@@ -49,7 +48,8 @@ opts = {
|
|
|
49
48
|
|
|
50
49
|
begin
|
|
51
50
|
#Create a Space
|
|
52
|
-
api_instance.space_create(account_id, space_create_parameters, opts)
|
|
51
|
+
result = api_instance.space_create(account_id, space_create_parameters, opts)
|
|
52
|
+
pp result
|
|
53
53
|
rescue Phrase::ApiError => e
|
|
54
54
|
puts "Exception when calling SpacesApi->space_create: #{e}"
|
|
55
55
|
end
|
|
@@ -66,7 +66,7 @@ Name | Type | Description | Notes
|
|
|
66
66
|
|
|
67
67
|
### Return type
|
|
68
68
|
|
|
69
|
-
Response<(
|
|
69
|
+
Response<([**Space**](Space.md))>
|
|
70
70
|
|
|
71
71
|
### Authorization
|
|
72
72
|
|
|
@@ -75,7 +75,7 @@ Response<(nil (empty response body))>
|
|
|
75
75
|
### HTTP request headers
|
|
76
76
|
|
|
77
77
|
- **Content-Type**: application/json
|
|
78
|
-
- **Accept**:
|
|
78
|
+
- **Accept**: application/json
|
|
79
79
|
|
|
80
80
|
|
|
81
81
|
## space_delete
|
|
@@ -99,8 +99,7 @@ Phrase.configure do |config|
|
|
|
99
99
|
|
|
100
100
|
# Configure API key authorization: Token
|
|
101
101
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
102
|
-
|
|
103
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
102
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
104
103
|
end
|
|
105
104
|
|
|
106
105
|
api_instance = Phrase::SpacesApi.new
|
|
@@ -162,8 +161,7 @@ Phrase.configure do |config|
|
|
|
162
161
|
|
|
163
162
|
# Configure API key authorization: Token
|
|
164
163
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
165
|
-
|
|
166
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
164
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
167
165
|
end
|
|
168
166
|
|
|
169
167
|
api_instance = Phrase::SpacesApi.new
|
|
@@ -226,8 +224,7 @@ Phrase.configure do |config|
|
|
|
226
224
|
|
|
227
225
|
# Configure API key authorization: Token
|
|
228
226
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
229
|
-
|
|
230
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
227
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
231
228
|
end
|
|
232
229
|
|
|
233
230
|
api_instance = Phrase::SpacesApi.new
|
|
@@ -292,8 +289,7 @@ Phrase.configure do |config|
|
|
|
292
289
|
|
|
293
290
|
# Configure API key authorization: Token
|
|
294
291
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
295
|
-
|
|
296
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
292
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
297
293
|
end
|
|
298
294
|
|
|
299
295
|
api_instance = Phrase::SpacesApi.new
|
|
@@ -358,8 +354,7 @@ Phrase.configure do |config|
|
|
|
358
354
|
|
|
359
355
|
# Configure API key authorization: Token
|
|
360
356
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
361
|
-
|
|
362
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
357
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
363
358
|
end
|
|
364
359
|
|
|
365
360
|
api_instance = Phrase::SpacesApi.new
|
|
@@ -423,8 +418,7 @@ Phrase.configure do |config|
|
|
|
423
418
|
|
|
424
419
|
# Configure API key authorization: Token
|
|
425
420
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
426
|
-
|
|
427
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
421
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
428
422
|
end
|
|
429
423
|
|
|
430
424
|
api_instance = Phrase::SpacesApi.new
|
|
@@ -488,8 +482,7 @@ Phrase.configure do |config|
|
|
|
488
482
|
|
|
489
483
|
# Configure API key authorization: Token
|
|
490
484
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
491
|
-
|
|
492
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
485
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
493
486
|
end
|
|
494
487
|
|
|
495
488
|
api_instance = Phrase::SpacesApi.new
|
data/docs/StyleGuidesApi.md
CHANGED
|
@@ -14,7 +14,7 @@ Method | HTTP request | Description
|
|
|
14
14
|
|
|
15
15
|
## styleguide_create
|
|
16
16
|
|
|
17
|
-
> styleguide_create(project_id, styleguide_create_parameters, opts)
|
|
17
|
+
> StyleguideDetails styleguide_create(project_id, styleguide_create_parameters, opts)
|
|
18
18
|
|
|
19
19
|
Create a style guide
|
|
20
20
|
|
|
@@ -33,8 +33,7 @@ Phrase.configure do |config|
|
|
|
33
33
|
|
|
34
34
|
# Configure API key authorization: Token
|
|
35
35
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
36
|
-
|
|
37
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
36
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
38
37
|
end
|
|
39
38
|
|
|
40
39
|
api_instance = Phrase::StyleGuidesApi.new
|
|
@@ -46,7 +45,8 @@ opts = {
|
|
|
46
45
|
|
|
47
46
|
begin
|
|
48
47
|
#Create a style guide
|
|
49
|
-
api_instance.styleguide_create(project_id, styleguide_create_parameters, opts)
|
|
48
|
+
result = api_instance.styleguide_create(project_id, styleguide_create_parameters, opts)
|
|
49
|
+
pp result
|
|
50
50
|
rescue Phrase::ApiError => e
|
|
51
51
|
puts "Exception when calling StyleGuidesApi->styleguide_create: #{e}"
|
|
52
52
|
end
|
|
@@ -63,7 +63,7 @@ Name | Type | Description | Notes
|
|
|
63
63
|
|
|
64
64
|
### Return type
|
|
65
65
|
|
|
66
|
-
Response<(
|
|
66
|
+
Response<([**StyleguideDetails**](StyleguideDetails.md))>
|
|
67
67
|
|
|
68
68
|
### Authorization
|
|
69
69
|
|
|
@@ -72,7 +72,7 @@ Response<(nil (empty response body))>
|
|
|
72
72
|
### HTTP request headers
|
|
73
73
|
|
|
74
74
|
- **Content-Type**: application/json
|
|
75
|
-
- **Accept**:
|
|
75
|
+
- **Accept**: application/json
|
|
76
76
|
|
|
77
77
|
|
|
78
78
|
## styleguide_delete
|
|
@@ -96,8 +96,7 @@ Phrase.configure do |config|
|
|
|
96
96
|
|
|
97
97
|
# Configure API key authorization: Token
|
|
98
98
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
99
|
-
|
|
100
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
99
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
101
100
|
end
|
|
102
101
|
|
|
103
102
|
api_instance = Phrase::StyleGuidesApi.new
|
|
@@ -159,8 +158,7 @@ Phrase.configure do |config|
|
|
|
159
158
|
|
|
160
159
|
# Configure API key authorization: Token
|
|
161
160
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
162
|
-
|
|
163
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
161
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
164
162
|
end
|
|
165
163
|
|
|
166
164
|
api_instance = Phrase::StyleGuidesApi.new
|
|
@@ -223,8 +221,7 @@ Phrase.configure do |config|
|
|
|
223
221
|
|
|
224
222
|
# Configure API key authorization: Token
|
|
225
223
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
226
|
-
|
|
227
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
224
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
228
225
|
end
|
|
229
226
|
|
|
230
227
|
api_instance = Phrase::StyleGuidesApi.new
|
|
@@ -289,8 +286,7 @@ Phrase.configure do |config|
|
|
|
289
286
|
|
|
290
287
|
# Configure API key authorization: Token
|
|
291
288
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
292
|
-
|
|
293
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
289
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
294
290
|
end
|
|
295
291
|
|
|
296
292
|
api_instance = Phrase::StyleGuidesApi.new
|
data/docs/TagsApi.md
CHANGED
|
@@ -13,7 +13,7 @@ Method | HTTP request | Description
|
|
|
13
13
|
|
|
14
14
|
## tag_create
|
|
15
15
|
|
|
16
|
-
> tag_create(project_id, tag_create_parameters, opts)
|
|
16
|
+
> TagWithStats tag_create(project_id, tag_create_parameters, opts)
|
|
17
17
|
|
|
18
18
|
Create a tag
|
|
19
19
|
|
|
@@ -32,8 +32,7 @@ Phrase.configure do |config|
|
|
|
32
32
|
|
|
33
33
|
# Configure API key authorization: Token
|
|
34
34
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
35
|
-
|
|
36
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
35
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
37
36
|
end
|
|
38
37
|
|
|
39
38
|
api_instance = Phrase::TagsApi.new
|
|
@@ -45,7 +44,8 @@ opts = {
|
|
|
45
44
|
|
|
46
45
|
begin
|
|
47
46
|
#Create a tag
|
|
48
|
-
api_instance.tag_create(project_id, tag_create_parameters, opts)
|
|
47
|
+
result = api_instance.tag_create(project_id, tag_create_parameters, opts)
|
|
48
|
+
pp result
|
|
49
49
|
rescue Phrase::ApiError => e
|
|
50
50
|
puts "Exception when calling TagsApi->tag_create: #{e}"
|
|
51
51
|
end
|
|
@@ -62,7 +62,7 @@ Name | Type | Description | Notes
|
|
|
62
62
|
|
|
63
63
|
### Return type
|
|
64
64
|
|
|
65
|
-
Response<(
|
|
65
|
+
Response<([**TagWithStats**](TagWithStats.md))>
|
|
66
66
|
|
|
67
67
|
### Authorization
|
|
68
68
|
|
|
@@ -71,7 +71,7 @@ Response<(nil (empty response body))>
|
|
|
71
71
|
### HTTP request headers
|
|
72
72
|
|
|
73
73
|
- **Content-Type**: application/json
|
|
74
|
-
- **Accept**:
|
|
74
|
+
- **Accept**: application/json
|
|
75
75
|
|
|
76
76
|
|
|
77
77
|
## tag_delete
|
|
@@ -95,8 +95,7 @@ Phrase.configure do |config|
|
|
|
95
95
|
|
|
96
96
|
# Configure API key authorization: Token
|
|
97
97
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
98
|
-
|
|
99
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
98
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
100
99
|
end
|
|
101
100
|
|
|
102
101
|
api_instance = Phrase::TagsApi.new
|
|
@@ -160,8 +159,7 @@ Phrase.configure do |config|
|
|
|
160
159
|
|
|
161
160
|
# Configure API key authorization: Token
|
|
162
161
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
163
|
-
|
|
164
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
162
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
165
163
|
end
|
|
166
164
|
|
|
167
165
|
api_instance = Phrase::TagsApi.new
|
|
@@ -226,8 +224,7 @@ Phrase.configure do |config|
|
|
|
226
224
|
|
|
227
225
|
# Configure API key authorization: Token
|
|
228
226
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
229
|
-
|
|
230
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
227
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
231
228
|
end
|
|
232
229
|
|
|
233
230
|
api_instance = Phrase::TagsApi.new
|
data/docs/Team.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Phrase::Team
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **String** | | [optional]
|
|
8
|
+
**name** | **String** | | [optional]
|
|
9
|
+
**created_at** | **DateTime** | | [optional]
|
|
10
|
+
**updated_at** | **DateTime** | | [optional]
|
|
11
|
+
**projects** | [**Array<Project>**](Project.md) | | [optional]
|
|
12
|
+
**spaces** | [**Array<Space>**](Space.md) | | [optional]
|
|
13
|
+
**users** | [**Array<UserPreview>**](UserPreview.md) | | [optional]
|
|
14
|
+
|
|
15
|
+
## Code Sample
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'Phrase'
|
|
19
|
+
|
|
20
|
+
instance = Phrase::Team.new(id: null,
|
|
21
|
+
name: null,
|
|
22
|
+
created_at: null,
|
|
23
|
+
updated_at: null,
|
|
24
|
+
projects: null,
|
|
25
|
+
spaces: null,
|
|
26
|
+
users: null)
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Phrase::TeamCreateParameters
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | Name of the team | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'Phrase'
|
|
13
|
+
|
|
14
|
+
instance = Phrase::TeamCreateParameters.new(name: German Translators)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/TeamDetail.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Phrase::TeamDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **String** | | [optional]
|
|
8
|
+
**name** | **String** | | [optional]
|
|
9
|
+
**created_at** | **DateTime** | | [optional]
|
|
10
|
+
**updated_at** | **DateTime** | | [optional]
|
|
11
|
+
**projects** | [**Array<Project>**](Project.md) | | [optional]
|
|
12
|
+
**spaces** | [**Array<Space>**](Space.md) | | [optional]
|
|
13
|
+
**users** | [**Array<User>**](User.md) | | [optional]
|
|
14
|
+
|
|
15
|
+
## Code Sample
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'Phrase'
|
|
19
|
+
|
|
20
|
+
instance = Phrase::TeamDetail.new(id: null,
|
|
21
|
+
name: null,
|
|
22
|
+
created_at: null,
|
|
23
|
+
updated_at: null,
|
|
24
|
+
projects: null,
|
|
25
|
+
spaces: null,
|
|
26
|
+
users: null)
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Phrase::TeamUpdateParameters
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | New name of the team | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'Phrase'
|
|
13
|
+
|
|
14
|
+
instance = Phrase::TeamUpdateParameters.new(name: German Translators)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/TeamsApi.md
ADDED
|
@@ -0,0 +1,721 @@
|
|
|
1
|
+
# Phrase::TeamsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**team_create**](TeamsApi.md#team_create) | **POST** /accounts/{account_id}/teams | Create a Team
|
|
8
|
+
[**team_delete**](TeamsApi.md#team_delete) | **DELETE** /accounts/{account_id}/teams/{team_id} | Delete Team
|
|
9
|
+
[**team_show**](TeamsApi.md#team_show) | **GET** /accounts/{account_id}/teams/{team_id} | Get Team
|
|
10
|
+
[**team_update**](TeamsApi.md#team_update) | **PATCH** /accounts/{account_id}/teams/{team_id} | Update Team
|
|
11
|
+
[**teams_list**](TeamsApi.md#teams_list) | **GET** /accounts/{account_id}/teams | List Teams
|
|
12
|
+
[**teams_projects_create**](TeamsApi.md#teams_projects_create) | **POST** /accounts/{account_id}/teams/{team_id}/projects | Add Project
|
|
13
|
+
[**teams_projects_delete**](TeamsApi.md#teams_projects_delete) | **DELETE** /accounts/{account_id}/teams/{team_id}/projects/{id} | Remove Project
|
|
14
|
+
[**teams_spaces_create**](TeamsApi.md#teams_spaces_create) | **POST** /accounts/{account_id}/teams/{team_id}/spaces | Add Space
|
|
15
|
+
[**teams_spaces_delete**](TeamsApi.md#teams_spaces_delete) | **DELETE** /accounts/{account_id}/teams/{team_id}/spaces/{id} | Remove Space
|
|
16
|
+
[**teams_users_create**](TeamsApi.md#teams_users_create) | **POST** /accounts/{account_id}/teams/{team_id}/users | Add User
|
|
17
|
+
[**teams_users_delete**](TeamsApi.md#teams_users_delete) | **DELETE** /accounts/{account_id}/teams/{team_id}/users/{id} | Remove User
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
## team_create
|
|
22
|
+
|
|
23
|
+
> TeamDetail team_create(account_id, team_create_parameters, opts)
|
|
24
|
+
|
|
25
|
+
Create a Team
|
|
26
|
+
|
|
27
|
+
Create a new Team.
|
|
28
|
+
|
|
29
|
+
### Example
|
|
30
|
+
|
|
31
|
+
```ruby
|
|
32
|
+
# load the gem
|
|
33
|
+
require 'phrase'
|
|
34
|
+
# setup authorization
|
|
35
|
+
Phrase.configure do |config|
|
|
36
|
+
# Configure HTTP basic authorization: Basic
|
|
37
|
+
config.username = 'YOUR USERNAME'
|
|
38
|
+
config.password = 'YOUR PASSWORD'
|
|
39
|
+
|
|
40
|
+
# Configure API key authorization: Token
|
|
41
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
42
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
api_instance = Phrase::TeamsApi.new
|
|
46
|
+
account_id = 'account_id_example' # String | Account ID
|
|
47
|
+
team_create_parameters = Phrase::TeamCreateParameters.new # TeamCreateParameters |
|
|
48
|
+
opts = {
|
|
49
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
begin
|
|
53
|
+
#Create a Team
|
|
54
|
+
result = api_instance.team_create(account_id, team_create_parameters, opts)
|
|
55
|
+
pp result
|
|
56
|
+
rescue Phrase::ApiError => e
|
|
57
|
+
puts "Exception when calling TeamsApi->team_create: #{e}"
|
|
58
|
+
end
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Parameters
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
Name | Type | Description | Notes
|
|
65
|
+
------------- | ------------- | ------------- | -------------
|
|
66
|
+
**account_id** | **String**| Account ID |
|
|
67
|
+
**team_create_parameters** | [**TeamCreateParameters**](TeamCreateParameters.md)| |
|
|
68
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
69
|
+
|
|
70
|
+
### Return type
|
|
71
|
+
|
|
72
|
+
Response<([**TeamDetail**](TeamDetail.md))>
|
|
73
|
+
|
|
74
|
+
### Authorization
|
|
75
|
+
|
|
76
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
77
|
+
|
|
78
|
+
### HTTP request headers
|
|
79
|
+
|
|
80
|
+
- **Content-Type**: application/json
|
|
81
|
+
- **Accept**: application/json
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
## team_delete
|
|
85
|
+
|
|
86
|
+
> team_delete(account_id, id, opts)
|
|
87
|
+
|
|
88
|
+
Delete Team
|
|
89
|
+
|
|
90
|
+
Delete the specified Team.
|
|
91
|
+
|
|
92
|
+
### Example
|
|
93
|
+
|
|
94
|
+
```ruby
|
|
95
|
+
# load the gem
|
|
96
|
+
require 'phrase'
|
|
97
|
+
# setup authorization
|
|
98
|
+
Phrase.configure do |config|
|
|
99
|
+
# Configure HTTP basic authorization: Basic
|
|
100
|
+
config.username = 'YOUR USERNAME'
|
|
101
|
+
config.password = 'YOUR PASSWORD'
|
|
102
|
+
|
|
103
|
+
# Configure API key authorization: Token
|
|
104
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
105
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
api_instance = Phrase::TeamsApi.new
|
|
109
|
+
account_id = 'account_id_example' # String | Account ID
|
|
110
|
+
id = 'id_example' # String | ID
|
|
111
|
+
opts = {
|
|
112
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
begin
|
|
116
|
+
#Delete Team
|
|
117
|
+
api_instance.team_delete(account_id, id, opts)
|
|
118
|
+
rescue Phrase::ApiError => e
|
|
119
|
+
puts "Exception when calling TeamsApi->team_delete: #{e}"
|
|
120
|
+
end
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Parameters
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
Name | Type | Description | Notes
|
|
127
|
+
------------- | ------------- | ------------- | -------------
|
|
128
|
+
**account_id** | **String**| Account ID |
|
|
129
|
+
**id** | **String**| ID |
|
|
130
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
131
|
+
|
|
132
|
+
### Return type
|
|
133
|
+
|
|
134
|
+
Response<(nil (empty response body))>
|
|
135
|
+
|
|
136
|
+
### Authorization
|
|
137
|
+
|
|
138
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
139
|
+
|
|
140
|
+
### HTTP request headers
|
|
141
|
+
|
|
142
|
+
- **Content-Type**: Not defined
|
|
143
|
+
- **Accept**: Not defined
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
## team_show
|
|
147
|
+
|
|
148
|
+
> TeamDetail team_show(account_id, id, opts)
|
|
149
|
+
|
|
150
|
+
Get Team
|
|
151
|
+
|
|
152
|
+
Show the specified Team.
|
|
153
|
+
|
|
154
|
+
### Example
|
|
155
|
+
|
|
156
|
+
```ruby
|
|
157
|
+
# load the gem
|
|
158
|
+
require 'phrase'
|
|
159
|
+
# setup authorization
|
|
160
|
+
Phrase.configure do |config|
|
|
161
|
+
# Configure HTTP basic authorization: Basic
|
|
162
|
+
config.username = 'YOUR USERNAME'
|
|
163
|
+
config.password = 'YOUR PASSWORD'
|
|
164
|
+
|
|
165
|
+
# Configure API key authorization: Token
|
|
166
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
167
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
api_instance = Phrase::TeamsApi.new
|
|
171
|
+
account_id = 'account_id_example' # String | Account ID
|
|
172
|
+
id = 'id_example' # String | ID
|
|
173
|
+
opts = {
|
|
174
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
begin
|
|
178
|
+
#Get Team
|
|
179
|
+
result = api_instance.team_show(account_id, id, opts)
|
|
180
|
+
pp result
|
|
181
|
+
rescue Phrase::ApiError => e
|
|
182
|
+
puts "Exception when calling TeamsApi->team_show: #{e}"
|
|
183
|
+
end
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
### Parameters
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
Name | Type | Description | Notes
|
|
190
|
+
------------- | ------------- | ------------- | -------------
|
|
191
|
+
**account_id** | **String**| Account ID |
|
|
192
|
+
**id** | **String**| ID |
|
|
193
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
194
|
+
|
|
195
|
+
### Return type
|
|
196
|
+
|
|
197
|
+
Response<([**TeamDetail**](TeamDetail.md))>
|
|
198
|
+
|
|
199
|
+
### Authorization
|
|
200
|
+
|
|
201
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
202
|
+
|
|
203
|
+
### HTTP request headers
|
|
204
|
+
|
|
205
|
+
- **Content-Type**: Not defined
|
|
206
|
+
- **Accept**: application/json
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
## team_update
|
|
210
|
+
|
|
211
|
+
> TeamDetail team_update(account_id, id, team_update_parameters, opts)
|
|
212
|
+
|
|
213
|
+
Update Team
|
|
214
|
+
|
|
215
|
+
Update the specified Team.
|
|
216
|
+
|
|
217
|
+
### Example
|
|
218
|
+
|
|
219
|
+
```ruby
|
|
220
|
+
# load the gem
|
|
221
|
+
require 'phrase'
|
|
222
|
+
# setup authorization
|
|
223
|
+
Phrase.configure do |config|
|
|
224
|
+
# Configure HTTP basic authorization: Basic
|
|
225
|
+
config.username = 'YOUR USERNAME'
|
|
226
|
+
config.password = 'YOUR PASSWORD'
|
|
227
|
+
|
|
228
|
+
# Configure API key authorization: Token
|
|
229
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
230
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
api_instance = Phrase::TeamsApi.new
|
|
234
|
+
account_id = 'account_id_example' # String | Account ID
|
|
235
|
+
id = 'id_example' # String | ID
|
|
236
|
+
team_update_parameters = Phrase::TeamUpdateParameters.new # TeamUpdateParameters |
|
|
237
|
+
opts = {
|
|
238
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
begin
|
|
242
|
+
#Update Team
|
|
243
|
+
result = api_instance.team_update(account_id, id, team_update_parameters, opts)
|
|
244
|
+
pp result
|
|
245
|
+
rescue Phrase::ApiError => e
|
|
246
|
+
puts "Exception when calling TeamsApi->team_update: #{e}"
|
|
247
|
+
end
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
### Parameters
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
Name | Type | Description | Notes
|
|
254
|
+
------------- | ------------- | ------------- | -------------
|
|
255
|
+
**account_id** | **String**| Account ID |
|
|
256
|
+
**id** | **String**| ID |
|
|
257
|
+
**team_update_parameters** | [**TeamUpdateParameters**](TeamUpdateParameters.md)| |
|
|
258
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
259
|
+
|
|
260
|
+
### Return type
|
|
261
|
+
|
|
262
|
+
Response<([**TeamDetail**](TeamDetail.md))>
|
|
263
|
+
|
|
264
|
+
### Authorization
|
|
265
|
+
|
|
266
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
267
|
+
|
|
268
|
+
### HTTP request headers
|
|
269
|
+
|
|
270
|
+
- **Content-Type**: application/json
|
|
271
|
+
- **Accept**: application/json
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
## teams_list
|
|
275
|
+
|
|
276
|
+
> Array<Team> teams_list(account_id, opts)
|
|
277
|
+
|
|
278
|
+
List Teams
|
|
279
|
+
|
|
280
|
+
List all Teams for the given account.
|
|
281
|
+
|
|
282
|
+
### Example
|
|
283
|
+
|
|
284
|
+
```ruby
|
|
285
|
+
# load the gem
|
|
286
|
+
require 'phrase'
|
|
287
|
+
# setup authorization
|
|
288
|
+
Phrase.configure do |config|
|
|
289
|
+
# Configure HTTP basic authorization: Basic
|
|
290
|
+
config.username = 'YOUR USERNAME'
|
|
291
|
+
config.password = 'YOUR PASSWORD'
|
|
292
|
+
|
|
293
|
+
# Configure API key authorization: Token
|
|
294
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
295
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
296
|
+
end
|
|
297
|
+
|
|
298
|
+
api_instance = Phrase::TeamsApi.new
|
|
299
|
+
account_id = 'account_id_example' # String | Account ID
|
|
300
|
+
opts = {
|
|
301
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
302
|
+
page: 1, # Integer | Page number
|
|
303
|
+
per_page: 10 # Integer | allows you to specify a page size up to 100 items, 10 by default
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
begin
|
|
307
|
+
#List Teams
|
|
308
|
+
result = api_instance.teams_list(account_id, opts)
|
|
309
|
+
pp result
|
|
310
|
+
rescue Phrase::ApiError => e
|
|
311
|
+
puts "Exception when calling TeamsApi->teams_list: #{e}"
|
|
312
|
+
end
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
### Parameters
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
Name | Type | Description | Notes
|
|
319
|
+
------------- | ------------- | ------------- | -------------
|
|
320
|
+
**account_id** | **String**| Account ID |
|
|
321
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
322
|
+
**page** | **Integer**| Page number | [optional]
|
|
323
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional]
|
|
324
|
+
|
|
325
|
+
### Return type
|
|
326
|
+
|
|
327
|
+
Response<([**Array<Team>**](Team.md))>
|
|
328
|
+
|
|
329
|
+
### Authorization
|
|
330
|
+
|
|
331
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
332
|
+
|
|
333
|
+
### HTTP request headers
|
|
334
|
+
|
|
335
|
+
- **Content-Type**: Not defined
|
|
336
|
+
- **Accept**: application/json
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
## teams_projects_create
|
|
340
|
+
|
|
341
|
+
> teams_projects_create(account_id, team_id, teams_projects_create_parameters, opts)
|
|
342
|
+
|
|
343
|
+
Add Project
|
|
344
|
+
|
|
345
|
+
Adds an existing project to the team.
|
|
346
|
+
|
|
347
|
+
### Example
|
|
348
|
+
|
|
349
|
+
```ruby
|
|
350
|
+
# load the gem
|
|
351
|
+
require 'phrase'
|
|
352
|
+
# setup authorization
|
|
353
|
+
Phrase.configure do |config|
|
|
354
|
+
# Configure HTTP basic authorization: Basic
|
|
355
|
+
config.username = 'YOUR USERNAME'
|
|
356
|
+
config.password = 'YOUR PASSWORD'
|
|
357
|
+
|
|
358
|
+
# Configure API key authorization: Token
|
|
359
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
360
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
361
|
+
end
|
|
362
|
+
|
|
363
|
+
api_instance = Phrase::TeamsApi.new
|
|
364
|
+
account_id = 'account_id_example' # String | Account ID
|
|
365
|
+
team_id = 'team_id_example' # String | Team ID
|
|
366
|
+
teams_projects_create_parameters = Phrase::TeamsProjectsCreateParameters.new # TeamsProjectsCreateParameters |
|
|
367
|
+
opts = {
|
|
368
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
369
|
+
}
|
|
370
|
+
|
|
371
|
+
begin
|
|
372
|
+
#Add Project
|
|
373
|
+
api_instance.teams_projects_create(account_id, team_id, teams_projects_create_parameters, opts)
|
|
374
|
+
rescue Phrase::ApiError => e
|
|
375
|
+
puts "Exception when calling TeamsApi->teams_projects_create: #{e}"
|
|
376
|
+
end
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
### Parameters
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
Name | Type | Description | Notes
|
|
383
|
+
------------- | ------------- | ------------- | -------------
|
|
384
|
+
**account_id** | **String**| Account ID |
|
|
385
|
+
**team_id** | **String**| Team ID |
|
|
386
|
+
**teams_projects_create_parameters** | [**TeamsProjectsCreateParameters**](TeamsProjectsCreateParameters.md)| |
|
|
387
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
388
|
+
|
|
389
|
+
### Return type
|
|
390
|
+
|
|
391
|
+
Response<(nil (empty response body))>
|
|
392
|
+
|
|
393
|
+
### Authorization
|
|
394
|
+
|
|
395
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
396
|
+
|
|
397
|
+
### HTTP request headers
|
|
398
|
+
|
|
399
|
+
- **Content-Type**: application/json
|
|
400
|
+
- **Accept**: Not defined
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
## teams_projects_delete
|
|
404
|
+
|
|
405
|
+
> teams_projects_delete(account_id, team_id, id, opts)
|
|
406
|
+
|
|
407
|
+
Remove Project
|
|
408
|
+
|
|
409
|
+
Removes a specified project from the specified team.
|
|
410
|
+
|
|
411
|
+
### Example
|
|
412
|
+
|
|
413
|
+
```ruby
|
|
414
|
+
# load the gem
|
|
415
|
+
require 'phrase'
|
|
416
|
+
# setup authorization
|
|
417
|
+
Phrase.configure do |config|
|
|
418
|
+
# Configure HTTP basic authorization: Basic
|
|
419
|
+
config.username = 'YOUR USERNAME'
|
|
420
|
+
config.password = 'YOUR PASSWORD'
|
|
421
|
+
|
|
422
|
+
# Configure API key authorization: Token
|
|
423
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
424
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
425
|
+
end
|
|
426
|
+
|
|
427
|
+
api_instance = Phrase::TeamsApi.new
|
|
428
|
+
account_id = 'account_id_example' # String | Account ID
|
|
429
|
+
team_id = 'team_id_example' # String | Team ID
|
|
430
|
+
id = 'id_example' # String | ID
|
|
431
|
+
opts = {
|
|
432
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
begin
|
|
436
|
+
#Remove Project
|
|
437
|
+
api_instance.teams_projects_delete(account_id, team_id, id, opts)
|
|
438
|
+
rescue Phrase::ApiError => e
|
|
439
|
+
puts "Exception when calling TeamsApi->teams_projects_delete: #{e}"
|
|
440
|
+
end
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
### Parameters
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
Name | Type | Description | Notes
|
|
447
|
+
------------- | ------------- | ------------- | -------------
|
|
448
|
+
**account_id** | **String**| Account ID |
|
|
449
|
+
**team_id** | **String**| Team ID |
|
|
450
|
+
**id** | **String**| ID |
|
|
451
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
452
|
+
|
|
453
|
+
### Return type
|
|
454
|
+
|
|
455
|
+
Response<(nil (empty response body))>
|
|
456
|
+
|
|
457
|
+
### Authorization
|
|
458
|
+
|
|
459
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
460
|
+
|
|
461
|
+
### HTTP request headers
|
|
462
|
+
|
|
463
|
+
- **Content-Type**: Not defined
|
|
464
|
+
- **Accept**: Not defined
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
## teams_spaces_create
|
|
468
|
+
|
|
469
|
+
> teams_spaces_create(account_id, team_id, teams_spaces_create_parameters, opts)
|
|
470
|
+
|
|
471
|
+
Add Space
|
|
472
|
+
|
|
473
|
+
Adds an existing space to the team.
|
|
474
|
+
|
|
475
|
+
### Example
|
|
476
|
+
|
|
477
|
+
```ruby
|
|
478
|
+
# load the gem
|
|
479
|
+
require 'phrase'
|
|
480
|
+
# setup authorization
|
|
481
|
+
Phrase.configure do |config|
|
|
482
|
+
# Configure HTTP basic authorization: Basic
|
|
483
|
+
config.username = 'YOUR USERNAME'
|
|
484
|
+
config.password = 'YOUR PASSWORD'
|
|
485
|
+
|
|
486
|
+
# Configure API key authorization: Token
|
|
487
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
488
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
489
|
+
end
|
|
490
|
+
|
|
491
|
+
api_instance = Phrase::TeamsApi.new
|
|
492
|
+
account_id = 'account_id_example' # String | Account ID
|
|
493
|
+
team_id = 'team_id_example' # String | Team ID
|
|
494
|
+
teams_spaces_create_parameters = Phrase::TeamsSpacesCreateParameters.new # TeamsSpacesCreateParameters |
|
|
495
|
+
opts = {
|
|
496
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
497
|
+
}
|
|
498
|
+
|
|
499
|
+
begin
|
|
500
|
+
#Add Space
|
|
501
|
+
api_instance.teams_spaces_create(account_id, team_id, teams_spaces_create_parameters, opts)
|
|
502
|
+
rescue Phrase::ApiError => e
|
|
503
|
+
puts "Exception when calling TeamsApi->teams_spaces_create: #{e}"
|
|
504
|
+
end
|
|
505
|
+
```
|
|
506
|
+
|
|
507
|
+
### Parameters
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
Name | Type | Description | Notes
|
|
511
|
+
------------- | ------------- | ------------- | -------------
|
|
512
|
+
**account_id** | **String**| Account ID |
|
|
513
|
+
**team_id** | **String**| Team ID |
|
|
514
|
+
**teams_spaces_create_parameters** | [**TeamsSpacesCreateParameters**](TeamsSpacesCreateParameters.md)| |
|
|
515
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
516
|
+
|
|
517
|
+
### Return type
|
|
518
|
+
|
|
519
|
+
Response<(nil (empty response body))>
|
|
520
|
+
|
|
521
|
+
### Authorization
|
|
522
|
+
|
|
523
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
524
|
+
|
|
525
|
+
### HTTP request headers
|
|
526
|
+
|
|
527
|
+
- **Content-Type**: application/json
|
|
528
|
+
- **Accept**: Not defined
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
## teams_spaces_delete
|
|
532
|
+
|
|
533
|
+
> teams_spaces_delete(account_id, team_id, id, opts)
|
|
534
|
+
|
|
535
|
+
Remove Space
|
|
536
|
+
|
|
537
|
+
Removes a specified space from the specified team.
|
|
538
|
+
|
|
539
|
+
### Example
|
|
540
|
+
|
|
541
|
+
```ruby
|
|
542
|
+
# load the gem
|
|
543
|
+
require 'phrase'
|
|
544
|
+
# setup authorization
|
|
545
|
+
Phrase.configure do |config|
|
|
546
|
+
# Configure HTTP basic authorization: Basic
|
|
547
|
+
config.username = 'YOUR USERNAME'
|
|
548
|
+
config.password = 'YOUR PASSWORD'
|
|
549
|
+
|
|
550
|
+
# Configure API key authorization: Token
|
|
551
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
552
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
553
|
+
end
|
|
554
|
+
|
|
555
|
+
api_instance = Phrase::TeamsApi.new
|
|
556
|
+
account_id = 'account_id_example' # String | Account ID
|
|
557
|
+
team_id = 'team_id_example' # String | Team ID
|
|
558
|
+
id = 'id_example' # String | ID
|
|
559
|
+
opts = {
|
|
560
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
561
|
+
}
|
|
562
|
+
|
|
563
|
+
begin
|
|
564
|
+
#Remove Space
|
|
565
|
+
api_instance.teams_spaces_delete(account_id, team_id, id, opts)
|
|
566
|
+
rescue Phrase::ApiError => e
|
|
567
|
+
puts "Exception when calling TeamsApi->teams_spaces_delete: #{e}"
|
|
568
|
+
end
|
|
569
|
+
```
|
|
570
|
+
|
|
571
|
+
### Parameters
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
Name | Type | Description | Notes
|
|
575
|
+
------------- | ------------- | ------------- | -------------
|
|
576
|
+
**account_id** | **String**| Account ID |
|
|
577
|
+
**team_id** | **String**| Team ID |
|
|
578
|
+
**id** | **String**| ID |
|
|
579
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
580
|
+
|
|
581
|
+
### Return type
|
|
582
|
+
|
|
583
|
+
Response<(nil (empty response body))>
|
|
584
|
+
|
|
585
|
+
### Authorization
|
|
586
|
+
|
|
587
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
588
|
+
|
|
589
|
+
### HTTP request headers
|
|
590
|
+
|
|
591
|
+
- **Content-Type**: Not defined
|
|
592
|
+
- **Accept**: Not defined
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
## teams_users_create
|
|
596
|
+
|
|
597
|
+
> teams_users_create(account_id, team_id, teams_users_create_parameters, opts)
|
|
598
|
+
|
|
599
|
+
Add User
|
|
600
|
+
|
|
601
|
+
Adds an existing user to the team.
|
|
602
|
+
|
|
603
|
+
### Example
|
|
604
|
+
|
|
605
|
+
```ruby
|
|
606
|
+
# load the gem
|
|
607
|
+
require 'phrase'
|
|
608
|
+
# setup authorization
|
|
609
|
+
Phrase.configure do |config|
|
|
610
|
+
# Configure HTTP basic authorization: Basic
|
|
611
|
+
config.username = 'YOUR USERNAME'
|
|
612
|
+
config.password = 'YOUR PASSWORD'
|
|
613
|
+
|
|
614
|
+
# Configure API key authorization: Token
|
|
615
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
616
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
617
|
+
end
|
|
618
|
+
|
|
619
|
+
api_instance = Phrase::TeamsApi.new
|
|
620
|
+
account_id = 'account_id_example' # String | Account ID
|
|
621
|
+
team_id = 'team_id_example' # String | Team ID
|
|
622
|
+
teams_users_create_parameters = Phrase::TeamsUsersCreateParameters.new # TeamsUsersCreateParameters |
|
|
623
|
+
opts = {
|
|
624
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
625
|
+
}
|
|
626
|
+
|
|
627
|
+
begin
|
|
628
|
+
#Add User
|
|
629
|
+
api_instance.teams_users_create(account_id, team_id, teams_users_create_parameters, opts)
|
|
630
|
+
rescue Phrase::ApiError => e
|
|
631
|
+
puts "Exception when calling TeamsApi->teams_users_create: #{e}"
|
|
632
|
+
end
|
|
633
|
+
```
|
|
634
|
+
|
|
635
|
+
### Parameters
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
Name | Type | Description | Notes
|
|
639
|
+
------------- | ------------- | ------------- | -------------
|
|
640
|
+
**account_id** | **String**| Account ID |
|
|
641
|
+
**team_id** | **String**| Team ID |
|
|
642
|
+
**teams_users_create_parameters** | [**TeamsUsersCreateParameters**](TeamsUsersCreateParameters.md)| |
|
|
643
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
644
|
+
|
|
645
|
+
### Return type
|
|
646
|
+
|
|
647
|
+
Response<(nil (empty response body))>
|
|
648
|
+
|
|
649
|
+
### Authorization
|
|
650
|
+
|
|
651
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
652
|
+
|
|
653
|
+
### HTTP request headers
|
|
654
|
+
|
|
655
|
+
- **Content-Type**: application/json
|
|
656
|
+
- **Accept**: Not defined
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
## teams_users_delete
|
|
660
|
+
|
|
661
|
+
> teams_users_delete(account_id, team_id, id, opts)
|
|
662
|
+
|
|
663
|
+
Remove User
|
|
664
|
+
|
|
665
|
+
Removes a specified user from the specified team.
|
|
666
|
+
|
|
667
|
+
### Example
|
|
668
|
+
|
|
669
|
+
```ruby
|
|
670
|
+
# load the gem
|
|
671
|
+
require 'phrase'
|
|
672
|
+
# setup authorization
|
|
673
|
+
Phrase.configure do |config|
|
|
674
|
+
# Configure HTTP basic authorization: Basic
|
|
675
|
+
config.username = 'YOUR USERNAME'
|
|
676
|
+
config.password = 'YOUR PASSWORD'
|
|
677
|
+
|
|
678
|
+
# Configure API key authorization: Token
|
|
679
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
680
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
681
|
+
end
|
|
682
|
+
|
|
683
|
+
api_instance = Phrase::TeamsApi.new
|
|
684
|
+
account_id = 'account_id_example' # String | Account ID
|
|
685
|
+
team_id = 'team_id_example' # String | Team ID
|
|
686
|
+
id = 'id_example' # String | ID
|
|
687
|
+
opts = {
|
|
688
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
689
|
+
}
|
|
690
|
+
|
|
691
|
+
begin
|
|
692
|
+
#Remove User
|
|
693
|
+
api_instance.teams_users_delete(account_id, team_id, id, opts)
|
|
694
|
+
rescue Phrase::ApiError => e
|
|
695
|
+
puts "Exception when calling TeamsApi->teams_users_delete: #{e}"
|
|
696
|
+
end
|
|
697
|
+
```
|
|
698
|
+
|
|
699
|
+
### Parameters
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
Name | Type | Description | Notes
|
|
703
|
+
------------- | ------------- | ------------- | -------------
|
|
704
|
+
**account_id** | **String**| Account ID |
|
|
705
|
+
**team_id** | **String**| Team ID |
|
|
706
|
+
**id** | **String**| ID |
|
|
707
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
708
|
+
|
|
709
|
+
### Return type
|
|
710
|
+
|
|
711
|
+
Response<(nil (empty response body))>
|
|
712
|
+
|
|
713
|
+
### Authorization
|
|
714
|
+
|
|
715
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
716
|
+
|
|
717
|
+
### HTTP request headers
|
|
718
|
+
|
|
719
|
+
- **Content-Type**: Not defined
|
|
720
|
+
- **Accept**: Not defined
|
|
721
|
+
|