phrase 1.0.2 → 1.0.7
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 +13 -3
- data/docs/Account.md +2 -0
- data/docs/AccountDetails.md +3 -3
- data/docs/AccountsApi.md +2 -2
- data/docs/AuthorizationsApi.md +2 -2
- data/docs/BlacklistedKeysApi.md +4 -2
- data/docs/BranchesApi.md +2 -2
- data/docs/CommentsApi.md +2 -2
- data/docs/DistributionsApi.md +2 -2
- data/docs/Document.md +23 -0
- data/docs/DocumentsApi.md +137 -0
- data/docs/GitHubSyncApi.md +130 -0
- data/docs/GitLabSyncApi.md +2 -2
- data/docs/GithubSyncExportParameters.md +17 -0
- data/docs/GithubSyncImportParameters.md +17 -0
- data/docs/GlossariesApi.md +2 -2
- data/docs/GlossaryTermsApi.md +2 -2
- data/docs/InlineResponse422.md +19 -0
- data/docs/InlineResponse422Errors.md +21 -0
- data/docs/InvitationsApi.md +2 -2
- data/docs/Job.md +5 -1
- data/docs/JobCreateParameters.md +2 -0
- data/docs/JobDetails.md +4 -0
- data/docs/JobLocalesApi.md +2 -2
- data/docs/JobUpdateParameters.md +3 -1
- data/docs/JobsApi.md +74 -2
- data/docs/KeysApi.md +4 -4
- data/docs/LocalesApi.md +2 -2
- data/docs/MembersApi.md +2 -2
- data/docs/OrdersApi.md +2 -2
- data/docs/Project.md +2 -0
- data/docs/ProjectDetails.md +2 -2
- data/docs/ProjectsApi.md +2 -2
- data/docs/ReleasesApi.md +2 -2
- data/docs/ScreenshotMarkersApi.md +2 -2
- data/docs/ScreenshotsApi.md +4 -2
- data/docs/SpacesApi.md +4 -4
- data/docs/StyleGuidesApi.md +2 -2
- data/docs/TagsApi.md +2 -2
- data/docs/TeamsApi.md +2 -2
- data/docs/TranslationsApi.md +8 -8
- data/docs/UploadsApi.md +2 -2
- data/docs/VersionsHistoryApi.md +2 -2
- data/docs/WebhookCreateParameters.md +2 -0
- data/docs/WebhookUpdateParameters.md +2 -0
- data/docs/WebhooksApi.md +2 -2
- data/lib/phrase.rb +7 -0
- data/lib/phrase/api/accounts_api.rb +2 -2
- data/lib/phrase/api/authorizations_api.rb +2 -2
- data/lib/phrase/api/blacklisted_keys_api.rb +5 -2
- data/lib/phrase/api/branches_api.rb +2 -2
- data/lib/phrase/api/comments_api.rb +2 -2
- data/lib/phrase/api/distributions_api.rb +2 -2
- data/lib/phrase/api/documents_api.rb +152 -0
- data/lib/phrase/api/git_hub_sync_api.rb +146 -0
- data/lib/phrase/api/git_lab_sync_api.rb +2 -2
- data/lib/phrase/api/glossaries_api.rb +2 -2
- data/lib/phrase/api/glossary_terms_api.rb +2 -2
- data/lib/phrase/api/invitations_api.rb +2 -2
- data/lib/phrase/api/job_locales_api.rb +2 -2
- data/lib/phrase/api/jobs_api.rb +83 -2
- data/lib/phrase/api/keys_api.rb +4 -4
- data/lib/phrase/api/locales_api.rb +2 -2
- data/lib/phrase/api/members_api.rb +2 -2
- data/lib/phrase/api/orders_api.rb +2 -2
- data/lib/phrase/api/projects_api.rb +2 -2
- data/lib/phrase/api/releases_api.rb +2 -2
- data/lib/phrase/api/screenshot_markers_api.rb +2 -2
- data/lib/phrase/api/screenshots_api.rb +5 -2
- data/lib/phrase/api/spaces_api.rb +4 -4
- data/lib/phrase/api/style_guides_api.rb +2 -2
- data/lib/phrase/api/tags_api.rb +2 -2
- data/lib/phrase/api/teams_api.rb +2 -2
- data/lib/phrase/api/translations_api.rb +8 -8
- data/lib/phrase/api/uploads_api.rb +2 -2
- data/lib/phrase/api/versions_history_api.rb +2 -2
- data/lib/phrase/api/webhooks_api.rb +2 -2
- data/lib/phrase/api_client.rb +2 -2
- data/lib/phrase/models/account.rb +10 -1
- data/lib/phrase/models/account_details.rb +13 -13
- data/lib/phrase/models/document.rb +221 -0
- data/lib/phrase/models/github_sync_export_parameters.rb +195 -0
- data/lib/phrase/models/github_sync_import_parameters.rb +195 -0
- data/lib/phrase/models/inline_response422.rb +205 -0
- data/lib/phrase/models/inline_response422_errors.rb +212 -0
- data/lib/phrase/models/job.rb +22 -4
- data/lib/phrase/models/job_create_parameters.rb +11 -1
- data/lib/phrase/models/job_details.rb +19 -1
- data/lib/phrase/models/job_update_parameters.rb +14 -4
- data/lib/phrase/models/project.rb +10 -1
- data/lib/phrase/models/project_details.rb +10 -10
- data/lib/phrase/models/webhook_create_parameters.rb +11 -1
- data/lib/phrase/models/webhook_update_parameters.rb +11 -1
- data/lib/phrase/version.rb +1 -1
- data/spec/api/accounts_api_spec.rb +1 -1
- data/spec/api/authorizations_api_spec.rb +1 -1
- data/spec/api/blacklisted_keys_api_spec.rb +2 -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/documents_api_spec.rb +52 -0
- data/spec/api/git_hub_sync_api_spec.rb +49 -0
- data/spec/api/git_lab_sync_api_spec.rb +1 -1
- data/spec/api/glossaries_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 +19 -1
- data/spec/api/keys_api_spec.rb +2 -2
- data/spec/api/locales_api_spec.rb +1 -1
- data/spec/api/members_api_spec.rb +1 -1
- 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 +2 -1
- data/spec/api/spaces_api_spec.rb +2 -2
- 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 +1 -1
- data/spec/api/translations_api_spec.rb +4 -4
- data/spec/api/uploads_api_spec.rb +1 -1
- data/spec/api/versions_history_api_spec.rb +1 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/models/account_details_spec.rb +4 -4
- data/spec/models/account_spec.rb +6 -0
- data/spec/models/document_spec.rb +47 -0
- data/spec/models/github_sync_export_parameters_spec.rb +29 -0
- data/spec/models/github_sync_import_parameters_spec.rb +29 -0
- data/spec/models/inline_response422_errors_spec.rb +41 -0
- data/spec/models/inline_response422_spec.rb +35 -0
- data/spec/models/job_create_parameters_spec.rb +6 -0
- data/spec/models/job_details_spec.rb +12 -0
- data/spec/models/job_spec.rb +12 -0
- data/spec/models/job_update_parameters_spec.rb +6 -0
- data/spec/models/project_details_spec.rb +6 -6
- data/spec/models/project_spec.rb +6 -0
- data/spec/models/webhook_create_parameters_spec.rb +6 -0
- data/spec/models/webhook_update_parameters_spec.rb +6 -0
- metadata +183 -155
data/docs/GitLabSyncApi.md
CHANGED
|
@@ -168,7 +168,7 @@ gitlab_sync_id = 'gitlab_sync_id_example' # String | Gitlab Sync ID
|
|
|
168
168
|
opts = {
|
|
169
169
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
170
170
|
page: 1, # Integer | Page number
|
|
171
|
-
per_page:
|
|
171
|
+
per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
|
|
172
172
|
account_id: 'abcd1234' # String | Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.
|
|
173
173
|
}
|
|
174
174
|
|
|
@@ -189,7 +189,7 @@ Name | Type | Description | Notes
|
|
|
189
189
|
**gitlab_sync_id** | **String**| Gitlab Sync ID |
|
|
190
190
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
191
191
|
**page** | **Integer**| Page number | [optional]
|
|
192
|
-
**per_page** | **Integer**| allows you to specify a page size up to 100 items,
|
|
192
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
|
193
193
|
**account_id** | **String**| Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts. | [optional]
|
|
194
194
|
|
|
195
195
|
### Return type
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Phrase::GithubSyncExportParameters
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**project_id** | **String** | Project ID to specify the actual project the GitHub export should be triggered in. | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'Phrase'
|
|
13
|
+
|
|
14
|
+
instance = Phrase::GithubSyncExportParameters.new(project_id: abcd1234)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Phrase::GithubSyncImportParameters
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**project_id** | **String** | Project ID to specify the actual project the GitHub import should be triggered in. | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'Phrase'
|
|
13
|
+
|
|
14
|
+
instance = Phrase::GithubSyncImportParameters.new(project_id: abcd1234)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/GlossariesApi.md
CHANGED
|
@@ -41,7 +41,7 @@ account_id = 'account_id_example' # String | Account ID
|
|
|
41
41
|
opts = {
|
|
42
42
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
43
43
|
page: 1, # Integer | Page number
|
|
44
|
-
per_page:
|
|
44
|
+
per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
|
|
45
45
|
}
|
|
46
46
|
|
|
47
47
|
begin
|
|
@@ -61,7 +61,7 @@ Name | Type | Description | Notes
|
|
|
61
61
|
**account_id** | **String**| Account ID |
|
|
62
62
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
63
63
|
**page** | **Integer**| Page number | [optional]
|
|
64
|
-
**per_page** | **Integer**| allows you to specify a page size up to 100 items,
|
|
64
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
|
65
65
|
|
|
66
66
|
### Return type
|
|
67
67
|
|
data/docs/GlossaryTermsApi.md
CHANGED
|
@@ -303,7 +303,7 @@ glossary_id = 'glossary_id_example' # String | Glossary ID
|
|
|
303
303
|
opts = {
|
|
304
304
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
305
305
|
page: 1, # Integer | Page number
|
|
306
|
-
per_page:
|
|
306
|
+
per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
|
|
307
307
|
}
|
|
308
308
|
|
|
309
309
|
begin
|
|
@@ -324,7 +324,7 @@ Name | Type | Description | Notes
|
|
|
324
324
|
**glossary_id** | **String**| Glossary ID |
|
|
325
325
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
326
326
|
**page** | **Integer**| Page number | [optional]
|
|
327
|
-
**per_page** | **Integer**| allows you to specify a page size up to 100 items,
|
|
327
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
|
328
328
|
|
|
329
329
|
### Return type
|
|
330
330
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Phrase::InlineResponse422
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**message** | **String** | | [optional]
|
|
8
|
+
**errors** | [**Array<InlineResponse422Errors>**](InlineResponse422Errors.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'Phrase'
|
|
14
|
+
|
|
15
|
+
instance = Phrase::InlineResponse422.new(message: null,
|
|
16
|
+
errors: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Phrase::InlineResponse422Errors
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**resource** | **String** | | [optional]
|
|
8
|
+
**field** | **String** | | [optional]
|
|
9
|
+
**message** | **String** | | [optional]
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'Phrase'
|
|
15
|
+
|
|
16
|
+
instance = Phrase::InlineResponse422Errors.new(resource: null,
|
|
17
|
+
field: null,
|
|
18
|
+
message: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
data/docs/InvitationsApi.md
CHANGED
|
@@ -358,7 +358,7 @@ account_id = 'account_id_example' # String | Account ID
|
|
|
358
358
|
opts = {
|
|
359
359
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
360
360
|
page: 1, # Integer | Page number
|
|
361
|
-
per_page:
|
|
361
|
+
per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
|
|
362
362
|
}
|
|
363
363
|
|
|
364
364
|
begin
|
|
@@ -378,7 +378,7 @@ Name | Type | Description | Notes
|
|
|
378
378
|
**account_id** | **String**| Account ID |
|
|
379
379
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
380
380
|
**page** | **Integer**| Page number | [optional]
|
|
381
|
-
**per_page** | **Integer**| allows you to specify a page size up to 100 items,
|
|
381
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
|
382
382
|
|
|
383
383
|
### Return type
|
|
384
384
|
|
data/docs/Job.md
CHANGED
|
@@ -9,8 +9,10 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**briefing** | **String** | | [optional]
|
|
10
10
|
**due_date** | **DateTime** | | [optional]
|
|
11
11
|
**state** | **String** | | [optional]
|
|
12
|
+
**ticket_url** | **String** | | [optional]
|
|
12
13
|
**created_at** | **DateTime** | | [optional]
|
|
13
14
|
**updated_at** | **DateTime** | | [optional]
|
|
15
|
+
**project** | [**ProjectShort**](ProjectShort.md) | | [optional]
|
|
14
16
|
|
|
15
17
|
## Code Sample
|
|
16
18
|
|
|
@@ -22,8 +24,10 @@ instance = Phrase::Job.new(id: null,
|
|
|
22
24
|
briefing: null,
|
|
23
25
|
due_date: null,
|
|
24
26
|
state: null,
|
|
27
|
+
ticket_url: null,
|
|
25
28
|
created_at: null,
|
|
26
|
-
updated_at: null
|
|
29
|
+
updated_at: null,
|
|
30
|
+
project: null)
|
|
27
31
|
```
|
|
28
32
|
|
|
29
33
|
|
data/docs/JobCreateParameters.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **String** | Job name | [optional]
|
|
9
9
|
**briefing** | **String** | Briefing for the translators | [optional]
|
|
10
10
|
**due_date** | **DateTime** | Date the job should be finished | [optional]
|
|
11
|
+
**ticket_url** | **String** | URL to a ticket for this job (e.g. Jira, Trello) | [optional]
|
|
11
12
|
**tags** | **Array<String>** | tags of keys that should be included within the job | [optional]
|
|
12
13
|
**translation_key_ids** | **Array<String>** | ids of keys that should be included within the job | [optional]
|
|
13
14
|
|
|
@@ -20,6 +21,7 @@ instance = Phrase::JobCreateParameters.new(branch: my-feature-branch,
|
|
|
20
21
|
name: de,
|
|
21
22
|
briefing: de-DE,
|
|
22
23
|
due_date: null,
|
|
24
|
+
ticket_url: https://example.atlassian.net/browse/FOO,
|
|
23
25
|
tags: ["myUploadTag"],
|
|
24
26
|
translation_key_ids: ["abcd1234cdef1234abcd1234cdef1234"])
|
|
25
27
|
```
|
data/docs/JobDetails.md
CHANGED
|
@@ -9,8 +9,10 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**briefing** | **String** | | [optional]
|
|
10
10
|
**due_date** | **DateTime** | | [optional]
|
|
11
11
|
**state** | **String** | | [optional]
|
|
12
|
+
**ticket_url** | **String** | | [optional]
|
|
12
13
|
**created_at** | **DateTime** | | [optional]
|
|
13
14
|
**updated_at** | **DateTime** | | [optional]
|
|
15
|
+
**project** | [**ProjectShort**](ProjectShort.md) | | [optional]
|
|
14
16
|
**owner** | [**UserPreview**](UserPreview.md) | | [optional]
|
|
15
17
|
**job_tag_name** | **String** | | [optional]
|
|
16
18
|
**locales** | [**Array<LocalePreview>**](LocalePreview.md) | | [optional]
|
|
@@ -26,8 +28,10 @@ instance = Phrase::JobDetails.new(id: null,
|
|
|
26
28
|
briefing: null,
|
|
27
29
|
due_date: null,
|
|
28
30
|
state: null,
|
|
31
|
+
ticket_url: null,
|
|
29
32
|
created_at: null,
|
|
30
33
|
updated_at: null,
|
|
34
|
+
project: null,
|
|
31
35
|
owner: null,
|
|
32
36
|
job_tag_name: null,
|
|
33
37
|
locales: null,
|
data/docs/JobLocalesApi.md
CHANGED
|
@@ -443,7 +443,7 @@ job_id = 'job_id_example' # String | Job ID
|
|
|
443
443
|
opts = {
|
|
444
444
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
445
445
|
page: 1, # Integer | Page number
|
|
446
|
-
per_page:
|
|
446
|
+
per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
|
|
447
447
|
branch: 'my-feature-branch' # String | specify the branch to use
|
|
448
448
|
}
|
|
449
449
|
|
|
@@ -465,7 +465,7 @@ Name | Type | Description | Notes
|
|
|
465
465
|
**job_id** | **String**| Job ID |
|
|
466
466
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
467
467
|
**page** | **Integer**| Page number | [optional]
|
|
468
|
-
**per_page** | **Integer**| allows you to specify a page size up to 100 items,
|
|
468
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
|
469
469
|
**branch** | **String**| specify the branch to use | [optional]
|
|
470
470
|
|
|
471
471
|
### Return type
|
data/docs/JobUpdateParameters.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **String** | Job name | [optional]
|
|
9
9
|
**briefing** | **String** | Briefing for the translators | [optional]
|
|
10
10
|
**due_date** | **DateTime** | Date the job should be finished | [optional]
|
|
11
|
+
**ticket_url** | **String** | URL to a ticket for this job (e.g. Jira, Trello) | [optional]
|
|
11
12
|
|
|
12
13
|
## Code Sample
|
|
13
14
|
|
|
@@ -17,7 +18,8 @@ require 'Phrase'
|
|
|
17
18
|
instance = Phrase::JobUpdateParameters.new(branch: my-feature-branch,
|
|
18
19
|
name: de,
|
|
19
20
|
briefing: de-DE,
|
|
20
|
-
due_date: null
|
|
21
|
+
due_date: null,
|
|
22
|
+
ticket_url: https://example.atlassian.net/browse/FOO)
|
|
21
23
|
```
|
|
22
24
|
|
|
23
25
|
|
data/docs/JobsApi.md
CHANGED
|
@@ -13,6 +13,7 @@ Method | HTTP request | Description
|
|
|
13
13
|
[**job_show**](JobsApi.md#job_show) | **GET** /projects/{project_id}/jobs/{id} | Get a single job
|
|
14
14
|
[**job_start**](JobsApi.md#job_start) | **POST** /projects/{project_id}/jobs/{id}/start | Start a job
|
|
15
15
|
[**job_update**](JobsApi.md#job_update) | **PATCH** /projects/{project_id}/jobs/{id} | Update a job
|
|
16
|
+
[**jobs_by_account**](JobsApi.md#jobs_by_account) | **GET** /accounts/{account_id}/jobs | List account jobs
|
|
16
17
|
[**jobs_list**](JobsApi.md#jobs_list) | **GET** /projects/{project_id}/jobs | List jobs
|
|
17
18
|
|
|
18
19
|
|
|
@@ -600,6 +601,77 @@ Response<([**JobDetails**](JobDetails.md))>
|
|
|
600
601
|
- **Accept**: application/json
|
|
601
602
|
|
|
602
603
|
|
|
604
|
+
## jobs_by_account
|
|
605
|
+
|
|
606
|
+
> Array<Job> jobs_by_account(account_id, opts)
|
|
607
|
+
|
|
608
|
+
List account jobs
|
|
609
|
+
|
|
610
|
+
List all jobs for the given account.
|
|
611
|
+
|
|
612
|
+
### Example
|
|
613
|
+
|
|
614
|
+
```ruby
|
|
615
|
+
# load the gem
|
|
616
|
+
require 'phrase'
|
|
617
|
+
# setup authorization
|
|
618
|
+
Phrase.configure do |config|
|
|
619
|
+
# Configure HTTP basic authorization: Basic
|
|
620
|
+
config.username = 'YOUR USERNAME'
|
|
621
|
+
config.password = 'YOUR PASSWORD'
|
|
622
|
+
|
|
623
|
+
# Configure API key authorization: Token
|
|
624
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
625
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
626
|
+
end
|
|
627
|
+
|
|
628
|
+
api_instance = Phrase::JobsApi.new
|
|
629
|
+
account_id = 'account_id_example' # String | Account ID
|
|
630
|
+
opts = {
|
|
631
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
632
|
+
page: 1, # Integer | Page number
|
|
633
|
+
per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
|
|
634
|
+
owned_by: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user owning job
|
|
635
|
+
assigned_to: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user assigned to job
|
|
636
|
+
state: 'completed' # String | filter by state of job Valid states are <code>draft</code>, <code>in_progress</code>, <code>completed</code>
|
|
637
|
+
}
|
|
638
|
+
|
|
639
|
+
begin
|
|
640
|
+
#List account jobs
|
|
641
|
+
result = api_instance.jobs_by_account(account_id, opts)
|
|
642
|
+
pp result
|
|
643
|
+
rescue Phrase::ApiError => e
|
|
644
|
+
puts "Exception when calling JobsApi->jobs_by_account: #{e}"
|
|
645
|
+
end
|
|
646
|
+
```
|
|
647
|
+
|
|
648
|
+
### Parameters
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
Name | Type | Description | Notes
|
|
652
|
+
------------- | ------------- | ------------- | -------------
|
|
653
|
+
**account_id** | **String**| Account ID |
|
|
654
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
655
|
+
**page** | **Integer**| Page number | [optional]
|
|
656
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
|
657
|
+
**owned_by** | **String**| filter by user owning job | [optional]
|
|
658
|
+
**assigned_to** | **String**| filter by user assigned to job | [optional]
|
|
659
|
+
**state** | **String**| filter by state of job Valid states are <code>draft</code>, <code>in_progress</code>, <code>completed</code> | [optional]
|
|
660
|
+
|
|
661
|
+
### Return type
|
|
662
|
+
|
|
663
|
+
Response<([**Array<Job>**](Job.md))>
|
|
664
|
+
|
|
665
|
+
### Authorization
|
|
666
|
+
|
|
667
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
668
|
+
|
|
669
|
+
### HTTP request headers
|
|
670
|
+
|
|
671
|
+
- **Content-Type**: Not defined
|
|
672
|
+
- **Accept**: application/json
|
|
673
|
+
|
|
674
|
+
|
|
603
675
|
## jobs_list
|
|
604
676
|
|
|
605
677
|
> Array<Job> jobs_list(project_id, opts)
|
|
@@ -629,7 +701,7 @@ project_id = 'project_id_example' # String | Project ID
|
|
|
629
701
|
opts = {
|
|
630
702
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
631
703
|
page: 1, # Integer | Page number
|
|
632
|
-
per_page:
|
|
704
|
+
per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
|
|
633
705
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
634
706
|
owned_by: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user owning job
|
|
635
707
|
assigned_to: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user assigned to job
|
|
@@ -653,7 +725,7 @@ Name | Type | Description | Notes
|
|
|
653
725
|
**project_id** | **String**| Project ID |
|
|
654
726
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
655
727
|
**page** | **Integer**| Page number | [optional]
|
|
656
|
-
**per_page** | **Integer**| allows you to specify a page size up to 100 items,
|
|
728
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
|
657
729
|
**branch** | **String**| specify the branch to use | [optional]
|
|
658
730
|
**owned_by** | **String**| filter by user owning job | [optional]
|
|
659
731
|
**assigned_to** | **String**| filter by user assigned to job | [optional]
|
data/docs/KeysApi.md
CHANGED
|
@@ -369,7 +369,7 @@ project_id = 'project_id_example' # String | Project ID
|
|
|
369
369
|
opts = {
|
|
370
370
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
371
371
|
page: 1, # Integer | Page number
|
|
372
|
-
per_page:
|
|
372
|
+
per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
|
|
373
373
|
branch: 'my-feature-branch', # String | specify the branch to use
|
|
374
374
|
sort: 'updated_at', # String | Sort by field. Can be one of: name, created_at, updated_at.
|
|
375
375
|
order: 'desc', # String | Order direction. Can be one of: asc, desc.
|
|
@@ -394,7 +394,7 @@ Name | Type | Description | Notes
|
|
|
394
394
|
**project_id** | **String**| Project ID |
|
|
395
395
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
396
396
|
**page** | **Integer**| Page number | [optional]
|
|
397
|
-
**per_page** | **Integer**| allows you to specify a page size up to 100 items,
|
|
397
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
|
398
398
|
**branch** | **String**| specify the branch to use | [optional]
|
|
399
399
|
**sort** | **String**| Sort by field. Can be one of: name, created_at, updated_at. | [optional]
|
|
400
400
|
**order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
|
|
@@ -445,7 +445,7 @@ keys_search_parameters = Phrase::KeysSearchParameters.new # KeysSearchParameters
|
|
|
445
445
|
opts = {
|
|
446
446
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
447
447
|
page: 1, # Integer | Page number
|
|
448
|
-
per_page:
|
|
448
|
+
per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
|
|
449
449
|
}
|
|
450
450
|
|
|
451
451
|
begin
|
|
@@ -466,7 +466,7 @@ Name | Type | Description | Notes
|
|
|
466
466
|
**keys_search_parameters** | [**KeysSearchParameters**](KeysSearchParameters.md)| |
|
|
467
467
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
468
468
|
**page** | **Integer**| Page number | [optional]
|
|
469
|
-
**per_page** | **Integer**| allows you to specify a page size up to 100 items,
|
|
469
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
|
470
470
|
|
|
471
471
|
### Return type
|
|
472
472
|
|
data/docs/LocalesApi.md
CHANGED
|
@@ -389,7 +389,7 @@ project_id = 'project_id_example' # String | Project ID
|
|
|
389
389
|
opts = {
|
|
390
390
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
391
391
|
page: 1, # Integer | Page number
|
|
392
|
-
per_page:
|
|
392
|
+
per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
|
|
393
393
|
branch: 'my-feature-branch' # String | specify the branch to use
|
|
394
394
|
}
|
|
395
395
|
|
|
@@ -410,7 +410,7 @@ Name | Type | Description | Notes
|
|
|
410
410
|
**project_id** | **String**| Project ID |
|
|
411
411
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
412
412
|
**page** | **Integer**| Page number | [optional]
|
|
413
|
-
**per_page** | **Integer**| allows you to specify a page size up to 100 items,
|
|
413
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
|
414
414
|
**branch** | **String**| specify the branch to use | [optional]
|
|
415
415
|
|
|
416
416
|
### Return type
|
data/docs/MembersApi.md
CHANGED
|
@@ -230,7 +230,7 @@ account_id = 'account_id_example' # String | Account ID
|
|
|
230
230
|
opts = {
|
|
231
231
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
232
232
|
page: 1, # Integer | Page number
|
|
233
|
-
per_page:
|
|
233
|
+
per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
|
|
234
234
|
}
|
|
235
235
|
|
|
236
236
|
begin
|
|
@@ -250,7 +250,7 @@ Name | Type | Description | Notes
|
|
|
250
250
|
**account_id** | **String**| Account ID |
|
|
251
251
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
252
252
|
**page** | **Integer**| Page number | [optional]
|
|
253
|
-
**per_page** | **Integer**| allows you to specify a page size up to 100 items,
|
|
253
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
|
254
254
|
|
|
255
255
|
### Return type
|
|
256
256
|
|
data/docs/OrdersApi.md
CHANGED
|
@@ -298,7 +298,7 @@ project_id = 'project_id_example' # String | Project ID
|
|
|
298
298
|
opts = {
|
|
299
299
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
300
300
|
page: 1, # Integer | Page number
|
|
301
|
-
per_page:
|
|
301
|
+
per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
|
|
302
302
|
branch: 'my-feature-branch' # String | specify the branch to use
|
|
303
303
|
}
|
|
304
304
|
|
|
@@ -319,7 +319,7 @@ Name | Type | Description | Notes
|
|
|
319
319
|
**project_id** | **String**| Project ID |
|
|
320
320
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
321
321
|
**page** | **Integer**| Page number | [optional]
|
|
322
|
-
**per_page** | **Integer**| allows you to specify a page size up to 100 items,
|
|
322
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
|
323
323
|
**branch** | **String**| specify the branch to use | [optional]
|
|
324
324
|
|
|
325
325
|
### Return type
|
data/docs/Project.md
CHANGED
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**id** | **String** | | [optional]
|
|
8
8
|
**name** | **String** | | [optional]
|
|
9
|
+
**slug** | **String** | | [optional]
|
|
9
10
|
**main_format** | **String** | | [optional]
|
|
10
11
|
**project_image_url** | **String** | | [optional]
|
|
11
12
|
**account** | [**Account**](Account.md) | | [optional]
|
|
@@ -19,6 +20,7 @@ require 'Phrase'
|
|
|
19
20
|
|
|
20
21
|
instance = Phrase::Project.new(id: null,
|
|
21
22
|
name: null,
|
|
23
|
+
slug: null,
|
|
22
24
|
main_format: null,
|
|
23
25
|
project_image_url: null,
|
|
24
26
|
account: null,
|