phrase 2.0.0 → 2.3.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +41 -3
- data/docs/Account.md +3 -1
- data/docs/AccountDetails.md +5 -1
- data/docs/AccountDetails1.md +3 -1
- data/docs/AccountSearchResult.md +29 -0
- data/docs/Branch.md +5 -1
- data/docs/Comment.md +3 -1
- data/docs/JobCreateParameters.md +2 -0
- data/docs/JobDetails.md +2 -0
- data/docs/JobDetails1.md +2 -0
- data/docs/JobTemplate.md +29 -0
- data/docs/JobTemplateCreateParameters.md +21 -0
- data/docs/JobTemplateLocale.md +23 -0
- data/docs/JobTemplateLocaleUpdateParameters.md +23 -0
- data/docs/JobTemplateLocalesApi.md +347 -0
- data/docs/JobTemplateLocalesCreateParameters.md +23 -0
- data/docs/JobTemplatePreview.md +19 -0
- data/docs/JobTemplateUpdateParameters.md +21 -0
- data/docs/JobTemplateUserPreview.md +23 -0
- data/docs/JobTemplatesApi.md +337 -0
- data/docs/KeysApi.md +132 -4
- data/docs/KeysExcludeParameters.md +23 -0
- data/docs/KeysIncludeParameters.md +23 -0
- data/docs/KeysSearchParameters.md +1 -1
- data/docs/KeysTagParameters.md +1 -1
- data/docs/KeysUntagParameters.md +1 -1
- data/docs/LocalePreview1.md +23 -0
- data/docs/LocalesApi.md +73 -3
- data/docs/MemberSpaces.md +2 -2
- data/docs/MemberUpdateParameters.md +4 -2
- data/docs/Notification.md +41 -0
- data/docs/NotificationGroup.md +23 -0
- data/docs/NotificationGroupDetail.md +27 -0
- data/docs/NotificationGroupsApi.md +194 -0
- data/docs/NotificationsApi.md +194 -0
- data/docs/OrderCreateParameters.md +2 -0
- data/docs/Project.md +2 -0
- data/docs/ProjectCreateParameters.md +35 -1
- data/docs/ProjectDetails.md +2 -0
- data/docs/ProjectsApi.md +7 -1
- data/docs/SearchApi.md +72 -0
- data/docs/SearchInAccountParameters.md +23 -0
- data/docs/Space1.md +25 -0
- data/docs/Subscription.md +19 -0
- data/docs/TranslationOrder.md +2 -0
- data/docs/TranslationsVerifyParameters.md +3 -5
- data/docs/User.md +0 -2
- data/lib/phrase/api/job_template_locales_api.rb +417 -0
- data/lib/phrase/api/job_templates_api.rb +387 -0
- data/lib/phrase/api/keys_api.rb +152 -4
- data/lib/phrase/api/locales_api.rb +80 -2
- data/lib/phrase/api/notification_groups_api.rb +202 -0
- data/lib/phrase/api/notifications_api.rb +202 -0
- data/lib/phrase/api/projects_api.rb +9 -0
- data/lib/phrase/api/search_api.rb +84 -0
- data/lib/phrase/models/account.rb +13 -4
- data/lib/phrase/models/account_details.rb +22 -4
- data/lib/phrase/models/account_details1.rb +10 -1
- data/lib/phrase/models/account_search_result.rb +250 -0
- data/lib/phrase/models/branch.rb +19 -1
- data/lib/phrase/models/comment.rb +15 -4
- data/lib/phrase/models/job_create_parameters.rb +11 -1
- data/lib/phrase/models/job_details.rb +10 -1
- data/lib/phrase/models/job_details1.rb +10 -1
- data/lib/phrase/models/job_template.rb +248 -0
- data/lib/phrase/models/job_template_create_parameters.rb +220 -0
- data/lib/phrase/models/job_template_locale.rb +223 -0
- data/lib/phrase/models/job_template_locale_update_parameters.rb +234 -0
- data/lib/phrase/models/job_template_locales_create_parameters.rb +234 -0
- data/lib/phrase/models/job_template_preview.rb +203 -0
- data/lib/phrase/models/job_template_update_parameters.rb +220 -0
- data/lib/phrase/models/job_template_user_preview.rb +221 -0
- data/lib/phrase/models/keys_exclude_parameters.rb +225 -0
- data/lib/phrase/models/keys_include_parameters.rb +225 -0
- 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/locale_preview1.rb +221 -0
- data/lib/phrase/models/member_spaces.rb +2 -2
- data/lib/phrase/models/member_update_parameters.rb +12 -2
- data/lib/phrase/models/notification.rb +302 -0
- data/lib/phrase/models/notification_group.rb +221 -0
- data/lib/phrase/models/notification_group_detail.rb +239 -0
- data/lib/phrase/models/order_create_parameters.rb +11 -1
- data/lib/phrase/models/project.rb +10 -1
- data/lib/phrase/models/project_create_parameters.rb +174 -4
- data/lib/phrase/models/project_details.rb +10 -1
- data/lib/phrase/models/search_in_account_parameters.rb +225 -0
- data/lib/phrase/models/space1.rb +230 -0
- data/lib/phrase/models/subscription.rb +203 -0
- data/lib/phrase/models/translation_order.rb +10 -1
- data/lib/phrase/models/translations_verify_parameters.rb +14 -24
- data/lib/phrase/models/user.rb +1 -10
- data/lib/phrase/version.rb +1 -1
- data/lib/phrase.rb +23 -0
- data/spec/api/job_template_locales_api_spec.rb +103 -0
- data/spec/api/job_templates_api_spec.rb +98 -0
- data/spec/api/keys_api_spec.rb +30 -2
- data/spec/api/locales_api_spec.rb +18 -1
- data/spec/api/notification_groups_api_spec.rb +62 -0
- data/spec/api/notifications_api_spec.rb +62 -0
- data/spec/api/projects_api_spec.rb +3 -0
- data/spec/api/search_api_spec.rb +37 -0
- data/spec/models/account_details1_spec.rb +6 -0
- data/spec/models/account_details_spec.rb +12 -0
- data/spec/models/account_search_result_spec.rb +65 -0
- data/spec/models/account_spec.rb +6 -0
- data/spec/models/branch_spec.rb +12 -0
- data/spec/models/comment_spec.rb +6 -0
- data/spec/models/job_create_parameters_spec.rb +6 -0
- data/spec/models/job_details1_spec.rb +6 -0
- data/spec/models/job_details_spec.rb +6 -0
- data/spec/models/job_template_create_parameters_spec.rb +41 -0
- data/spec/models/job_template_locale_spec.rb +47 -0
- data/spec/models/job_template_locale_update_parameters_spec.rb +47 -0
- data/spec/models/job_template_locales_create_parameters_spec.rb +47 -0
- data/spec/models/job_template_preview_spec.rb +35 -0
- data/spec/models/job_template_spec.rb +65 -0
- data/spec/models/job_template_update_parameters_spec.rb +41 -0
- data/spec/models/job_template_user_preview_spec.rb +47 -0
- data/spec/models/keys_exclude_parameters_spec.rb +47 -0
- data/spec/models/keys_include_parameters_spec.rb +47 -0
- data/spec/models/locale_preview1_spec.rb +47 -0
- data/spec/models/member_update_parameters_spec.rb +6 -0
- data/spec/models/notification_group_detail_spec.rb +59 -0
- data/spec/models/notification_group_spec.rb +47 -0
- data/spec/models/notification_spec.rb +101 -0
- data/spec/models/order_create_parameters_spec.rb +6 -0
- data/spec/models/project_create_parameters_spec.rb +102 -0
- data/spec/models/project_details_spec.rb +6 -0
- data/spec/models/project_spec.rb +6 -0
- data/spec/models/search_in_account_parameters_spec.rb +47 -0
- data/spec/models/space1_spec.rb +53 -0
- data/spec/models/subscription_spec.rb +35 -0
- data/spec/models/translation_order_spec.rb +6 -0
- data/spec/models/translations_verify_parameters_spec.rb +2 -8
- data/spec/models/user_spec.rb +0 -6
- metadata +262 -170
@@ -0,0 +1,194 @@
|
|
1
|
+
# Phrase::NotificationsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**notifications_list**](NotificationsApi.md#notifications_list) | **GET** /notifications | List notifications
|
8
|
+
[**notifications_mark_all_as_read**](NotificationsApi.md#notifications_mark_all_as_read) | **POST** /notifications/mark_all_as_read | Mark all notifications as read
|
9
|
+
[**notifications_show**](NotificationsApi.md#notifications_show) | **GET** /notifications/{id} | Get a single notification
|
10
|
+
|
11
|
+
|
12
|
+
|
13
|
+
## notifications_list
|
14
|
+
|
15
|
+
> Array<Object> notifications_list(opts)
|
16
|
+
|
17
|
+
List notifications
|
18
|
+
|
19
|
+
List all notifications from the current user
|
20
|
+
|
21
|
+
### Example
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
# load the gem
|
25
|
+
require 'phrase'
|
26
|
+
# setup authorization
|
27
|
+
Phrase.configure do |config|
|
28
|
+
# Configure HTTP basic authorization: Basic
|
29
|
+
config.username = 'YOUR USERNAME'
|
30
|
+
config.password = 'YOUR PASSWORD'
|
31
|
+
|
32
|
+
# Configure API key authorization: Token
|
33
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
34
|
+
config.api_key_prefix['Authorization'] = 'token'
|
35
|
+
end
|
36
|
+
|
37
|
+
api_instance = Phrase::NotificationsApi.new
|
38
|
+
opts = {
|
39
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
40
|
+
page: 1, # Integer | Page number
|
41
|
+
per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
|
42
|
+
}
|
43
|
+
|
44
|
+
begin
|
45
|
+
#List notifications
|
46
|
+
result = api_instance.notifications_list(opts)
|
47
|
+
pp result
|
48
|
+
rescue Phrase::ApiError => e
|
49
|
+
puts "Exception when calling NotificationsApi->notifications_list: #{e}"
|
50
|
+
end
|
51
|
+
```
|
52
|
+
|
53
|
+
### Parameters
|
54
|
+
|
55
|
+
|
56
|
+
Name | Type | Description | Notes
|
57
|
+
------------- | ------------- | ------------- | -------------
|
58
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
59
|
+
**page** | **Integer**| Page number | [optional]
|
60
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
61
|
+
|
62
|
+
### Return type
|
63
|
+
|
64
|
+
Response<(**Array<Object>**)>
|
65
|
+
|
66
|
+
### Authorization
|
67
|
+
|
68
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
69
|
+
|
70
|
+
### HTTP request headers
|
71
|
+
|
72
|
+
- **Content-Type**: Not defined
|
73
|
+
- **Accept**: application/json
|
74
|
+
|
75
|
+
|
76
|
+
## notifications_mark_all_as_read
|
77
|
+
|
78
|
+
> Array<Object> notifications_mark_all_as_read(opts)
|
79
|
+
|
80
|
+
Mark all notifications as read
|
81
|
+
|
82
|
+
Mark all notifications of the current user as read
|
83
|
+
|
84
|
+
### Example
|
85
|
+
|
86
|
+
```ruby
|
87
|
+
# load the gem
|
88
|
+
require 'phrase'
|
89
|
+
# setup authorization
|
90
|
+
Phrase.configure do |config|
|
91
|
+
# Configure HTTP basic authorization: Basic
|
92
|
+
config.username = 'YOUR USERNAME'
|
93
|
+
config.password = 'YOUR PASSWORD'
|
94
|
+
|
95
|
+
# Configure API key authorization: Token
|
96
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
97
|
+
config.api_key_prefix['Authorization'] = 'token'
|
98
|
+
end
|
99
|
+
|
100
|
+
api_instance = Phrase::NotificationsApi.new
|
101
|
+
opts = {
|
102
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
103
|
+
}
|
104
|
+
|
105
|
+
begin
|
106
|
+
#Mark all notifications as read
|
107
|
+
result = api_instance.notifications_mark_all_as_read(opts)
|
108
|
+
pp result
|
109
|
+
rescue Phrase::ApiError => e
|
110
|
+
puts "Exception when calling NotificationsApi->notifications_mark_all_as_read: #{e}"
|
111
|
+
end
|
112
|
+
```
|
113
|
+
|
114
|
+
### Parameters
|
115
|
+
|
116
|
+
|
117
|
+
Name | Type | Description | Notes
|
118
|
+
------------- | ------------- | ------------- | -------------
|
119
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
120
|
+
|
121
|
+
### Return type
|
122
|
+
|
123
|
+
Response<(**Array<Object>**)>
|
124
|
+
|
125
|
+
### Authorization
|
126
|
+
|
127
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
128
|
+
|
129
|
+
### HTTP request headers
|
130
|
+
|
131
|
+
- **Content-Type**: Not defined
|
132
|
+
- **Accept**: application/json
|
133
|
+
|
134
|
+
|
135
|
+
## notifications_show
|
136
|
+
|
137
|
+
> Notification notifications_show(id, opts)
|
138
|
+
|
139
|
+
Get a single notification
|
140
|
+
|
141
|
+
Get details on a single notification.
|
142
|
+
|
143
|
+
### Example
|
144
|
+
|
145
|
+
```ruby
|
146
|
+
# load the gem
|
147
|
+
require 'phrase'
|
148
|
+
# setup authorization
|
149
|
+
Phrase.configure do |config|
|
150
|
+
# Configure HTTP basic authorization: Basic
|
151
|
+
config.username = 'YOUR USERNAME'
|
152
|
+
config.password = 'YOUR PASSWORD'
|
153
|
+
|
154
|
+
# Configure API key authorization: Token
|
155
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
156
|
+
config.api_key_prefix['Authorization'] = 'token'
|
157
|
+
end
|
158
|
+
|
159
|
+
api_instance = Phrase::NotificationsApi.new
|
160
|
+
id = 'id_example' # String | ID
|
161
|
+
opts = {
|
162
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
163
|
+
}
|
164
|
+
|
165
|
+
begin
|
166
|
+
#Get a single notification
|
167
|
+
result = api_instance.notifications_show(id, opts)
|
168
|
+
pp result
|
169
|
+
rescue Phrase::ApiError => e
|
170
|
+
puts "Exception when calling NotificationsApi->notifications_show: #{e}"
|
171
|
+
end
|
172
|
+
```
|
173
|
+
|
174
|
+
### Parameters
|
175
|
+
|
176
|
+
|
177
|
+
Name | Type | Description | Notes
|
178
|
+
------------- | ------------- | ------------- | -------------
|
179
|
+
**id** | **String**| ID |
|
180
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
181
|
+
|
182
|
+
### Return type
|
183
|
+
|
184
|
+
Response<([**Notification**](Notification.md))>
|
185
|
+
|
186
|
+
### Authorization
|
187
|
+
|
188
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
189
|
+
|
190
|
+
### HTTP request headers
|
191
|
+
|
192
|
+
- **Content-Type**: Not defined
|
193
|
+
- **Accept**: application/json
|
194
|
+
|
@@ -5,6 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**branch** | **String** | specify the branch to use | [optional]
|
8
|
+
**name** | **String** | the name of the order, default name is: Translation order from 'current datetime' | [optional]
|
8
9
|
**lsp** | **String** | Name of the LSP that should process this order. Can be one of gengo, textmaster. | [optional]
|
9
10
|
**source_locale_id** | **String** | Source locale for the order. Can be the name or public id of the source locale. Preferred is the public id. | [optional]
|
10
11
|
**target_locale_ids** | **Array<String>** | List of target locales you want the source content translate to. Can be the name or public id of the target locales. Preferred is the public id. | [optional]
|
@@ -25,6 +26,7 @@ Name | Type | Description | Notes
|
|
25
26
|
require 'Phrase'
|
26
27
|
|
27
28
|
instance = Phrase::OrderCreateParameters.new(branch: my-feature-branch,
|
29
|
+
name: Welcome message translations,
|
28
30
|
lsp: textmaster,
|
29
31
|
source_locale_id: abcd1234abcd1234abcd1234abcd1234,
|
30
32
|
target_locale_ids: ["1234abcd1234abcd1234abcd1234abcd","abcd1234abcd1234abcd1234abcd1234"],
|
data/docs/Project.md
CHANGED
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**main_format** | **String** | | [optional]
|
11
11
|
**project_image_url** | **String** | | [optional]
|
12
12
|
**account** | [**Account**](Account.md) | | [optional]
|
13
|
+
**space** | [**Space1**](Space1.md) | | [optional]
|
13
14
|
**created_at** | **DateTime** | | [optional]
|
14
15
|
**updated_at** | **DateTime** | | [optional]
|
15
16
|
|
@@ -24,6 +25,7 @@ instance = Phrase::Project.new(id: null,
|
|
24
25
|
main_format: null,
|
25
26
|
project_image_url: null,
|
26
27
|
account: null,
|
28
|
+
space: null,
|
27
29
|
created_at: null,
|
28
30
|
updated_at: null)
|
29
31
|
```
|
@@ -11,6 +11,23 @@ Name | Type | Description | Notes
|
|
11
11
|
**remove_project_image** | **Boolean** | Indicates whether the project image should be deleted. | [optional]
|
12
12
|
**account_id** | **String** | Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts. | [optional]
|
13
13
|
**source_project_id** | **String** | When a source project ID is given, a clone of that project will be created, including all locales, keys and translations as well as the main project settings if they are not defined otherwise through the params. | [optional]
|
14
|
+
**workflow** | **String** | (Optional) Review Workflow. \"simple\" / \"review\". <a href=\"https://help.phrase.com/help/advanced-review-workflow\">Read more</a> | [optional]
|
15
|
+
**machine_translation_enabled** | **Boolean** | (Optional) Enable machine translation support in the project. Required for Autopilot and Smart Suggest | [optional]
|
16
|
+
**enable_branching** | **Boolean** | (Optional) Enable branching in the project | [optional]
|
17
|
+
**protect_master_branch** | **Boolean** | (Optional) Protect the master branch in project where branching is enabled | [optional]
|
18
|
+
**enable_all_data_type_translation_keys_for_translators** | **Boolean** | (Optional) Otherwise, translators are not allowed to edit translations other than strings | [optional]
|
19
|
+
**enable_icu_message_format** | **Boolean** | (Optional) We can validate and highlight your ICU messages. <a href=\"https://help.phrase.com/help/icu-message-format\">Read more</a> | [optional]
|
20
|
+
**zero_plural_form_enabled** | **Boolean** | (Optional) Displays the input fields for the 'ZERO' plural form for every key as well although only some languages require the 'ZERO' explicitly. | [optional]
|
21
|
+
**autotranslate_enabled** | **Boolean** | (Optional) Autopilot, requires machine_translation_enabled. <a href=\"https://help.phrase.com/help/autopilot\">Read more</a> | [optional]
|
22
|
+
**autotranslate_check_new_translation_keys** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
23
|
+
**autotranslate_check_new_uploads** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
24
|
+
**autotranslate_check_new_locales** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
25
|
+
**autotranslate_mark_as_unverified** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
26
|
+
**autotranslate_use_machine_translation** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
27
|
+
**autotranslate_use_translation_memory** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
|
28
|
+
**smart_suggest_enabled** | **Boolean** | (Optional) Smart Suggest, requires machine_translation_enabled | [optional]
|
29
|
+
**smart_suggest_use_glossary** | **Boolean** | (Optional) Requires smart_suggest_enabled to be true | [optional]
|
30
|
+
**smart_suggest_use_machine_translation** | **Boolean** | (Optional) Requires smart_suggest_enabled to be true | [optional]
|
14
31
|
|
15
32
|
## Code Sample
|
16
33
|
|
@@ -23,7 +40,24 @@ instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
|
|
23
40
|
project_image: null,
|
24
41
|
remove_project_image: null,
|
25
42
|
account_id: abcd1234,
|
26
|
-
source_project_id: abcd1234
|
43
|
+
source_project_id: abcd1234,
|
44
|
+
workflow: review,
|
45
|
+
machine_translation_enabled: true,
|
46
|
+
enable_branching: true,
|
47
|
+
protect_master_branch: true,
|
48
|
+
enable_all_data_type_translation_keys_for_translators: true,
|
49
|
+
enable_icu_message_format: true,
|
50
|
+
zero_plural_form_enabled: true,
|
51
|
+
autotranslate_enabled: true,
|
52
|
+
autotranslate_check_new_translation_keys: true,
|
53
|
+
autotranslate_check_new_uploads: true,
|
54
|
+
autotranslate_check_new_locales: true,
|
55
|
+
autotranslate_mark_as_unverified: true,
|
56
|
+
autotranslate_use_machine_translation: true,
|
57
|
+
autotranslate_use_translation_memory: true,
|
58
|
+
smart_suggest_enabled: true,
|
59
|
+
smart_suggest_use_glossary: true,
|
60
|
+
smart_suggest_use_machine_translation: true)
|
27
61
|
```
|
28
62
|
|
29
63
|
|
data/docs/ProjectDetails.md
CHANGED
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**main_format** | **String** | | [optional]
|
11
11
|
**project_image_url** | **String** | | [optional]
|
12
12
|
**account** | [**Account**](Account.md) | | [optional]
|
13
|
+
**space** | [**Space1**](Space1.md) | | [optional]
|
13
14
|
**created_at** | **DateTime** | | [optional]
|
14
15
|
**updated_at** | **DateTime** | | [optional]
|
15
16
|
**shares_translation_memory** | **Boolean** | | [optional]
|
@@ -25,6 +26,7 @@ instance = Phrase::ProjectDetails.new(id: null,
|
|
25
26
|
main_format: null,
|
26
27
|
project_image_url: null,
|
27
28
|
account: null,
|
29
|
+
space: null,
|
28
30
|
created_at: null,
|
29
31
|
updated_at: null,
|
30
32
|
shares_translation_memory: null)
|
data/docs/ProjectsApi.md
CHANGED
@@ -285,7 +285,10 @@ api_instance = Phrase::ProjectsApi.new
|
|
285
285
|
opts = {
|
286
286
|
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
287
287
|
page: 1, # Integer | Page number
|
288
|
-
per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
|
288
|
+
per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
|
289
|
+
account_id: 'account_id_example', # String | Filter by Account ID
|
290
|
+
sort_by: 'sort_by_example', # String | Sort projects. Valid options are \"name_asc\", \"name_desc\", \"updated_at_asc\", \"updated_at_desc\", \"space_asc\" and \"space_desc\".
|
291
|
+
filters: ['favorites'] # Array<String> | Filter projects. Valid options are [\"favorites\"].
|
289
292
|
}
|
290
293
|
|
291
294
|
begin
|
@@ -305,6 +308,9 @@ Name | Type | Description | Notes
|
|
305
308
|
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
306
309
|
**page** | **Integer**| Page number | [optional]
|
307
310
|
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
311
|
+
**account_id** | **String**| Filter by Account ID | [optional]
|
312
|
+
**sort_by** | **String**| Sort projects. Valid options are \"name_asc\", \"name_desc\", \"updated_at_asc\", \"updated_at_desc\", \"space_asc\" and \"space_desc\". | [optional]
|
313
|
+
**filters** | [**Array<String>**](String.md)| Filter projects. Valid options are [\"favorites\"]. | [optional]
|
308
314
|
|
309
315
|
### Return type
|
310
316
|
|
data/docs/SearchApi.md
ADDED
@@ -0,0 +1,72 @@
|
|
1
|
+
# Phrase::SearchApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**search_in_account**](SearchApi.md#search_in_account) | **POST** /accounts/{account_id}/search | Search across projects
|
8
|
+
|
9
|
+
|
10
|
+
|
11
|
+
## search_in_account
|
12
|
+
|
13
|
+
> AccountSearchResult search_in_account(account_id, search_in_account_parameters, opts)
|
14
|
+
|
15
|
+
Search across projects
|
16
|
+
|
17
|
+
Search for keys and translations in all account projects
|
18
|
+
|
19
|
+
### Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'phrase'
|
24
|
+
# setup authorization
|
25
|
+
Phrase.configure do |config|
|
26
|
+
# Configure HTTP basic authorization: Basic
|
27
|
+
config.username = 'YOUR USERNAME'
|
28
|
+
config.password = 'YOUR PASSWORD'
|
29
|
+
|
30
|
+
# Configure API key authorization: Token
|
31
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
32
|
+
config.api_key_prefix['Authorization'] = 'token'
|
33
|
+
end
|
34
|
+
|
35
|
+
api_instance = Phrase::SearchApi.new
|
36
|
+
account_id = 'account_id_example' # String | Account ID
|
37
|
+
search_in_account_parameters = Phrase::SearchInAccountParameters.new # SearchInAccountParameters |
|
38
|
+
opts = {
|
39
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
40
|
+
}
|
41
|
+
|
42
|
+
begin
|
43
|
+
#Search across projects
|
44
|
+
result = api_instance.search_in_account(account_id, search_in_account_parameters, opts)
|
45
|
+
pp result
|
46
|
+
rescue Phrase::ApiError => e
|
47
|
+
puts "Exception when calling SearchApi->search_in_account: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
### Parameters
|
52
|
+
|
53
|
+
|
54
|
+
Name | Type | Description | Notes
|
55
|
+
------------- | ------------- | ------------- | -------------
|
56
|
+
**account_id** | **String**| Account ID |
|
57
|
+
**search_in_account_parameters** | [**SearchInAccountParameters**](SearchInAccountParameters.md)| |
|
58
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
59
|
+
|
60
|
+
### Return type
|
61
|
+
|
62
|
+
Response<([**AccountSearchResult**](AccountSearchResult.md))>
|
63
|
+
|
64
|
+
### Authorization
|
65
|
+
|
66
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
67
|
+
|
68
|
+
### HTTP request headers
|
69
|
+
|
70
|
+
- **Content-Type**: application/json
|
71
|
+
- **Accept**: application/json
|
72
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# Phrase::SearchInAccountParameters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**query** | **String** | Search query | [optional]
|
8
|
+
**locale_code** | **String** | Locale code | [optional]
|
9
|
+
**page** | **Integer** | Page | [optional]
|
10
|
+
**per_page** | **Integer** | Number of results per page | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'Phrase'
|
16
|
+
|
17
|
+
instance = Phrase::SearchInAccountParameters.new(query: keyword,
|
18
|
+
locale_code: de_DE,
|
19
|
+
page: 1,
|
20
|
+
per_page: 25)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
data/docs/Space1.md
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
# Phrase::Space1
|
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_count** | **Integer** | | [optional]
|
12
|
+
|
13
|
+
## Code Sample
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'Phrase'
|
17
|
+
|
18
|
+
instance = Phrase::Space1.new(id: null,
|
19
|
+
name: null,
|
20
|
+
created_at: null,
|
21
|
+
updated_at: null,
|
22
|
+
projects_count: null)
|
23
|
+
```
|
24
|
+
|
25
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Phrase::Subscription
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**is_current** | **Boolean** | | [optional]
|
8
|
+
**trial_expired** | **Boolean** | | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'Phrase'
|
14
|
+
|
15
|
+
instance = Phrase::Subscription.new(is_current: null,
|
16
|
+
trial_expired: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|