phrase 2.20.0 → 2.22.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (86) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/README.md +27 -5
  4. data/docs/CustomMetadataApi.md +339 -0
  5. data/docs/CustomMetadataDataType.md +16 -0
  6. data/docs/CustomMetadataPropertiesCreateParameters.md +25 -0
  7. data/docs/CustomMetadataPropertiesUpdateParameters.md +23 -0
  8. data/docs/CustomMetadataProperty.md +33 -0
  9. data/docs/CustomMetadataPropertyCreate422Response.md +19 -0
  10. data/docs/{InvitationCreate422ResponseErrorsInner.md → CustomMetadataPropertyCreate422ResponseErrorsInner.md} +2 -2
  11. data/docs/Error.md +17 -0
  12. data/docs/ErrorError.md +19 -0
  13. data/docs/KeyCreateParameters.md +4 -2
  14. data/docs/KeyUpdateParameters.md +4 -2
  15. data/docs/KeysApi.md +2 -2
  16. data/docs/KeysSearchParameters.md +1 -1
  17. data/docs/LocaleReport.md +43 -0
  18. data/docs/LocalesApi.md +3 -1
  19. data/docs/ProjectCreateParameters.md +1 -1
  20. data/docs/ProjectReport.md +31 -0
  21. data/docs/ProjectUpdateParameters.md +1 -1
  22. data/docs/ProjectsQualityPerformanceScore200Response.md +21 -0
  23. data/docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md +19 -0
  24. data/docs/ProjectsQualityPerformanceScore200ResponseAnyOfData.md +17 -0
  25. data/docs/ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md +21 -0
  26. data/docs/ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md +21 -0
  27. data/docs/ProjectsQualityPerformanceScoreRequest.md +17 -0
  28. data/docs/QualityPerformanceScoreApi.md +72 -0
  29. data/docs/ReportsApi.md +144 -0
  30. data/docs/ScreenshotUpdateParameters.md +1 -1
  31. data/docs/TranslationKeyDetails.md +3 -1
  32. data/docs/Upload.md +2 -0
  33. data/lib/phrase/api/custom_metadata_api.rb +390 -0
  34. data/lib/phrase/api/keys_api.rb +2 -2
  35. data/lib/phrase/api/locales_api.rb +3 -0
  36. data/lib/phrase/api/quality_performance_score_api.rb +84 -0
  37. data/lib/phrase/api/reports_api.rb +160 -0
  38. data/lib/phrase/models/custom_metadata_data_type.rb +30 -0
  39. data/lib/phrase/models/custom_metadata_properties_create_parameters.rb +272 -0
  40. data/lib/phrase/models/custom_metadata_properties_update_parameters.rb +231 -0
  41. data/lib/phrase/models/custom_metadata_property.rb +294 -0
  42. data/lib/phrase/models/{invitation_create422_response.rb → custom_metadata_property_create422_response.rb} +4 -4
  43. data/lib/phrase/models/{invitation_create422_response_errors_inner.rb → custom_metadata_property_create422_response_errors_inner.rb} +3 -3
  44. data/lib/phrase/models/error.rb +197 -0
  45. data/lib/phrase/models/error_error.rb +205 -0
  46. data/lib/phrase/models/key_create_parameters.rb +14 -4
  47. data/lib/phrase/models/key_update_parameters.rb +14 -4
  48. data/lib/phrase/models/keys_search_parameters.rb +1 -1
  49. data/lib/phrase/models/locale_report.rb +313 -0
  50. data/lib/phrase/models/project_report.rb +259 -0
  51. data/lib/phrase/models/projects_quality_performance_score200_response.rb +237 -0
  52. data/lib/phrase/models/projects_quality_performance_score200_response_any_of.rb +208 -0
  53. data/lib/phrase/models/projects_quality_performance_score200_response_any_of_data.rb +198 -0
  54. data/lib/phrase/models/projects_quality_performance_score200_response_any_of_data_translations_inner.rb +217 -0
  55. data/lib/phrase/models/projects_quality_performance_score200_response_any_of_errors_inner.rb +215 -0
  56. data/lib/phrase/models/projects_quality_performance_score_request.rb +199 -0
  57. data/lib/phrase/models/translation_key_details.rb +15 -4
  58. data/lib/phrase/models/upload.rb +11 -1
  59. data/lib/phrase/version.rb +1 -1
  60. data/lib/phrase.rb +19 -2
  61. data/spec/api/custom_metadata_api_spec.rb +99 -0
  62. data/spec/api/keys_api_spec.rb +1 -1
  63. data/spec/api/quality_performance_score_api_spec.rb +37 -0
  64. data/spec/api/reports_api_spec.rb +55 -0
  65. data/spec/models/custom_metadata_data_type_spec.rb +23 -0
  66. data/spec/models/custom_metadata_properties_create_parameters_spec.rb +53 -0
  67. data/spec/models/custom_metadata_properties_update_parameters_spec.rb +47 -0
  68. data/spec/models/{invitation_create422_response_errors_inner_spec.rb → custom_metadata_property_create422_response_errors_inner_spec.rb} +6 -6
  69. data/spec/models/custom_metadata_property_create422_response_spec.rb +35 -0
  70. data/spec/models/custom_metadata_property_spec.rb +77 -0
  71. data/spec/models/{invitation_create422_response_spec.rb → error_error_spec.rb} +7 -7
  72. data/spec/models/error_spec.rb +29 -0
  73. data/spec/models/key_create_parameters_spec.rb +6 -0
  74. data/spec/models/key_update_parameters_spec.rb +6 -0
  75. data/spec/models/locale_report_spec.rb +107 -0
  76. data/spec/models/project_report_spec.rb +71 -0
  77. data/spec/models/projects_quality_performance_score200_response_any_of_data_spec.rb +29 -0
  78. data/spec/models/projects_quality_performance_score200_response_any_of_data_translations_inner_spec.rb +41 -0
  79. data/spec/models/projects_quality_performance_score200_response_any_of_errors_inner_spec.rb +41 -0
  80. data/spec/models/projects_quality_performance_score200_response_any_of_spec.rb +35 -0
  81. data/spec/models/projects_quality_performance_score200_response_spec.rb +41 -0
  82. data/spec/models/projects_quality_performance_score_request_spec.rb +29 -0
  83. data/spec/models/translation_key_details_spec.rb +6 -0
  84. data/spec/models/upload_spec.rb +6 -0
  85. metadata +285 -217
  86. data/docs/InvitationCreate422Response.md +0 -19
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 677fad1b1926a85244c87c403c95c040e26a59cecbaca5169d2bc77c2d8a3aa5
4
- data.tar.gz: 5dc85870e2fc9e029b806cfc7fb16ae4729307a70730ea1b82c1761443814705
3
+ metadata.gz: d9a84cd82f9a8d6fd584b5a80e84f6bd3ea5985d5f20bfb478c087d173b366d4
4
+ data.tar.gz: '09389e6cec783b90b06441c89f0fdace5b5bd57d9d41613c0c944387e7accab1'
5
5
  SHA512:
