Class: Phrase::ScreenshotsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/phrase/api/screenshots_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ScreenshotsApi

Returns a new instance of ScreenshotsApi.



7
8
9
 
# File 'lib/phrase/api/screenshots_api.rb', line 7

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/phrase/api/screenshots_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#screenshot_create(project_id, filename, opts = {}) ⇒ Screenshot

Create a screenshot Creates a screenshot in a project to provide visual context for in-context translation. Attach translation keys to regions of the uploaded image so translators can see where each string appears in your UI. This endpoint accepts a multipart/form-data request with a binary file upload, unlike most Phrase API endpoints that use JSON. Use a multipart form client or the -F flag in curl rather than a JSON body. The screenshot name must be unique within the project (case-insensitive). When name is omitted, it is derived from the uploaded filename. The account must have the Screenshots feature enabled; requests to projects on accounts without it return 403. Creating a screenshot requires a token with the write scope and manage access to the project.

Parameters:

  • project_id (String) —

    Project ID

  • filename (File) —

    Image file to upload. Accepted formats are JPEG (jpg/jpeg), GIF, and PNG. Maximum file size is 10 MB. Submitting an unsupported format or a file exceeding the size limit returns 422.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

  • :name (String) —

    Display name for the screenshot. Must be unique within the project (case-insensitive). When omitted, the name is derived from the uploaded filename.

  • :description (String) —

    Optional free-text description of the screenshot.

Returns:



20
21
22
23
 
# File 'lib/phrase/api/screenshots_api.rb', line 20

def screenshot_create(project_id, filename, opts = {})
  data, _status_code, _headers = screenshot_create_with_http_info(project_id, filename, opts)
  data
end

#screenshot_create_with_http_info(project_id, filename, opts = {}) ⇒ Array<(Response<(Screenshot)>, Integer, Hash)>

Create a screenshot Creates a screenshot in a project to provide visual context for in-context translation. Attach translation keys to regions of the uploaded image so translators can see where each string appears in your UI. This endpoint accepts a multipart/form-data request with a binary file upload, unlike most Phrase API endpoints that use JSON. Use a multipart form client or the -F flag in curl rather than a JSON body. The screenshot name must be unique within the project (case-insensitive). When name is omitted, it is derived from the uploaded filename. The account must have the Screenshots feature enabled; requests to projects on accounts without it return 403. Creating a screenshot requires a token with the write scope and manage access to the project.

Parameters:

  • project_id (String) —

    Project ID

  • filename (File) —

    Image file to upload. Accepted formats are JPEG (jpg/jpeg), GIF, and PNG. Maximum file size is 10 MB. Submitting an unsupported format or a file exceeding the size limit returns 422.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

  • :name (String) —

    Display name for the screenshot. Must be unique within the project (case-insensitive). When omitted, the name is derived from the uploaded filename.

  • :description (String) —

    Optional free-text description of the screenshot.

Returns:

  • (Array<(Response<(Screenshot)>, Integer, Hash)>) —

    Response<(Screenshot)> data, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/phrase/api/screenshots_api.rb', line 35

