Class: Phrase::CustomMetadataApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CustomMetadataApi

Returns a new instance of CustomMetadataApi.



7
8
9
 
# File 'lib/phrase/api/custom_metadata_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/custom_metadata_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#custom_metadata_properties_delete(account_id, id, opts = {}) ⇒ nil

Destroy property Destroy a custom metadata property of an account. This endpoint is only available to accounts with advanced plans or above.

Parameters:

  • account_id (String) —

    Account ID

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (nil) 


17
18
19
20
 
# File 'lib/phrase/api/custom_metadata_api.rb', line 17

def custom_metadata_properties_delete(, id, opts = {})
  data, _status_code, _headers = custom_metadata_properties_delete_with_http_info(, id, opts)
  data
end

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

Destroy property Destroy a custom metadata property of an account. This endpoint is only available to accounts with advanced plans or above.

Parameters:

  • account_id (String) —

    Account ID

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

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

    Response<(nil, response status code and response headers



29
30
31
32
33
34
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
 
# File 'lib/phrase/api/custom_metadata_api.rb', line 29

def custom_metadata_properties_delete_with_http_info(, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomMetadataApi.custom_metadata_properties_delete ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling CustomMetadataApi.custom_metadata_properties_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 CustomMetadataApi.custom_metadata_properties_delete"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/custom_metadata/properties/{id}'.sub('{' + 'account_id' + '}', CGI.escape(.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  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: CustomMetadataApi#custom_metadata_properties_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#custom_metadata_properties_list(account_id, opts = {}) ⇒ Array<CustomMetadataProperty>

List properties List all custom metadata properties for an account. This endpoint is only available to accounts with advanced plans or above.

Parameters:

  • account_id (String) —

    Account ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :data_type (CustomMetadataDataType) —

    Data Type of Custom Metadata Property

  • :project_id (String) —

    id of project that the properties belong to

  • :page (Integer) —

    Page number

  • :per_page (Integer) —

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

  • :q (String) —

    query to find a property by name

  • :sort (String) —

    Sort criteria. Can be one of: name, data_type, created_at.

  • :order (String) —

    Order direction. Can be one of: asc, desc.

Returns:



93
94
95
96
 
# File 'lib/phrase/api/custom_metadata_api.rb', line 93

def custom_metadata_properties_list(, opts = {})
  data, _status_code, _headers = custom_metadata_properties_list_with_http_info(, opts)
  data
end

#custom_metadata_properties_list_with_http_info(account_id, opts = {}) ⇒ Array<(Response<(Array<CustomMetadataProperty>)>, Integer, Hash)>

List properties List all custom metadata properties for an account. This endpoint is only available to accounts with advanced plans or above.

Parameters:

  • account_id (String) —

    Account ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :data_type (CustomMetadataDataType) —

    Data Type of Custom Metadata Property

  • :project_id (String) —

    id of project that the properties belong to

  • :page (Integer) —

    Page number

  • :per_page (Integer) —

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

  • :q (String) —

    query to find a property by name

  • :sort (String) —

    Sort criteria. Can be one of: name, data_type, created_at.

  • :order (String) —

    Order direction. Can be one of: asc, desc.

Returns:

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

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



111
112
113
114
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
 
# File 'lib/phrase/api/custom_metadata_api.rb', line 111

def custom_metadata_properties_list_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomMetadataApi.custom_metadata_properties_list ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling CustomMetadataApi.custom_metadata_properties_list"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/custom_metadata/properties'.sub('{' + 'account_id' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'data_type'] = opts[:'data_type'] if !opts[:'data_type'].nil?
  query_params[:'project_id'] = opts[:'project_id'] if !opts[:'project_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].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<CustomMetadataProperty>' 

  # 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: CustomMetadataApi#custom_metadata_properties_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#custom_metadata_property_create(account_id, custom_metadata_properties_create_parameters, opts = {}) ⇒ CustomMetadataProperty

Create a property Create a new custom metadata property.

Parameters:

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



174
175
176
177
 
# File 'lib/phrase/api/custom_metadata_api.rb', line 174

def custom_metadata_property_create(, custom_metadata_properties_create_parameters, opts = {})
  data, _status_code, _headers = custom_metadata_property_create_with_http_info(, custom_metadata_properties_create_parameters, opts)
  data
end

#custom_metadata_property_create_with_http_info(account_id, custom_metadata_properties_create_parameters, opts = {}) ⇒ Array<(Response<(CustomMetadataProperty)>, Integer, Hash)>

Create a property Create a new custom metadata property.

Parameters:

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



186
187
188
189
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
 
# File 'lib/phrase/api/custom_metadata_api.rb', line 186

def custom_metadata_property_create_with_http_info(, custom_metadata_properties_create_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomMetadataApi.custom_metadata_property_create ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling CustomMetadataApi.custom_metadata_property_create"
  end
  # verify the required parameter 'custom_metadata_properties_create_parameters' is set
  if @api_client.config.client_side_validation && custom_metadata_properties_create_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'custom_metadata_properties_create_parameters' when calling CustomMetadataApi.custom_metadata_property_create"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/custom_metadata/properties'.sub('{' + 'account_id' + '}', CGI.escape(.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(custom_metadata_properties_create_parameters) 

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

  # 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: CustomMetadataApi#custom_metadata_property_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#custom_metadata_property_show(account_id, id, opts = {}) ⇒ CustomMetadataProperty

Get a single property Get details of a single custom property.

Parameters:

  • account_id (String) —

    Account ID

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



248
249
250
251
 
# File 'lib/phrase/api/custom_metadata_api.rb', line 248

def custom_metadata_property_show(, id, opts = {})
  data, _status_code, _headers = custom_metadata_property_show_with_http_info(, id, opts)
  data
end

#custom_metadata_property_show_with_http_info(account_id, id, opts = {}) ⇒ Array<(Response<(CustomMetadataProperty)>, Integer, Hash)>

Get a single property Get details of a single custom property.

Parameters:

  • account_id (String) —

    Account ID

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



260
261
262
263
264
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
 
# File 'lib/phrase/api/custom_metadata_api.rb', line 260

def custom_metadata_property_show_with_http_info(, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomMetadataApi.custom_metadata_property_show ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling CustomMetadataApi.custom_metadata_property_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 CustomMetadataApi.custom_metadata_property_show"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/custom_metadata/properties/{id}'.sub('{' + 'account_id' + '}', CGI.escape(.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'])
  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] || 'CustomMetadataProperty' 

  # 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: CustomMetadataApi#custom_metadata_property_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#custom_metadata_property_update(account_id, id, custom_metadata_properties_update_parameters, opts = {}) ⇒ CustomMetadataProperty

Update a property Update an existing custom metadata property.

Parameters:

  • account_id (String) —

    Account ID

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



321
322
323
324
 
# File 'lib/phrase/api/custom_metadata_api.rb', line 321

def custom_metadata_property_update(, id, custom_metadata_properties_update_parameters, opts = {})
  data, _status_code, _headers = custom_metadata_property_update_with_http_info(, id, custom_metadata_properties_update_parameters, opts)
  data
end

#custom_metadata_property_update_with_http_info(account_id, id, custom_metadata_properties_update_parameters, opts = {}) ⇒ Array<(Response<(CustomMetadataProperty)>, Integer, Hash)>

Update a property Update an existing custom metadata property.

Parameters:

  • account_id (String) —

    Account ID

  • id (String) —

    ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
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
 
# File 'lib/phrase/api/custom_metadata_api.rb', line 334

def custom_metadata_property_update_with_http_info(, id, custom_metadata_properties_update_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomMetadataApi.custom_metadata_property_update ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling CustomMetadataApi.custom_metadata_property_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 CustomMetadataApi.custom_metadata_property_update"
  end
  # verify the required parameter 'custom_metadata_properties_update_parameters' is set
  if @api_client.config.client_side_validation && custom_metadata_properties_update_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'custom_metadata_properties_update_parameters' when calling CustomMetadataApi.custom_metadata_property_update"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/custom_metadata/properties/{id}'.sub('{' + 'account_id' + '}', CGI.escape(.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(custom_metadata_properties_update_parameters) 

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

  # 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: CustomMetadataApi#custom_metadata_property_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end