phrase 2.0.0 → 2.1.0
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/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 +68 -2
- 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/User.md +0 -2
- data/lib/phrase.rb +23 -0
- 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 +71 -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_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/user.rb +1 -10
- data/lib/phrase/version.rb +1 -1
- 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 +16 -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_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/user_spec.rb +0 -6
- metadata +268 -176
@@ -0,0 +1,387 @@
|
|
1
|
+
require 'cgi'
|
2
|
+
|
3
|
+
module Phrase
|
4
|
+
class JobTemplatesApi
|
5
|
+
attr_accessor :api_client
|
6
|
+
|
7
|
+
def initialize(api_client = ApiClient.default)
|
8
|
+
@api_client = api_client
|
9
|
+
end
|
10
|
+
# Create a job template
|
11
|
+
# Create a new job template.
|
12
|
+
# @param project_id [String] Project ID
|
13
|
+
# @param job_template_create_parameters [JobTemplateCreateParameters]
|
14
|
+
# @param [Hash] opts the optional parameters
|
15
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
16
|
+
# @return [Object]
|
17
|
+
def job_template_create(project_id, job_template_create_parameters, opts = {})
|
18
|
+
data, _status_code, _headers = job_template_create_with_http_info(project_id, job_template_create_parameters, opts)
|
19
|
+
data
|
20
|
+
end
|
21
|
+
|
22
|
+
# Create a job template
|
23
|
+
# Create a new job template.
|
24
|
+
# @param project_id [String] Project ID
|
25
|
+
# @param job_template_create_parameters [JobTemplateCreateParameters]
|
26
|
+
# @param [Hash] opts the optional parameters
|
27
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
28
|
+
# @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
|
29
|
+
def job_template_create_with_http_info(project_id, job_template_create_parameters, opts = {})
|
30
|
+
if @api_client.config.debugging
|
31
|
+
@api_client.config.logger.debug 'Calling API: JobTemplatesApi.job_template_create ...'
|
32
|
+
end
|
33
|
+
# verify the required parameter 'project_id' is set
|
34
|
+
if @api_client.config.client_side_validation && project_id.nil?
|
35
|
+
fail ArgumentError, "Missing the required parameter 'project_id' when calling JobTemplatesApi.job_template_create"
|
36
|
+
end
|
37
|
+
# verify the required parameter 'job_template_create_parameters' is set
|
38
|
+
if @api_client.config.client_side_validation && job_template_create_parameters.nil?
|
39
|
+
fail ArgumentError, "Missing the required parameter 'job_template_create_parameters' when calling JobTemplatesApi.job_template_create"
|
40
|
+
end
|
41
|
+
# resource path
|
42
|
+
local_var_path = '/projects/{project_id}/job_templates'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
|
43
|
+
|
44
|
+
# query parameters
|
45
|
+
query_params = opts[:query_params] || {}
|
46
|
+
|
47
|
+
# header parameters
|
48
|
+
header_params = opts[:header_params] || {}
|
49
|
+
# HTTP header 'Accept' (if needed)
|
50
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
51
|
+
# HTTP header 'Content-Type'
|
52
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
53
|
+
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
54
|
+
|
55
|
+
# form parameters
|
56
|
+
form_params = opts[:form_params] || {}
|
57
|
+
|
58
|
+
# http body (model)
|
59
|
+
post_body = opts[:body] || @api_client.object_to_http_body(job_template_create_parameters)
|
60
|
+
|
61
|
+
# return_type
|
62
|
+
return_type = opts[:return_type] || 'Object'
|
63
|
+
|
64
|
+
# auth_names
|
65
|
+
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
66
|
+
|
67
|
+
new_options = opts.merge(
|
68
|
+
:header_params => header_params,
|
69
|
+
:query_params => query_params,
|
70
|
+
:form_params => form_params,
|
71
|
+
:body => post_body,
|
72
|
+
:auth_names => auth_names,
|
73
|
+
:return_type => return_type
|
74
|
+
)
|
75
|
+
|
76
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
77
|
+
if @api_client.config.debugging
|
78
|
+
@api_client.config.logger.debug "API called: JobTemplatesApi#job_template_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
79
|
+
end
|
80
|
+
response = ::Phrase::Response.new(data, headers)
|
81
|
+
return response, status_code, headers
|
82
|
+
end
|
83
|
+
|
84
|
+
# Delete a job template
|
85
|
+
# Delete an existing job template.
|
86
|
+
# @param project_id [String] Project ID
|
87
|
+
# @param id [String] ID
|
88
|
+
# @param [Hash] opts the optional parameters
|
89
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
90
|
+
# @option opts [String] :branch specify the branch to use
|
91
|
+
# @return [nil]
|
92
|
+
def job_template_delete(project_id, id, opts = {})
|
93
|
+
data, _status_code, _headers = job_template_delete_with_http_info(project_id, id, opts)
|
94
|
+
data
|
95
|
+
end
|
96
|
+
|
97
|
+
# Delete a job template
|
98
|
+
# Delete an existing job template.
|
99
|
+
# @param project_id [String] Project ID
|
100
|
+
# @param id [String] ID
|
101
|
+
# @param [Hash] opts the optional parameters
|
102
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
103
|
+
# @option opts [String] :branch specify the branch to use
|
104
|
+
# @return [Array<(Response, Integer, Hash)>] Response<(nil, response status code and response headers
|
105
|
+
def job_template_delete_with_http_info(project_id, id, opts = {})
|
106
|
+
if @api_client.config.debugging
|
107
|
+
@api_client.config.logger.debug 'Calling API: JobTemplatesApi.job_template_delete ...'
|
108
|
+
end
|
109
|
+
# verify the required parameter 'project_id' is set
|
110
|
+
if @api_client.config.client_side_validation && project_id.nil?
|
111
|
+
fail ArgumentError, "Missing the required parameter 'project_id' when calling JobTemplatesApi.job_template_delete"
|
112
|
+
end
|
113
|
+
# verify the required parameter 'id' is set
|
114
|
+
if @api_client.config.client_side_validation && id.nil?
|
115
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling JobTemplatesApi.job_template_delete"
|
116
|
+
end
|
117
|
+
# resource path
|
118
|
+
local_var_path = '/projects/{project_id}/job_templates/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
119
|
+
|
120
|
+
# query parameters
|
121
|
+
query_params = opts[:query_params] || {}
|
122
|
+
query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
|
123
|
+
|
124
|
+
# header parameters
|
125
|
+
header_params = opts[:header_params] || {}
|
126
|
+
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
127
|
+
|
128
|
+
# form parameters
|
129
|
+
form_params = opts[:form_params] || {}
|
130
|
+
|
131
|
+
# http body (model)
|
132
|
+
post_body = opts[:body]
|
133
|
+
|
134
|
+
# return_type
|
135
|
+
return_type = opts[:return_type]
|
136
|
+
|
137
|
+
# auth_names
|
138
|
+
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
139
|
+
|
140
|
+
new_options = opts.merge(
|
141
|
+
:header_params => header_params,
|
142
|
+
:query_params => query_params,
|
143
|
+
:form_params => form_params,
|
144
|
+
:body => post_body,
|
145
|
+
:auth_names => auth_names,
|
146
|
+
:return_type => return_type
|
147
|
+
)
|
148
|
+
|
149
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
150
|
+
if @api_client.config.debugging
|
151
|
+
@api_client.config.logger.debug "API called: JobTemplatesApi#job_template_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
152
|
+
end
|
153
|
+
response = ::Phrase::Response.new(data, headers)
|
154
|
+
return response, status_code, headers
|
155
|
+
end
|
156
|
+
|
157
|
+
# Get a single job template
|
158
|
+
# Get details on a single job template for a given project.
|
159
|
+
# @param project_id [String] Project ID
|
160
|
+
# @param id [String] ID
|
161
|
+
# @param [Hash] opts the optional parameters
|
162
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
163
|
+
# @option opts [String] :branch specify the branch to use
|
164
|
+
# @return [Object]
|
165
|
+
def job_template_show(project_id, id, opts = {})
|
166
|
+
data, _status_code, _headers = job_template_show_with_http_info(project_id, id, opts)
|
167
|
+
data
|
168
|
+
end
|
169
|
+
|
170
|
+
# Get a single job template
|
171
|
+
# Get details on a single job template for a given project.
|
172
|
+
# @param project_id [String] Project ID
|
173
|
+
# @param id [String] ID
|
174
|
+
# @param [Hash] opts the optional parameters
|
175
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
176
|
+
# @option opts [String] :branch specify the branch to use
|
177
|
+
# @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
|
178
|
+
def job_template_show_with_http_info(project_id, id, opts = {})
|
179
|
+
if @api_client.config.debugging
|
180
|
+
@api_client.config.logger.debug 'Calling API: JobTemplatesApi.job_template_show ...'
|
181
|
+
end
|
182
|
+
# verify the required parameter 'project_id' is set
|
183
|
+
if @api_client.config.client_side_validation && project_id.nil?
|
184
|
+
fail ArgumentError, "Missing the required parameter 'project_id' when calling JobTemplatesApi.job_template_show"
|
185
|
+
end
|
186
|
+
# verify the required parameter 'id' is set
|
187
|
+
if @api_client.config.client_side_validation && id.nil?
|
188
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling JobTemplatesApi.job_template_show"
|
189
|
+
end
|
190
|
+
# resource path
|
191
|
+
local_var_path = '/projects/{project_id}/job_templates/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
192
|
+
|
193
|
+
# query parameters
|
194
|
+
query_params = opts[:query_params] || {}
|
195
|
+
query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
|
196
|
+
|
197
|
+
# header parameters
|
198
|
+
header_params = opts[:header_params] || {}
|
199
|
+
# HTTP header 'Accept' (if needed)
|
200
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
201
|
+
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
202
|
+
|
203
|
+
# form parameters
|
204
|
+
form_params = opts[:form_params] || {}
|
205
|
+
|
206
|
+
# http body (model)
|
207
|
+
post_body = opts[:body]
|
208
|
+
|
209
|
+
# return_type
|
210
|
+
return_type = opts[:return_type] || 'Object'
|
211
|
+
|
212
|
+
# auth_names
|
213
|
+
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
214
|
+
|
215
|
+
new_options = opts.merge(
|
216
|
+
:header_params => header_params,
|
217
|
+
:query_params => query_params,
|
218
|
+
:form_params => form_params,
|
219
|
+
:body => post_body,
|
220
|
+
:auth_names => auth_names,
|
221
|
+
:return_type => return_type
|
222
|
+
)
|
223
|
+
|
224
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
225
|
+
if @api_client.config.debugging
|
226
|
+
@api_client.config.logger.debug "API called: JobTemplatesApi#job_template_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
227
|
+
end
|
228
|
+
response = ::Phrase::Response.new(data, headers)
|
229
|
+
return response, status_code, headers
|
230
|
+
end
|
231
|
+
|
232
|
+
# Update a job template
|
233
|
+
# Update an existing job template.
|
234
|
+
# @param project_id [String] Project ID
|
235
|
+
# @param id [String] ID
|
236
|
+
# @param job_template_update_parameters [JobTemplateUpdateParameters]
|
237
|
+
# @param [Hash] opts the optional parameters
|
238
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
239
|
+
# @return [Object]
|
240
|
+
def job_template_update(project_id, id, job_template_update_parameters, opts = {})
|
241
|
+
data, _status_code, _headers = job_template_update_with_http_info(project_id, id, job_template_update_parameters, opts)
|
242
|
+
data
|
243
|
+
end
|
244
|
+
|
245
|
+
# Update a job template
|
246
|
+
# Update an existing job template.
|
247
|
+
# @param project_id [String] Project ID
|
248
|
+
# @param id [String] ID
|
249
|
+
# @param job_template_update_parameters [JobTemplateUpdateParameters]
|
250
|
+
# @param [Hash] opts the optional parameters
|
251
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
252
|
+
# @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
|
253
|
+
def job_template_update_with_http_info(project_id, id, job_template_update_parameters, opts = {})
|
254
|
+
if @api_client.config.debugging
|
255
|
+
@api_client.config.logger.debug 'Calling API: JobTemplatesApi.job_template_update ...'
|
256
|
+
end
|
257
|
+
# verify the required parameter 'project_id' is set
|
258
|
+
if @api_client.config.client_side_validation && project_id.nil?
|
259
|
+
fail ArgumentError, "Missing the required parameter 'project_id' when calling JobTemplatesApi.job_template_update"
|
260
|
+
end
|
261
|
+
# verify the required parameter 'id' is set
|
262
|
+
if @api_client.config.client_side_validation && id.nil?
|
263
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling JobTemplatesApi.job_template_update"
|
264
|
+
end
|
265
|
+
# verify the required parameter 'job_template_update_parameters' is set
|
266
|
+
if @api_client.config.client_side_validation && job_template_update_parameters.nil?
|
267
|
+
fail ArgumentError, "Missing the required parameter 'job_template_update_parameters' when calling JobTemplatesApi.job_template_update"
|
268
|
+
end
|
269
|
+
# resource path
|
270
|
+
local_var_path = '/projects/{project_id}/job_templates/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
271
|
+
|
272
|
+
# query parameters
|
273
|
+
query_params = opts[:query_params] || {}
|
274
|
+
|
275
|
+
# header parameters
|
276
|
+
header_params = opts[:header_params] || {}
|
277
|
+
# HTTP header 'Accept' (if needed)
|
278
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
279
|
+
# HTTP header 'Content-Type'
|
280
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
281
|
+
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
282
|
+
|
283
|
+
# form parameters
|
284
|
+
form_params = opts[:form_params] || {}
|
285
|
+
|
286
|
+
# http body (model)
|
287
|
+
post_body = opts[:body] || @api_client.object_to_http_body(job_template_update_parameters)
|
288
|
+
|
289
|
+
# return_type
|
290
|
+
return_type = opts[:return_type] || 'Object'
|
291
|
+
|
292
|
+
# auth_names
|
293
|
+
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
294
|
+
|
295
|
+
new_options = opts.merge(
|
296
|
+
:header_params => header_params,
|
297
|
+
:query_params => query_params,
|
298
|
+
:form_params => form_params,
|
299
|
+
:body => post_body,
|
300
|
+
:auth_names => auth_names,
|
301
|
+
:return_type => return_type
|
302
|
+
)
|
303
|
+
|
304
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
305
|
+
if @api_client.config.debugging
|
306
|
+
@api_client.config.logger.debug "API called: JobTemplatesApi#job_template_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
307
|
+
end
|
308
|
+
response = ::Phrase::Response.new(data, headers)
|
309
|
+
return response, status_code, headers
|
310
|
+
end
|
311
|
+
|
312
|
+
# List job templates
|
313
|
+
# List all job templates for the given project.
|
314
|
+
# @param project_id [String] Project ID
|
315
|
+
# @param [Hash] opts the optional parameters
|
316
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
317
|
+
# @option opts [Integer] :page Page number
|
318
|
+
# @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
|
319
|
+
# @option opts [String] :branch specify the branch to use
|
320
|
+
# @return [Array<JobTemplate>]
|
321
|
+
def job_templates_list(project_id, opts = {})
|
322
|
+
data, _status_code, _headers = job_templates_list_with_http_info(project_id, opts)
|
323
|
+
data
|
324
|
+
end
|
325
|
+
|
326
|
+
# List job templates
|
327
|
+
# List all job templates for the given project.
|
328
|
+
# @param project_id [String] Project ID
|
329
|
+
# @param [Hash] opts the optional parameters
|
330
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
331
|
+
# @option opts [Integer] :page Page number
|
332
|
+
# @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
|
333
|
+
# @option opts [String] :branch specify the branch to use
|
334
|
+
# @return [Array<(Response<(Array<JobTemplate>)>, Integer, Hash)>] Response<(Array<JobTemplate>)> data, response status code and response headers
|
335
|
+
def job_templates_list_with_http_info(project_id, opts = {})
|
336
|
+
if @api_client.config.debugging
|
337
|
+
@api_client.config.logger.debug 'Calling API: JobTemplatesApi.job_templates_list ...'
|
338
|
+
end
|
339
|
+
# verify the required parameter 'project_id' is set
|
340
|
+
if @api_client.config.client_side_validation && project_id.nil?
|
341
|
+
fail ArgumentError, "Missing the required parameter 'project_id' when calling JobTemplatesApi.job_templates_list"
|
342
|
+
end
|
343
|
+
# resource path
|
344
|
+
local_var_path = '/projects/{project_id}/job_templates'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
|
345
|
+
|
346
|
+
# query parameters
|
347
|
+
query_params = opts[:query_params] || {}
|
348
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
349
|
+
query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
|
350
|
+
query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
|
351
|
+
|
352
|
+
# header parameters
|
353
|
+
header_params = opts[:header_params] || {}
|
354
|
+
# HTTP header 'Accept' (if needed)
|
355
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
356
|
+
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
357
|
+
|
358
|
+
# form parameters
|
359
|
+
form_params = opts[:form_params] || {}
|
360
|
+
|
361
|
+
# http body (model)
|
362
|
+
post_body = opts[:body]
|
363
|
+
|
364
|
+
# return_type
|
365
|
+
return_type = opts[:return_type] || 'Array<JobTemplate>'
|
366
|
+
|
367
|
+
# auth_names
|
368
|
+
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
369
|
+
|
370
|
+
new_options = opts.merge(
|
371
|
+
:header_params => header_params,
|
372
|
+
:query_params => query_params,
|
373
|
+
:form_params => form_params,
|
374
|
+
:body => post_body,
|
375
|
+
:auth_names => auth_names,
|
376
|
+
:return_type => return_type
|
377
|
+
)
|
378
|
+
|
379
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
380
|
+
if @api_client.config.debugging
|
381
|
+
@api_client.config.logger.debug "API called: JobTemplatesApi#job_templates_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
382
|
+
end
|
383
|
+
response = ::Phrase::Response.new(data, headers)
|
384
|
+
return response, status_code, headers
|
385
|
+
end
|
386
|
+
end
|
387
|
+
end
|
data/lib/phrase/api/keys_api.rb
CHANGED
@@ -315,7 +315,7 @@ module Phrase
|
|
315
315
|
# @param [Hash] opts the optional parameters
|
316
316
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
317
317
|
# @option opts [String] :branch specify the branch to use
|
318
|
-
# @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names -
|
318
|
+
# @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
319
319
|
# @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
320
320
|
# @return [AffectedResources]
|
321
321
|
def keys_delete_collection(project_id, opts = {})
|
@@ -329,7 +329,7 @@ module Phrase
|
|
329
329
|
# @param [Hash] opts the optional parameters
|
330
330
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
331
331
|
# @option opts [String] :branch specify the branch to use
|
332
|
-
# @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names -
|
332
|
+
# @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
333
333
|
# @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
334
334
|
# @return [Array<(Response<(AffectedResources)>, Integer, Hash)>] Response<(AffectedResources)> data, response status code and response headers
|
335
335
|
def keys_delete_collection_with_http_info(project_id, opts = {})
|
@@ -384,6 +384,154 @@ module Phrase
|
|
384
384
|
return response, status_code, headers
|
385
385
|
end
|
386
386
|
|
387
|
+
# Exclude a locale on a collection of keys
|
388
|
+
# Exclude a locale on keys matching query. Same constraints as list.
|
389
|
+
# @param project_id [String] Project ID
|
390
|
+
# @param keys_exclude_parameters [KeysExcludeParameters]
|
391
|
+
# @param [Hash] opts the optional parameters
|
392
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
393
|
+
# @return [AffectedResources]
|
394
|
+
def keys_exclude(project_id, keys_exclude_parameters, opts = {})
|
395
|
+
data, _status_code, _headers = keys_exclude_with_http_info(project_id, keys_exclude_parameters, opts)
|
396
|
+
data
|
397
|
+
end
|
398
|
+
|
399
|
+
# Exclude a locale on a collection of keys
|
400
|
+
# Exclude a locale on keys matching query. Same constraints as list.
|
401
|
+
# @param project_id [String] Project ID
|
402
|
+
# @param keys_exclude_parameters [KeysExcludeParameters]
|
403
|
+
# @param [Hash] opts the optional parameters
|
404
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
405
|
+
# @return [Array<(Response<(AffectedResources)>, Integer, Hash)>] Response<(AffectedResources)> data, response status code and response headers
|
406
|
+
def keys_exclude_with_http_info(project_id, keys_exclude_parameters, opts = {})
|
407
|
+
if @api_client.config.debugging
|
408
|
+
@api_client.config.logger.debug 'Calling API: KeysApi.keys_exclude ...'
|
409
|
+
end
|
410
|
+
# verify the required parameter 'project_id' is set
|
411
|
+
if @api_client.config.client_side_validation && project_id.nil?
|
412
|
+
fail ArgumentError, "Missing the required parameter 'project_id' when calling KeysApi.keys_exclude"
|
413
|
+
end
|
414
|
+
# verify the required parameter 'keys_exclude_parameters' is set
|
415
|
+
if @api_client.config.client_side_validation && keys_exclude_parameters.nil?
|
416
|
+
fail ArgumentError, "Missing the required parameter 'keys_exclude_parameters' when calling KeysApi.keys_exclude"
|
417
|
+
end
|
418
|
+
# resource path
|
419
|
+
local_var_path = '/projects/{project_id}/keys/exclude'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
|
420
|
+
|
421
|
+
# query parameters
|
422
|
+
query_params = opts[:query_params] || {}
|
423
|
+
|
424
|
+
# header parameters
|
425
|
+
header_params = opts[:header_params] || {}
|
426
|
+
# HTTP header 'Accept' (if needed)
|
427
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
428
|
+
# HTTP header 'Content-Type'
|
429
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
430
|
+
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
431
|
+
|
432
|
+
# form parameters
|
433
|
+
form_params = opts[:form_params] || {}
|
434
|
+
|
435
|
+
# http body (model)
|
436
|
+
post_body = opts[:body] || @api_client.object_to_http_body(keys_exclude_parameters)
|
437
|
+
|
438
|
+
# return_type
|
439
|
+
return_type = opts[:return_type] || 'AffectedResources'
|
440
|
+
|
441
|
+
# auth_names
|
442
|
+
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
443
|
+
|
444
|
+
new_options = opts.merge(
|
445
|
+
:header_params => header_params,
|
446
|
+
:query_params => query_params,
|
447
|
+
:form_params => form_params,
|
448
|
+
:body => post_body,
|
449
|
+
:auth_names => auth_names,
|
450
|
+
:return_type => return_type
|
451
|
+
)
|
452
|
+
|
453
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
454
|
+
if @api_client.config.debugging
|
455
|
+
@api_client.config.logger.debug "API called: KeysApi#keys_exclude\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
456
|
+
end
|
457
|
+
response = ::Phrase::Response.new(data, headers)
|
458
|
+
return response, status_code, headers
|
459
|
+
end
|
460
|
+
|
461
|
+
# Include a locale on a collection of keys
|
462
|
+
# Include a locale on keys matching query. Same constraints as list.
|
463
|
+
# @param project_id [String] Project ID
|
464
|
+
# @param keys_include_parameters [KeysIncludeParameters]
|
465
|
+
# @param [Hash] opts the optional parameters
|
466
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
467
|
+
# @return [AffectedResources]
|
468
|
+
def keys_include(project_id, keys_include_parameters, opts = {})
|
469
|
+
data, _status_code, _headers = keys_include_with_http_info(project_id, keys_include_parameters, opts)
|
470
|
+
data
|
471
|
+
end
|
472
|
+
|
473
|
+
# Include a locale on a collection of keys
|
474
|
+
# Include a locale on keys matching query. Same constraints as list.
|
475
|
+
# @param project_id [String] Project ID
|
476
|
+
# @param keys_include_parameters [KeysIncludeParameters]
|
477
|
+
# @param [Hash] opts the optional parameters
|
478
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
479
|
+
# @return [Array<(Response<(AffectedResources)>, Integer, Hash)>] Response<(AffectedResources)> data, response status code and response headers
|
480
|
+
def keys_include_with_http_info(project_id, keys_include_parameters, opts = {})
|
481
|
+
if @api_client.config.debugging
|
482
|
+
@api_client.config.logger.debug 'Calling API: KeysApi.keys_include ...'
|
483
|
+
end
|
484
|
+
# verify the required parameter 'project_id' is set
|
485
|
+
if @api_client.config.client_side_validation && project_id.nil?
|
486
|
+
fail ArgumentError, "Missing the required parameter 'project_id' when calling KeysApi.keys_include"
|
487
|
+
end
|
488
|
+
# verify the required parameter 'keys_include_parameters' is set
|
489
|
+
if @api_client.config.client_side_validation && keys_include_parameters.nil?
|
490
|
+
fail ArgumentError, "Missing the required parameter 'keys_include_parameters' when calling KeysApi.keys_include"
|
491
|
+
end
|
492
|
+
# resource path
|
493
|
+
local_var_path = '/projects/{project_id}/keys/include'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
|
494
|
+
|
495
|
+
# query parameters
|
496
|
+
query_params = opts[:query_params] || {}
|
497
|
+
|
498
|
+
# header parameters
|
499
|
+
header_params = opts[:header_params] || {}
|
500
|
+
# HTTP header 'Accept' (if needed)
|
501
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
502
|
+
# HTTP header 'Content-Type'
|
503
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
504
|
+
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
505
|
+
|
506
|
+
# form parameters
|
507
|
+
form_params = opts[:form_params] || {}
|
508
|
+
|
509
|
+
# http body (model)
|
510
|
+
post_body = opts[:body] || @api_client.object_to_http_body(keys_include_parameters)
|
511
|
+
|
512
|
+
# return_type
|
513
|
+
return_type = opts[:return_type] || 'AffectedResources'
|
514
|
+
|
515
|
+
# auth_names
|
516
|
+
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
517
|
+
|
518
|
+
new_options = opts.merge(
|
519
|
+
:header_params => header_params,
|
520
|
+
:query_params => query_params,
|
521
|
+
:form_params => form_params,
|
522
|
+
:body => post_body,
|
523
|
+
:auth_names => auth_names,
|
524
|
+
:return_type => return_type
|
525
|
+
)
|
526
|
+
|
527
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
528
|
+
if @api_client.config.debugging
|
529
|
+
@api_client.config.logger.debug "API called: KeysApi#keys_include\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
530
|
+
end
|
531
|
+
response = ::Phrase::Response.new(data, headers)
|
532
|
+
return response, status_code, headers
|
533
|
+
end
|
534
|
+
|
387
535
|
# List keys
|
388
536
|
# List all keys for the given project. Alternatively you can POST requests to /search.
|
389
537
|
# @param project_id [String] Project ID
|
@@ -394,7 +542,7 @@ module Phrase
|
|
394
542
|
# @option opts [String] :branch specify the branch to use
|
395
543
|
# @option opts [String] :sort Sort by field. Can be one of: name, created_at, updated_at.
|
396
544
|
# @option opts [String] :order Order direction. Can be one of: asc, desc.
|
397
|
-
# @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names -
|
545
|
+
# @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
398
546
|
# @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
399
547
|
# @return [Array<TranslationKey>]
|
400
548
|
def keys_list(project_id, opts = {})
|
@@ -412,7 +560,7 @@ module Phrase
|
|
412
560
|
# @option opts [String] :branch specify the branch to use
|
413
561
|
# @option opts [String] :sort Sort by field. Can be one of: name, created_at, updated_at.
|
414
562
|
# @option opts [String] :order Order direction. Can be one of: asc, desc.
|
415
|
-
# @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names -
|
563
|
+
# @option opts [String] :q Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
|
416
564
|
# @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
|
417
565
|
# @return [Array<(Response<(Array<TranslationKey>)>, Integer, Hash)>] Response<(Array<TranslationKey>)> data, response status code and response headers
|
418
566
|
def keys_list_with_http_info(project_id, opts = {})
|