def screenshot_create_with_http_info(project_id, filename, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScreenshotsApi.screenshot_create ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ScreenshotsApi.screenshot_create"
  end
  # verify the required parameter 'filename' is set
  if @api_client.config.client_side_validation && filename.nil?
    fail ArgumentError, "Missing the required parameter 'filename' when calling ScreenshotsApi.screenshot_create"
  end
  # resource path
  local_var_path = '/projects/{project_id}/screenshots'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['filename'] = filename
  form_params['branch'] = opts[:'branch'] if !opts[:'branch'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['description'] = opts[:'description'] if !opts[:'description'].nil?

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Screenshot' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScreenshotsApi#screenshot_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#screenshot_delete(project_id, id, opts = {}) ⇒ nil

Delete a screenshot Delete an existing screenshot.

Parameters:

  • project_id (String) —

    Project ID

  • id (String) —

    ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:

  • (nil) 


102
103
104
105
 
# File 'lib/phrase/api/screenshots_api.rb', line 102

def screenshot_delete(project_id, id, opts = {})
  data, _status_code, _headers = screenshot_delete_with_http_info(project_id, id, opts)
  data
end

#screenshot_delete_with_http_info(project_id, id, opts = {}) ⇒ Array<(Response, Integer, Hash)>

Delete a screenshot Delete an existing screenshot.

Parameters:

  • project_id (String) —

    Project ID

  • id (String) —

    ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:

  • (Array<(Response, Integer, Hash)>) —

    Response<(nil, response status code and response headers



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/phrase/api/screenshots_api.rb', line 115

def screenshot_delete_with_http_info(project_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScreenshotsApi.screenshot_delete ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ScreenshotsApi.screenshot_delete"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ScreenshotsApi.screenshot_delete"
  end
  # resource path
  local_var_path = '/projects/{project_id}/screenshots/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScreenshotsApi#screenshot_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#screenshot_show(project_id, id, opts = {}) ⇒ Screenshot

Get a single screenshot Get details on a single screenshot for a given project.

Parameters:

  • project_id (String) —

    Project ID

  • id (String) —

    ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:



177
178
179
180
 
# File 'lib/phrase/api/screenshots_api.rb', line 177

def screenshot_show(project_id, id, opts = {})
  data, _status_code, _headers = screenshot_show_with_http_info(project_id, id, opts)
  data
end

#screenshot_show_with_http_info(project_id, id, opts = {}) ⇒ Array<(Response<(Screenshot)>, Integer, Hash)>

Get a single screenshot Get details on a single screenshot for a given project.

Parameters:

  • project_id (String) —

    Project ID

  • id (String) —

    ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:

  • (Array<(Response<(Screenshot)>, Integer, Hash)>) —

    Response<(Screenshot)> data, response status code and response headers



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/phrase/api/screenshots_api.rb', line 190

def screenshot_show_with_http_info(project_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScreenshotsApi.screenshot_show ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ScreenshotsApi.screenshot_show"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ScreenshotsApi.screenshot_show"
  end
  # resource path
  local_var_path = '/projects/{project_id}/screenshots/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Screenshot' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScreenshotsApi#screenshot_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#screenshot_update(project_id, id, screenshot_update_parameters, opts = {}) ⇒ Screenshot

Update a screenshot Update an existing screenshot.

Parameters:

  • project_id (String) —

    Project ID

  • id (String) —

    ID

  • screenshot_update_parameters (ScreenshotUpdateParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



252
253
254
255
 
# File 'lib/phrase/api/screenshots_api.rb', line 252

def screenshot_update(project_id, id, screenshot_update_parameters, opts = {})
  data, _status_code, _headers = screenshot_update_with_http_info(project_id, id, screenshot_update_parameters, opts)
  data
end

#screenshot_update_with_http_info(project_id, id, screenshot_update_parameters, opts = {}) ⇒ Array<(Response<(Screenshot)>, Integer, Hash)>

Update a screenshot Update an existing screenshot.

Parameters:

  • project_id (String) —

    Project ID

  • id (String) —

    ID

  • screenshot_update_parameters (ScreenshotUpdateParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (Array<(Response<(Screenshot)>, Integer, Hash)>) —

    Response<(Screenshot)> data, response status code and response headers



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/phrase/api/screenshots_api.rb', line 265

def screenshot_update_with_http_info(project_id, id, screenshot_update_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScreenshotsApi.screenshot_update ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ScreenshotsApi.screenshot_update"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ScreenshotsApi.screenshot_update"
  end
  # verify the required parameter 'screenshot_update_parameters' is set
  if @api_client.config.client_side_validation && screenshot_update_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'screenshot_update_parameters' when calling ScreenshotsApi.screenshot_update"
  end
  # resource path
  local_var_path = '/projects/{project_id}/screenshots/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(screenshot_update_parameters) 

  # return_type
  return_type = opts[:return_type] || 'Screenshot' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScreenshotsApi#screenshot_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#screenshots_list(project_id, opts = {}) ⇒ Array<Screenshot>

List screenshots List all screenshots for the given project.

Parameters:

  • project_id (String) —

    Project ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :page (Integer) —

    Page number

  • :per_page (Integer) —

    Limit on the number of objects to be returned, between 1 and 100. 25 by default

  • :branch (String) —

    specify the branch to use

  • :key_id (String) —

    filter by key

Returns:



334
335
336
337
 
# File 'lib/phrase/api/screenshots_api.rb', line 334

def screenshots_list(project_id, opts = {})
  data, _status_code, _headers = screenshots_list_with_http_info(project_id, opts)
  data
end

#screenshots_list_with_http_info(project_id, opts = {}) ⇒ Array<(Response<(Array<Screenshot>)>, Integer, Hash)>

List screenshots List all screenshots for the given project.

Parameters:

  • project_id (String) —

    Project ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :page (Integer) —

    Page number

  • :per_page (Integer) —

    Limit on the number of objects to be returned, between 1 and 100. 25 by default

  • :branch (String) —

    specify the branch to use

  • :key_id (String) —

    filter by key

Returns:

  • (Array<(Response<(Array<Screenshot>)>, Integer, Hash)>) —

    Response<(Array<Screenshot>)> data, response status code and response headers



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/phrase/api/screenshots_api.rb', line 349

def screenshots_list_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScreenshotsApi.screenshots_list ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ScreenshotsApi.screenshots_list"
  end
  # resource path
  local_var_path = '/projects/{project_id}/screenshots'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
  query_params[:'key_id'] = opts[:'key_id'] if !opts[:'key_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Array<Screenshot>' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScreenshotsApi#screenshots_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end