6
- metadata.gz: 2d47718084d2168f6f0f3c821f8c05d7674e0ad17c38aa828c8f3dbc0582016e4a7b7be20b5e77715e98f817830b7cca26ce83b13c0eda5b9c3021a4cb84070f
7
- data.tar.gz: 13bebaa088d9d12288962fe955a58d45fd81e3ca860898e33cbc0912a3b206c10b2cc4b5e867e7a8bd2c0c3e0d18274235873ce1e91936394f386dd8c1d96bb8
6
+ metadata.gz: 8af8b703cf40ed059efd4fe0b9b647071aa37f224c1c4b9dafc062202be70e28faa1db794830d9d69ec0782c653bddad658f118d8154ad809f9b0883410a4da1
7
+ data.tar.gz: bc1cafa20a7f9d9196d96a8e13c092531f6f511b25788982012b10176b285e9c00d126e3a21a9309585078e8a7ebe7ef0cf4231a005825cdf8a8b85450b20dc9
data/CHANGELOG.md CHANGED
@@ -1,5 +1,27 @@
1
1
  # Changelog
2
2
 
3
+ ## [2.22.0](https://github.com/phrase/openapi/compare/ruby-v2.21.0...ruby-v2.22.0) (2024-01-17)
4
+
5
+
6
+ ### Features
7
+
8
+ * **api:** Add QPS endpoint and documentation ([#521](https://github.com/phrase/openapi/issues/521)) ([d22c558](https://github.com/phrase/openapi/commit/d22c558adfbb7fcd13759e388c038744914e42fa))
9
+
10
+
11
+ ### Bug Fixes
12
+
13
+ * **API:** Create Custom Metadata endpoint fix [TSI-2222] ([#499](https://github.com/phrase/openapi/issues/499)) ([ce2ed94](https://github.com/phrase/openapi/commit/ce2ed9488e111fb5d9bc3810a78c47d23553c8b7))
14
+
15
+ ## [2.21.0](https://github.com/phrase/openapi/compare/ruby-v2.20.0...ruby-v2.21.0) (2023-12-13)
16
+
17
+
18
+ ### Features
19
+
20
+ * Add reports locales endpoint to API [TSS-2439] ([#465](https://github.com/phrase/openapi/issues/465)) ([e03aa9f](https://github.com/phrase/openapi/commit/e03aa9f49f031517b36db715fe70e8e0b65a438b))
21
+ * **API:** add Custom Metadata endpoints ([#474](https://github.com/phrase/openapi/issues/474)) ([d407d8b](https://github.com/phrase/openapi/commit/d407d8be5ccddec1afde14a12804a7a616f77d7a))
22
+ * **API:** Add custom_metadata_filters param to locale download endpoint [TSI-2174] ([#478](https://github.com/phrase/openapi/issues/478)) ([3623478](https://github.com/phrase/openapi/commit/3623478fc1518b457ab018b5630a693081637d6e))
23
+ * **API:** Add url field to uploads ([#481](https://github.com/phrase/openapi/issues/481)) ([7332a84](https://github.com/phrase/openapi/commit/7332a84f9958346f2fb28dee4b0353519ef466d5))
24
+
3
25
  ## [2.20.0](https://github.com/phrase/openapi/compare/ruby-v2.19.0...ruby-v2.20.0) (2023-11-03)
4
26
 
5
27
 
data/README.md CHANGED
@@ -7,7 +7,7 @@ Phrase Strings is a translation management platform for software projects. You c
7
7
  ## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 2.20.0
10
+ - Package version: 2.22.0
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
13
13
 
@@ -56,10 +56,10 @@ gem build phrase.gemspec
56
56
  Then install the gem locally:
57
57
 
58
58
  ```shell
59
- gem install ./phrase-2.20.0.gem
59
+ gem install ./phrase-2.22.0.gem
60
60
  ```
61
61
 
62
- (for development, run `gem install --dev ./phrase-2.20.0.gem` to install the development dependencies)
62
+ (for development, run `gem install --dev ./phrase-2.22.0.gem` to install the development dependencies)
63
63
 
64
64
  ## Getting Started
65
65
 
@@ -170,6 +170,11 @@ Class | Method | HTTP request | Description
170
170
  *Phrase::CommentsApi* | [**comment_show**](docs/CommentsApi.md#comment_show) | **GET** /projects/{project_id}/keys/{key_id}/comments/{id} | Get a single comment
171
171
  *Phrase::CommentsApi* | [**comment_update**](docs/CommentsApi.md#comment_update) | **PATCH** /projects/{project_id}/keys/{key_id}/comments/{id} | Update a comment
172
172
  *Phrase::CommentsApi* | [**comments_list**](docs/CommentsApi.md#comments_list) | **GET** /projects/{project_id}/keys/{key_id}/comments | List comments
173
+ *Phrase::CustomMetadataApi* | [**custom_metadata_properties_delete**](docs/CustomMetadataApi.md#custom_metadata_properties_delete) | **DELETE** /accounts/{account_id}/custom_metadata/properties/{id} | Destroy property
174
+ *Phrase::CustomMetadataApi* | [**custom_metadata_properties_list**](docs/CustomMetadataApi.md#custom_metadata_properties_list) | **GET** /accounts/{account_id}/custom_metadata/properties | List properties
175
+ *Phrase::CustomMetadataApi* | [**custom_metadata_property_create**](docs/CustomMetadataApi.md#custom_metadata_property_create) | **POST** /accounts/{account_id}/custom_metadata/properties | Create a property
176
+ *Phrase::CustomMetadataApi* | [**custom_metadata_property_show**](docs/CustomMetadataApi.md#custom_metadata_property_show) | **GET** /accounts/{account_id}/custom_metadata/properties/{id} | Get a single property
177
+ *Phrase::CustomMetadataApi* | [**custom_metadata_property_update**](docs/CustomMetadataApi.md#custom_metadata_property_update) | **PATCH** /accounts/{account_id}/custom_metadata/properties/{id} | Update a property
173
178
  *Phrase::DistributionsApi* | [**distribution_create**](docs/DistributionsApi.md#distribution_create) | **POST** /accounts/{account_id}/distributions | Create a distribution
174
179
  *Phrase::DistributionsApi* | [**distribution_delete**](docs/DistributionsApi.md#distribution_delete) | **DELETE** /accounts/{account_id}/distributions/{id} | Delete a distribution
175
180
  *Phrase::DistributionsApi* | [**distribution_show**](docs/DistributionsApi.md#distribution_show) | **GET** /accounts/{account_id}/distributions/{id} | Get a single distribution
@@ -300,12 +305,15 @@ Class | Method | HTTP request | Description
300
305
  *Phrase::ProjectsApi* | [**project_show**](docs/ProjectsApi.md#project_show) | **GET** /projects/{id} | Get a single project
301
306
  *Phrase::ProjectsApi* | [**project_update**](docs/ProjectsApi.md#project_update) | **PATCH** /projects/{id} | Update a project
302
307
  *Phrase::ProjectsApi* | [**projects_list**](docs/ProjectsApi.md#projects_list) | **GET** /projects | List projects
308
+ *Phrase::QualityPerformanceScoreApi* | [**projects_quality_performance_score**](docs/QualityPerformanceScoreApi.md#projects_quality_performance_score) | **POST** /projects/{id}/quality_performance_score | Get project's translations' quality performance scores
303
309
  *Phrase::ReleasesApi* | [**release_create**](docs/ReleasesApi.md#release_create) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases | Create a release
304
310
  *Phrase::ReleasesApi* | [**release_delete**](docs/ReleasesApi.md#release_delete) | **DELETE** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Delete a release
305
311
  *Phrase::ReleasesApi* | [**release_publish**](docs/ReleasesApi.md#release_publish) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish | Publish a release
306
312
  *Phrase::ReleasesApi* | [**release_show**](docs/ReleasesApi.md#release_show) | **GET** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Get a single release
307
313
  *Phrase::ReleasesApi* | [**release_update**](docs/ReleasesApi.md#release_update) | **PATCH** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Update a release
308
314
  *Phrase::ReleasesApi* | [**releases_list**](docs/ReleasesApi.md#releases_list) | **GET** /accounts/{account_id}/distributions/{distribution_id}/releases | List releases
315
+ *Phrase::ReportsApi* | [**report_locales_list**](docs/ReportsApi.md#report_locales_list) | **GET** /projects/{project_id}/report/locales | List Locale Reports
316
+ *Phrase::ReportsApi* | [**report_show**](docs/ReportsApi.md#report_show) | **GET** /projects/{project_id}/report | Get Project Report
309
317
  *Phrase::ScreenshotMarkersApi* | [**screenshot_marker_create**](docs/ScreenshotMarkersApi.md#screenshot_marker_create) | **POST** /projects/{project_id}/screenshots/{screenshot_id}/markers | Create a screenshot marker
310
318
  *Phrase::ScreenshotMarkersApi* | [**screenshot_marker_delete**](docs/ScreenshotMarkersApi.md#screenshot_marker_delete) | **DELETE** /projects/{project_id}/screenshots/{screenshot_id}/markers | Delete a screenshot marker
311
319
  *Phrase::ScreenshotMarkersApi* | [**screenshot_marker_show**](docs/ScreenshotMarkersApi.md#screenshot_marker_show) | **GET** /projects/{project_id}/screenshots/{screenshot_id}/markers/{id} | Get a single screenshot marker
@@ -414,11 +422,19 @@ Class | Method | HTTP request | Description
414
422
  - [Phrase::CommentUpdateParameters](docs/CommentUpdateParameters.md)
415
423
  - [Phrase::CommentsListParameters](docs/CommentsListParameters.md)
416
424
  - [Phrase::CurrentUser](docs/CurrentUser.md)
425
+ - [Phrase::CustomMetadataDataType](docs/CustomMetadataDataType.md)
426
+ - [Phrase::CustomMetadataPropertiesCreateParameters](docs/CustomMetadataPropertiesCreateParameters.md)
427
+ - [Phrase::CustomMetadataPropertiesUpdateParameters](docs/CustomMetadataPropertiesUpdateParameters.md)
428
+ - [Phrase::CustomMetadataProperty](docs/CustomMetadataProperty.md)
429
+ - [Phrase::CustomMetadataPropertyCreate422Response](docs/CustomMetadataPropertyCreate422Response.md)
430
+ - [Phrase::CustomMetadataPropertyCreate422ResponseErrorsInner](docs/CustomMetadataPropertyCreate422ResponseErrorsInner.md)
417
431
  - [Phrase::Distribution](docs/Distribution.md)
418
432
  - [Phrase::DistributionCreateParameters](docs/DistributionCreateParameters.md)
419
433
  - [Phrase::DistributionPreview](docs/DistributionPreview.md)
420
434
  - [Phrase::DistributionUpdateParameters](docs/DistributionUpdateParameters.md)
421
435
  - [Phrase::Document](docs/Document.md)
436
+ - [Phrase::Error](docs/Error.md)
437
+ - [Phrase::ErrorError](docs/ErrorError.md)
422
438
  - [Phrase::FigmaAttachment](docs/FigmaAttachment.md)
423
439
  - [Phrase::FigmaAttachmentCreateParameters](docs/FigmaAttachmentCreateParameters.md)
424
440
  - [Phrase::FigmaAttachmentUpdateParameters](docs/FigmaAttachmentUpdateParameters.md)
@@ -443,8 +459,6 @@ Class | Method | HTTP request | Description
443
459
  - [Phrase::Icu](docs/Icu.md)
444
460
  - [Phrase::IcuSkeletonParameters](docs/IcuSkeletonParameters.md)
445
461
  - [Phrase::Invitation](docs/Invitation.md)
446
- - [Phrase::InvitationCreate422Response](docs/InvitationCreate422Response.md)
447
- - [Phrase::InvitationCreate422ResponseErrorsInner](docs/InvitationCreate422ResponseErrorsInner.md)
448
462
  - [Phrase::InvitationCreateParameters](docs/InvitationCreateParameters.md)
449
463
  - [Phrase::InvitationUpdateParameters](docs/InvitationUpdateParameters.md)
450
464
  - [Phrase::InvitationUpdateSettingsParameters](docs/InvitationUpdateSettingsParameters.md)
@@ -487,6 +501,7 @@ Class | Method | HTTP request | Description
487
501
  - [Phrase::LocaleDetails](docs/LocaleDetails.md)
488
502
  - [Phrase::LocalePreview](docs/LocalePreview.md)
489
503
  - [Phrase::LocalePreview1](docs/LocalePreview1.md)
504
+ - [Phrase::LocaleReport](docs/LocaleReport.md)
490
505
  - [Phrase::LocaleStatistics](docs/LocaleStatistics.md)
491
506
  - [Phrase::LocaleTeamPreview](docs/LocaleTeamPreview.md)
492
507
  - [Phrase::LocaleUpdateParameters](docs/LocaleUpdateParameters.md)
@@ -512,8 +527,15 @@ Class | Method | HTTP request | Description
512
527
  - [Phrase::ProjectCreateParameters](docs/ProjectCreateParameters.md)
513
528
  - [Phrase::ProjectDetails](docs/ProjectDetails.md)
514
529
  - [Phrase::ProjectLocales](docs/ProjectLocales.md)
530
+ - [Phrase::ProjectReport](docs/ProjectReport.md)
515
531
  - [Phrase::ProjectShort](docs/ProjectShort.md)
516
532
  - [Phrase::ProjectUpdateParameters](docs/ProjectUpdateParameters.md)
533
+ - [Phrase::ProjectsQualityPerformanceScore200Response](docs/ProjectsQualityPerformanceScore200Response.md)
534
+ - [Phrase::ProjectsQualityPerformanceScore200ResponseAnyOf](docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md)
535
+ - [Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfData](docs/ProjectsQualityPerformanceScore200ResponseAnyOfData.md)
536
+ - [Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner](docs/ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md)
537
+ - [Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner](docs/ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md)
538
+ - [Phrase::ProjectsQualityPerformanceScoreRequest](docs/ProjectsQualityPerformanceScoreRequest.md)
517
539
  - [Phrase::Release](docs/Release.md)
518
540
  - [Phrase::ReleaseCreateParameters](docs/ReleaseCreateParameters.md)
519
541
  - [Phrase::ReleasePreview](docs/ReleasePreview.md)
@@ -0,0 +1,339 @@
1
+ # Phrase::CustomMetadataApi
2
+
3
+ All URIs are relative to *https://api.phrase.com/v2*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**custom_metadata_properties_delete**](CustomMetadataApi.md#custom_metadata_properties_delete) | **DELETE** /accounts/{account_id}/custom_metadata/properties/{id} | Destroy property
8
+ [**custom_metadata_properties_list**](CustomMetadataApi.md#custom_metadata_properties_list) | **GET** /accounts/{account_id}/custom_metadata/properties | List properties
9
+ [**custom_metadata_property_create**](CustomMetadataApi.md#custom_metadata_property_create) | **POST** /accounts/{account_id}/custom_metadata/properties | Create a property
10
+ [**custom_metadata_property_show**](CustomMetadataApi.md#custom_metadata_property_show) | **GET** /accounts/{account_id}/custom_metadata/properties/{id} | Get a single property
11
+ [**custom_metadata_property_update**](CustomMetadataApi.md#custom_metadata_property_update) | **PATCH** /accounts/{account_id}/custom_metadata/properties/{id} | Update a property
12
+
13
+
14
+
15
+ ## custom_metadata_properties_delete
16
+
17
+ > custom_metadata_properties_delete(account_id, id, opts)
18
+
19
+ Destroy property
20
+
21
+ Destroy a custom metadata property of an account. This endpoint is only available to accounts with advanced plans or above.
22
+
23
+ ### Example
24
+
25
+ ```ruby
26
+ # load the gem
27
+ require 'phrase'
28
+ # setup authorization
29
+ Phrase.configure do |config|
30
+ # Configure HTTP basic authorization: Basic
31
+ config.username = 'YOUR USERNAME'
32
+ config.password = 'YOUR PASSWORD'
33
+
34
+ # Configure API key authorization: Token
35
+ config.api_key['Authorization'] = 'YOUR API KEY'
36
+ config.api_key_prefix['Authorization'] = 'token'
37
+ end
38
+
39
+ api_instance = Phrase::CustomMetadataApi.new
40
+ account_id = 'account_id_example' # String | Account ID
41
+ id = 'id_example' # String | ID
42
+ opts = {
43
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
44
+ }
45
+
46
+ begin
47
+ #Destroy property
48
+ api_instance.custom_metadata_properties_delete(account_id, id, opts)
49
+ rescue Phrase::ApiError => e
50
+ puts "Exception when calling CustomMetadataApi->custom_metadata_properties_delete: #{e}"
51
+ end
52
+ ```
53
+
54
+ ### Parameters
55
+
56
+
57
+ Name | Type | Description | Notes
58
+ ------------- | ------------- | ------------- | -------------
59
+ **account_id** | **String**| Account ID |
60
+ **id** | **String**| ID |
61
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
62
+
63
+ ### Return type
64
+
65
+ Response<(nil (empty response body))>
66
+
67
+ ### Authorization
68
+
69
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
70
+
71
+ ### HTTP request headers
72
+
73
+ - **Content-Type**: Not defined
74
+ - **Accept**: Not defined
75
+
76
+
77
+ ## custom_metadata_properties_list
78
+
79
+ > Array&lt;CustomMetadataProperty&gt; custom_metadata_properties_list(account_id, opts)
80
+
81
+ List properties
82
+
83
+ List all custom metadata properties for an account. This endpoint is only available to accounts with advanced plans or above.
84
+
85
+ ### Example
86
+
87
+ ```ruby
88
+ # load the gem
89
+ require 'phrase'
90
+ # setup authorization
91
+ Phrase.configure do |config|
92
+ # Configure HTTP basic authorization: Basic
93
+ config.username = 'YOUR USERNAME'
94
+ config.password = 'YOUR PASSWORD'
95
+
96
+ # Configure API key authorization: Token
97
+ config.api_key['Authorization'] = 'YOUR API KEY'
98
+ config.api_key_prefix['Authorization'] = 'token'
99
+ end
100
+
101
+ api_instance = Phrase::CustomMetadataApi.new
102
+ account_id = 'account_id_example' # String | Account ID
103
+ opts = {
104
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
105
+ data_type: Phrase::CustomMetadataDataType::BOOLEAN, # CustomMetadataDataType | Data Type of Custom Metadata Property
106
+ project_id: 'abcd1234cdef1234abcd1234cdef1234', # String | id of project that the properties belong to
107
+ page: 1, # Integer | Page number
108
+ per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
109
+ sort: 'updated_at', # String | Sort criteria. Can be one of: name, data_type, created_at.
110
+ order: 'desc' # String | Order direction. Can be one of: asc, desc.
111
+ }
112
+
113
+ begin
114
+ #List properties
115
+ result = api_instance.custom_metadata_properties_list(account_id, opts)
116
+ pp result
117
+ rescue Phrase::ApiError => e
118
+ puts "Exception when calling CustomMetadataApi->custom_metadata_properties_list: #{e}"
119
+ end
120
+ ```
121
+
122
+ ### Parameters
123
+
124
+
125
+ Name | Type | Description | Notes
126
+ ------------- | ------------- | ------------- | -------------
127
+ **account_id** | **String**| Account ID |
128
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
129
+ **data_type** | [**CustomMetadataDataType**](.md)| Data Type of Custom Metadata Property | [optional]
130
+ **project_id** | **String**| id of project that the properties belong to | [optional]
131
+ **page** | **Integer**| Page number | [optional]
132
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
133
+ **sort** | **String**| Sort criteria. Can be one of: name, data_type, created_at. | [optional]
134
+ **order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
135
+
136
+ ### Return type
137
+
138
+ Response<([**Array&lt;CustomMetadataProperty&gt;**](CustomMetadataProperty.md))>
139
+
140
+ ### Authorization
141
+
142
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
143
+
144
+ ### HTTP request headers
145
+
146
+ - **Content-Type**: Not defined
147
+ - **Accept**: application/json
148
+
149
+
150
+ ## custom_metadata_property_create
151
+
152
+ > CustomMetadataProperty custom_metadata_property_create(account_id, custom_metadata_properties_create_parameters, opts)
153
+
154
+ Create a property
155
+
156
+ Create a new custom metadata property.
157
+
158
+ ### Example
159
+
160
+ ```ruby
161
+ # load the gem
162
+ require 'phrase'
163
+ # setup authorization
164
+ Phrase.configure do |config|
165
+ # Configure HTTP basic authorization: Basic
166
+ config.username = 'YOUR USERNAME'
167
+ config.password = 'YOUR PASSWORD'
168
+
169
+ # Configure API key authorization: Token
170
+ config.api_key['Authorization'] = 'YOUR API KEY'
171
+ config.api_key_prefix['Authorization'] = 'token'
172
+ end
173
+
174
+ api_instance = Phrase::CustomMetadataApi.new
175
+ account_id = 'account_id_example' # String | Account ID
176
+ custom_metadata_properties_create_parameters = Phrase::CustomMetadataPropertiesCreateParameters.new({name: 'Fruit', data_type: Phrase::CustomMetadataDataType::BOOLEAN}) # CustomMetadataPropertiesCreateParameters |
177
+ opts = {
178
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
179
+ }
180
+
181
+ begin
182
+ #Create a property
183
+ result = api_instance.custom_metadata_property_create(account_id, custom_metadata_properties_create_parameters, opts)
184
+ pp result
185
+ rescue Phrase::ApiError => e
186
+ puts "Exception when calling CustomMetadataApi->custom_metadata_property_create: #{e}"
187
+ end
188
+ ```
189
+
190
+ ### Parameters
191
+
192
+
193
+ Name | Type | Description | Notes
194
+ ------------- | ------------- | ------------- | -------------
195
+ **account_id** | **String**| Account ID |
196
+ **custom_metadata_properties_create_parameters** | [**CustomMetadataPropertiesCreateParameters**](CustomMetadataPropertiesCreateParameters.md)| |
197
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
198
+
199
+ ### Return type
200
+
201
+ Response<([**CustomMetadataProperty**](CustomMetadataProperty.md))>
202
+
203
+ ### Authorization
204
+
205
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
206
+
207
+ ### HTTP request headers
208
+
209
+ - **Content-Type**: application/json
210
+ - **Accept**: application/json
211
+
212
+
213
+ ## custom_metadata_property_show
214
+
215
+ > CustomMetadataProperty custom_metadata_property_show(account_id, id, opts)
216
+
217
+ Get a single property
218
+
219
+ Get details of a single custom property.
220
+
221
+ ### Example
222
+
223
+ ```ruby
224
+ # load the gem
225
+ require 'phrase'
226
+ # setup authorization
227
+ Phrase.configure do |config|
228
+ # Configure HTTP basic authorization: Basic
229
+ config.username = 'YOUR USERNAME'
230
+ config.password = 'YOUR PASSWORD'
231
+
232
+ # Configure API key authorization: Token
233
+ config.api_key['Authorization'] = 'YOUR API KEY'
234
+ config.api_key_prefix['Authorization'] = 'token'
235
+ end
236
+
237
+ api_instance = Phrase::CustomMetadataApi.new
238
+ account_id = 'account_id_example' # String | Account ID
239
+ id = 'id_example' # String | ID
240
+ opts = {
241
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
242
+ }
243
+
244
+ begin
245
+ #Get a single property
246
+ result = api_instance.custom_metadata_property_show(account_id, id, opts)
247
+ pp result
248
+ rescue Phrase::ApiError => e
249
+ puts "Exception when calling CustomMetadataApi->custom_metadata_property_show: #{e}"
250
+ end
251
+ ```
252
+
253
+ ### Parameters
254
+
255
+
256
+ Name | Type | Description | Notes
257
+ ------------- | ------------- | ------------- | -------------
258
+ **account_id** | **String**| Account ID |
259
+ **id** | **String**| ID |
260
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
261
+
262
+ ### Return type
263
+
264
+ Response<([**CustomMetadataProperty**](CustomMetadataProperty.md))>
265
+
266
+ ### Authorization
267
+
268
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
269
+
270
+ ### HTTP request headers
271
+
272
+ - **Content-Type**: Not defined
273
+ - **Accept**: application/json
274
+
275
+
276
+ ## custom_metadata_property_update
277
+
278
+ > CustomMetadataProperty custom_metadata_property_update(account_id, id, custom_metadata_properties_update_parameters, opts)
279
+
280
+ Update a property
281
+
282
+ Update an existing custom metadata property.
283
+
284
+ ### Example
285
+
286
+ ```ruby
287
+ # load the gem
288
+ require 'phrase'
289
+ # setup authorization
290
+ Phrase.configure do |config|
291
+ # Configure HTTP basic authorization: Basic
292
+ config.username = 'YOUR USERNAME'
293
+ config.password = 'YOUR PASSWORD'
294
+
295
+ # Configure API key authorization: Token
296
+ config.api_key['Authorization'] = 'YOUR API KEY'
297
+ config.api_key_prefix['Authorization'] = 'token'
298
+ end
299
+
300
+ api_instance = Phrase::CustomMetadataApi.new
301
+ account_id = 'account_id_example' # String | Account ID
302
+ id = 'id_example' # String | ID
303
+ custom_metadata_properties_update_parameters = Phrase::CustomMetadataPropertiesUpdateParameters.new # CustomMetadataPropertiesUpdateParameters |
304
+ opts = {
305
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
306
+ }
307
+
308
+ begin
309
+ #Update a property
310
+ result = api_instance.custom_metadata_property_update(account_id, id, custom_metadata_properties_update_parameters, opts)
311
+ pp result
312
+ rescue Phrase::ApiError => e
313
+ puts "Exception when calling CustomMetadataApi->custom_metadata_property_update: #{e}"
314
+ end
315
+ ```
316
+
317
+ ### Parameters
318
+
319
+
320
+ Name | Type | Description | Notes
321
+ ------------- | ------------- | ------------- | -------------
322
+ **account_id** | **String**| Account ID |
323
+ **id** | **String**| ID |
324
+ **custom_metadata_properties_update_parameters** | [**CustomMetadataPropertiesUpdateParameters**](CustomMetadataPropertiesUpdateParameters.md)| |
325
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
326
+
327
+ ### Return type
328
+
329
+ Response<([**CustomMetadataProperty**](CustomMetadataProperty.md))>
330
+
331
+ ### Authorization
332
+
333
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
334
+
335
+ ### HTTP request headers
336
+
337
+ - **Content-Type**: application/json
338
+ - **Accept**: application/json
339
+
@@ -0,0 +1,16 @@
1
+ # Phrase::CustomMetadataDataType
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+
8
+ ## Code Sample
9
+
10
+ ```ruby
11
+ require 'Phrase'
12
+
13
+ instance = Phrase::CustomMetadataDataType.new()
14
+ ```
15
+
16
+
@@ -0,0 +1,25 @@
1
+ # Phrase::CustomMetadataPropertiesCreateParameters
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | name of the property |
8
+ **data_type** | [**CustomMetadataDataType**](CustomMetadataDataType.md) | |
9
+ **project_ids** | **Array&lt;String&gt;** | ids of projects that the property belongs to | [optional]
10
+ **description** | **String** | description of property | [optional]
11
+ **value_options** | **Array&lt;String&gt;** | value options of property (only applies to single or multi select properties) | [optional]
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'Phrase'
17
+
18
+ instance = Phrase::CustomMetadataPropertiesCreateParameters.new(name: Fruit,
19
+ data_type: null,
20
+ project_ids: [&quot;abcd1234cdef1234abcd1234cdef1234&quot;,&quot;abcd1234cdef1234abcd1234cdef4321&quot;],
21
+ description: A healthy snack for all ages,
22
+ value_options: [&quot;Apple&quot;,&quot;Banana&quot;,&quot;Coconut&quot;])
23
+ ```
24
+
25
+
@@ -0,0 +1,23 @@
1
+ # Phrase::CustomMetadataPropertiesUpdateParameters
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | **String** | name of the property | [optional]
8
+ **project_ids** | **Array&lt;String&gt;** | ids of projects that the property belongs to | [optional]
9
+ **description** | **String** | description of property | [optional]
10
+ **value_options** | **Array&lt;String&gt;** | value options of property (only applies to single or multi select properties) | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'Phrase'
16
+
17
+ instance = Phrase::CustomMetadataPropertiesUpdateParameters.new(name: Fruit,
18
+ project_ids: [&quot;abcd1234cdef1234abcd1234cdef1234&quot;,&quot;abcd1234cdef1234abcd1234cdef4321&quot;],
19
+ description: A healthy snack for all ages,
20
+ value_options: [&quot;Apple&quot;,&quot;Banana&quot;,&quot;Coconut&quot;])
21
+ ```
22
+
23
+
@@ -0,0 +1,33 @@
1
+ # Phrase::CustomMetadataProperty
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | | [optional]
8
+ **name** | **String** | | [optional]
9
+ **description** | **String** | | [optional]
10
+ **data_type** | [**CustomMetadataDataType**](CustomMetadataDataType.md) | | [optional]
11
+ **user** | [**UserPreview**](UserPreview.md) | | [optional]
12
+ **projects** | [**Array&lt;ProjectShort&gt;**](ProjectShort.md) | | [optional]
13
+ **value_options** | **Array&lt;String&gt;** | | [optional]
14
+ **created_at** | **Time** | | [optional]
15
+ **updated_at** | **Time** | | [optional]
16
+
17
+ ## Code Sample
18
+
19
+ ```ruby
20
+ require 'Phrase'
21
+
22
+ instance = Phrase::CustomMetadataProperty.new(id: null,
23
+ name: null,
24
+ description: null,
25
+ data_type: null,
26
+ user: null,
27
+ projects: null,
28
+ value_options: null,
29
+ created_at: null,
30
+ updated_at: null)
31
+ ```
32
+
33
+
@@ -0,0 +1,19 @@
1
+ # Phrase::CustomMetadataPropertyCreate422Response
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **message** | **String** | | [optional]
8
+ **errors** | [**Array&lt;CustomMetadataPropertyCreate422ResponseErrorsInner&gt;**](CustomMetadataPropertyCreate422ResponseErrorsInner.md) | | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Phrase'
14
+
15
+ instance = Phrase::CustomMetadataPropertyCreate422Response.new(message: null,
16
+ errors: null)
17
+ ```
18
+
19
+
@@ -1,4 +1,4 @@
1
- # Phrase::InvitationCreate422ResponseErrorsInner
1
+ # Phrase::CustomMetadataPropertyCreate422ResponseErrorsInner
2
2
 
3
3
  ## Properties
4
4
 
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
13
13
  ```ruby
14
14
  require 'Phrase'
15
15
 
16
- instance = Phrase::InvitationCreate422ResponseErrorsInner.new(resource: null,
16
+ instance = Phrase::CustomMetadataPropertyCreate422ResponseErrorsInner.new(resource: null,
17
17
  field: null,
18
18
  message: null)
19
19
  ```
data/docs/Error.md ADDED
@@ -0,0 +1,17 @@
1
+ # Phrase::Error
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **error** | [**ErrorError**](ErrorError.md) | | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'Phrase'
13
+
14
+ instance = Phrase::Error.new(error: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,19 @@
1
+ # Phrase::ErrorError
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **message** | **String** | | [optional]
8
+ **code** | **String** | | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Phrase'
14
+
15
+ instance = Phrase::ErrorError.new(message: null,
16
+ code: null)
17
+ ```
18
+
19
+