phrase 2.8.3 → 2.8.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (103) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +15 -12
  4. data/docs/BitbucketSyncApi.md +2 -2
  5. data/docs/BranchesApi.md +3 -3
  6. data/docs/GitHubSyncApi.md +2 -2
  7. data/docs/GitLabSyncApi.md +2 -2
  8. data/docs/JobCommentsApi.md +6 -6
  9. data/docs/JobLocale.md +3 -1
  10. data/docs/JobLocaleUpdateParameters.md +5 -1
  11. data/docs/JobLocalesCreateParameters.md +6 -2
  12. data/docs/JobTemplateDetails.md +35 -0
  13. data/docs/JobTemplateDetails1.md +21 -0
  14. data/docs/JobTemplateLocaleUpdateParameters.md +6 -2
  15. data/docs/{JobTemplateLocale.md → JobTemplateLocales.md} +6 -4
  16. data/docs/JobTemplateLocalesApi.md +8 -8
  17. data/docs/JobTemplateLocalesCreateParameters.md +5 -1
  18. data/docs/JobTemplatesApi.md +41 -41
  19. data/docs/KeysSearchParameters.md +1 -1
  20. data/docs/LocaleTeamPreview.md +21 -0
  21. data/docs/{JobTemplateUserPreview.md → LocaleUserPreview.md} +2 -2
  22. data/docs/LocalesApi.md +8 -4
  23. data/docs/NotificationGroupDetail.md +1 -1
  24. data/docs/NotificationGroupsApi.md +4 -4
  25. data/docs/NotificationsApi.md +4 -4
  26. data/docs/Project.md +2 -0
  27. data/docs/ProjectCreateParameters.md +5 -1
  28. data/docs/ProjectDetails.md +2 -0
  29. data/docs/ProjectUpdateParameters.md +5 -1
  30. data/docs/SearchApi.md +1 -1
  31. data/docs/TranslationsApi.md +23 -19
  32. data/docs/TranslationsExcludeParameters.md +1 -1
  33. data/docs/TranslationsIncludeParameters.md +1 -1
  34. data/docs/TranslationsReviewParameters.md +1 -1
  35. data/docs/TranslationsSearchParameters.md +1 -1
  36. data/docs/TranslationsUnverifyParameters.md +1 -1
  37. data/docs/TranslationsVerifyParameters.md +1 -1
  38. data/docs/UploadsApi.md +3 -3
  39. data/lib/phrase/api/bitbucket_sync_api.rb +4 -4
  40. data/lib/phrase/api/branches_api.rb +6 -6
  41. data/lib/phrase/api/git_hub_sync_api.rb +4 -4
  42. data/lib/phrase/api/git_lab_sync_api.rb +4 -4
  43. data/lib/phrase/api/job_comments_api.rb +9 -9
  44. data/lib/phrase/api/job_template_locales_api.rb +12 -12
  45. data/lib/phrase/api/job_templates_api.rb +72 -72
  46. data/lib/phrase/api/locales_api.rb +10 -4
  47. data/lib/phrase/api/notification_groups_api.rb +6 -6
  48. data/lib/phrase/api/notifications_api.rb +6 -6
  49. data/lib/phrase/api/search_api.rb +2 -2
  50. data/lib/phrase/api/translations_api.rb +20 -14
  51. data/lib/phrase/api/uploads_api.rb +2 -2
  52. data/lib/phrase/models/job_locale.rb +13 -2
  53. data/lib/phrase/models/job_locale_update_parameters.rb +28 -4
  54. data/lib/phrase/models/job_locales_create_parameters.rb +33 -4
  55. data/lib/phrase/models/job_template_details.rb +285 -0
  56. data/lib/phrase/models/job_template_details1.rb +214 -0
  57. data/lib/phrase/models/job_template_locale_update_parameters.rb +28 -9
  58. data/lib/phrase/models/{job_template_locale.rb → job_template_locales.rb} +18 -7
  59. data/lib/phrase/models/job_template_locales_create_parameters.rb +28 -4
  60. data/lib/phrase/models/keys_search_parameters.rb +1 -1
  61. data/lib/phrase/models/locale_team_preview.rb +212 -0
  62. data/lib/phrase/models/{job_template_user_preview.rb → locale_user_preview.rb} +3 -3
  63. data/lib/phrase/models/notification_group_detail.rb +1 -1
  64. data/lib/phrase/models/project.rb +10 -1
  65. data/lib/phrase/models/project_create_parameters.rb +22 -2
  66. data/lib/phrase/models/project_details.rb +10 -1
  67. data/lib/phrase/models/project_update_parameters.rb +22 -2
  68. data/lib/phrase/models/translations_exclude_parameters.rb +1 -1
  69. data/lib/phrase/models/translations_include_parameters.rb +1 -1
  70. data/lib/phrase/models/translations_review_parameters.rb +1 -1
  71. data/lib/phrase/models/translations_search_parameters.rb +1 -1
  72. data/lib/phrase/models/translations_unverify_parameters.rb +1 -1
  73. data/lib/phrase/models/translations_verify_parameters.rb +1 -1
  74. data/lib/phrase/version.rb +1 -1
  75. data/lib/phrase.rb +5 -2
  76. data/spec/api/bitbucket_sync_api_spec.rb +2 -2
  77. data/spec/api/branches_api_spec.rb +3 -3
  78. data/spec/api/git_hub_sync_api_spec.rb +2 -2
  79. data/spec/api/git_lab_sync_api_spec.rb +2 -2
  80. data/spec/api/job_comments_api_spec.rb +3 -3
  81. data/spec/api/job_template_locales_api_spec.rb +4 -4
  82. data/spec/api/job_templates_api_spec.rb +17 -17
  83. data/spec/api/locales_api_spec.rb +4 -2
  84. data/spec/api/notification_groups_api_spec.rb +2 -2
  85. data/spec/api/notifications_api_spec.rb +2 -2
  86. data/spec/api/search_api_spec.rb +1 -1
  87. data/spec/api/translations_api_spec.rb +9 -7
  88. data/spec/api/uploads_api_spec.rb +1 -1
  89. data/spec/models/job_locale_spec.rb +6 -0
  90. data/spec/models/job_locale_update_parameters_spec.rb +12 -0
  91. data/spec/models/job_locales_create_parameters_spec.rb +12 -0
  92. data/spec/models/job_template_details1_spec.rb +41 -0
  93. data/spec/models/job_template_details_spec.rb +83 -0
  94. data/spec/models/job_template_locale_update_parameters_spec.rb +12 -0
  95. data/spec/models/job_template_locales_create_parameters_spec.rb +12 -0
  96. data/spec/models/{job_template_locale_spec.rb → job_template_locales_spec.rb} +12 -6
  97. data/spec/models/locale_team_preview_spec.rb +41 -0
  98. data/spec/models/{job_template_user_preview_spec.rb → locale_user_preview_spec.rb} +6 -6
  99. data/spec/models/project_create_parameters_spec.rb +12 -0
  100. data/spec/models/project_details_spec.rb +6 -0
  101. data/spec/models/project_spec.rb +6 -0
  102. data/spec/models/project_update_parameters_spec.rb +12 -0
  103. metadata +237 -225
@@ -6,7 +6,7 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**translation_create**](TranslationsApi.md#translation_create) | **POST** /projects/{project_id}/translations | Create a translation
8
8
  [**translation_exclude**](TranslationsApi.md#translation_exclude) | **PATCH** /projects/{project_id}/translations/{id}/exclude | Exclude a translation from export
9
- [**translation_include**](TranslationsApi.md#translation_include) | **PATCH** /projects/{project_id}/translations/{id}/include | Revoke exclusion of a translation in export
9
+ [**translation_include**](TranslationsApi.md#translation_include) | **PATCH** /projects/{project_id}/translations/{id}/include | Include a translation
10
10
  [**translation_review**](TranslationsApi.md#translation_review) | **PATCH** /projects/{project_id}/translations/{id}/review | Review a translation
11
11
  [**translation_show**](TranslationsApi.md#translation_show) | **GET** /projects/{project_id}/translations/{id} | Get a single translation
12
12
  [**translation_unverify**](TranslationsApi.md#translation_unverify) | **PATCH** /projects/{project_id}/translations/{id}/unverify | Mark a translation as unverified
@@ -14,13 +14,13 @@ Method | HTTP request | Description
14
14
  [**translation_verify**](TranslationsApi.md#translation_verify) | **PATCH** /projects/{project_id}/translations/{id}/verify | Verify a translation
15
15
  [**translations_by_key**](TranslationsApi.md#translations_by_key) | **GET** /projects/{project_id}/keys/{key_id}/translations | List translations by key
16
16
  [**translations_by_locale**](TranslationsApi.md#translations_by_locale) | **GET** /projects/{project_id}/locales/{locale_id}/translations | List translations by locale
17
- [**translations_exclude_collection**](TranslationsApi.md#translations_exclude_collection) | **PATCH** /projects/{project_id}/translations/exclude | Set exclude from export flag on translations selected by query
18
- [**translations_include_collection**](TranslationsApi.md#translations_include_collection) | **PATCH** /projects/{project_id}/translations/include | Remove exlude from import flag from translations selected by query
17
+ [**translations_exclude_collection**](TranslationsApi.md#translations_exclude_collection) | **PATCH** /projects/{project_id}/translations/exclude | Exclude translations by query
18
+ [**translations_include_collection**](TranslationsApi.md#translations_include_collection) | **PATCH** /projects/{project_id}/translations/include | Include translations by query
19
19
  [**translations_list**](TranslationsApi.md#translations_list) | **GET** /projects/{project_id}/translations | List all translations
20
20
  [**translations_review_collection**](TranslationsApi.md#translations_review_collection) | **PATCH** /projects/{project_id}/translations/review | Review translations selected by query
21
21
  [**translations_search**](TranslationsApi.md#translations_search) | **POST** /projects/{project_id}/translations/search | Search translations
22
- [**translations_unverify_collection**](TranslationsApi.md#translations_unverify_collection) | **PATCH** /projects/{project_id}/translations/unverify | Mark translations selected by query as unverified
23
- [**translations_verify_collection**](TranslationsApi.md#translations_verify_collection) | **PATCH** /projects/{project_id}/translations/verify | Verify translations selected by query
22
+ [**translations_unverify_collection**](TranslationsApi.md#translations_unverify_collection) | **PATCH** /projects/{project_id}/translations/unverify | Unverify translations by query
23
+ [**translations_verify_collection**](TranslationsApi.md#translations_verify_collection) | **PATCH** /projects/{project_id}/translations/verify | Verify translations by query
24
24
 
25
25
 
26
26
 
@@ -156,7 +156,7 @@ Response<([**TranslationDetails**](TranslationDetails.md))>
156
156
 
157
157
  > TranslationDetails translation_include(project_id, id, translation_include_parameters, opts)
158
158
 
159
- Revoke exclusion of a translation in export
159
+ Include a translation
160
160
 
161
161
  Remove exclude from export flag from an existing translation.
162
162
 
@@ -185,7 +185,7 @@ opts = {
185
185
  }
186
186
 
187
187
  begin
188
- #Revoke exclusion of a translation in export
188
+ #Include a translation
189
189
  result = api_instance.translation_include(project_id, id, translation_include_parameters, opts)
190
190
  pp result
191
191
  rescue Phrase::ApiError => e
@@ -651,7 +651,7 @@ opts = {
651
651
  branch: 'my-feature-branch', # String | specify the branch to use
652
652
  sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
653
653
  order: 'desc', # String | Order direction. Can be one of: asc, desc.
654
- q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
654
+ q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
655
655
  }
656
656
 
657
657
  begin
@@ -676,7 +676,7 @@ Name | Type | Description | Notes
676
676
  **branch** | **String**| specify the branch to use | [optional]
677
677
  **sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
678
678
  **order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
679
- **q** | **String**| Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
679
+ **q** | **String**| Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; &lt;i&gt;Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).&lt;/i&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
680
680
 
681
681
  ### Return type
682
682
 
@@ -696,7 +696,7 @@ Response<([**Array&lt;Translation&gt;**](Translation.md))>
696
696
 
697
697
  > AffectedCount translations_exclude_collection(project_id, translations_exclude_parameters, opts)
698
698
 
699
- Set exclude from export flag on translations selected by query
699
+ Exclude translations by query
700
700
 
701
701
  Exclude translations matching query from locale export.
702
702
 
@@ -724,7 +724,7 @@ opts = {
724
724
  }
725
725
 
726
726
  begin
727
- #Set exclude from export flag on translations selected by query
727
+ #Exclude translations by query
728
728
  result = api_instance.translations_exclude_collection(project_id, translations_exclude_parameters, opts)
729
729
  pp result
730
730
  rescue Phrase::ApiError => e
@@ -759,7 +759,7 @@ Response<([**AffectedCount**](AffectedCount.md))>
759
759
 
760
760
  > AffectedCount translations_include_collection(project_id, translations_include_parameters, opts)
761
761
 
762
- Remove exlude from import flag from translations selected by query
762
+ Include translations by query
763
763
 
764
764
  Include translations matching query in locale export.
765
765
 
@@ -787,7 +787,7 @@ opts = {
787
787
  }
788
788
 
789
789
  begin
790
- #Remove exlude from import flag from translations selected by query
790
+ #Include translations by query
791
791
  result = api_instance.translations_include_collection(project_id, translations_include_parameters, opts)
792
792
  pp result
793
793
  rescue Phrase::ApiError => e
@@ -846,12 +846,14 @@ api_instance = Phrase::TranslationsApi.new
846
846
  project_id = 'project_id_example' # String | Project ID
847
847
  opts = {
848
848
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
849
+ if_modified_since: 'if_modified_since_example', # String | Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
850
+ if_none_match: 'if_none_match_example', # String | ETag condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
849
851
  page: 1, # Integer | Page number
850
852
  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
851
853
  branch: 'my-feature-branch', # String | specify the branch to use
852
854
  sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
853
855
  order: 'desc', # String | Order direction. Can be one of: asc, desc.
854
- q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
856
+ q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center' # String | Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
855
857
  }
856
858
 
857
859
  begin
@@ -870,12 +872,14 @@ Name | Type | Description | Notes
870
872
  ------------- | ------------- | ------------- | -------------
871
873
  **project_id** | **String**| Project ID |
872
874
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
875
+ **if_modified_since** | **String**| Last modified condition, see &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional) | [optional]
876
+ **if_none_match** | **String**| ETag condition, see &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional) | [optional]
873
877
  **page** | **Integer**| Page number | [optional]
874
878
  **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
875
879
  **branch** | **String**| specify the branch to use | [optional]
876
880
  **sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
877
881
  **order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
878
- **q** | **String**| Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
882
+ **q** | **String**| Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; &lt;i&gt;Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).&lt;/i&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
879
883
 
880
884
  ### Return type
881
885
 
@@ -1025,7 +1029,7 @@ Response<([**Array&lt;Translation&gt;**](Translation.md))>
1025
1029
 
1026
1030
  > AffectedCount translations_unverify_collection(project_id, translations_unverify_parameters, opts)
1027
1031
 
1028
- Mark translations selected by query as unverified
1032
+ Unverify translations by query
1029
1033
 
1030
1034
  Mark translations matching query as unverified.
1031
1035
 
@@ -1053,7 +1057,7 @@ opts = {
1053
1057
  }
1054
1058
 
1055
1059
  begin
1056
- #Mark translations selected by query as unverified
1060
+ #Unverify translations by query
1057
1061
  result = api_instance.translations_unverify_collection(project_id, translations_unverify_parameters, opts)
1058
1062
  pp result
1059
1063
  rescue Phrase::ApiError => e
@@ -1088,7 +1092,7 @@ Response<([**AffectedCount**](AffectedCount.md))>
1088
1092
 
1089
1093
  > AffectedCount translations_verify_collection(project_id, translations_verify_parameters, opts)
1090
1094
 
1091
- Verify translations selected by query
1095
+ Verify translations by query
1092
1096
 
1093
1097
  Verify translations matching query.
1094
1098
 
@@ -1116,7 +1120,7 @@ opts = {
1116
1120
  }
1117
1121
 
1118
1122
  begin
1119
- #Verify translations selected by query
1123
+ #Verify translations by query
1120
1124
  result = api_instance.translations_verify_collection(project_id, translations_verify_parameters, opts)
1121
1125
  pp result
1122
1126
  rescue Phrase::ApiError => e
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **branch** | **String** | specify the branch to use | [optional]
8
- **q** | **String** | Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
8
+ **q** | **String** | Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; &lt;i&gt;Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).&lt;/i&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
9
9
  **sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
10
10
  **order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
11
11
 
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **branch** | **String** | specify the branch to use | [optional]
8
- **q** | **String** | Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
8
+ **q** | **String** | Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; &lt;i&gt;Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).&lt;/i&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
9
9
  **sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
10
10
  **order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
11
11
 
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **branch** | **String** | specify the branch to use | [optional]
8
- **q** | **String** | Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
8
+ **q** | **String** | Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; &lt;i&gt;Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).&lt;/i&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
9
9
 
10
10
  ## Code Sample
11
11
 
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  **branch** | **String** | specify the branch to use | [optional]
8
8
  **sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
9
9
  **order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
10
- **q** | **String** | Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
10
+ **q** | **String** | Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; &lt;i&gt;Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).&lt;/i&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
11
11
 
12
12
  ## Code Sample
13
13
 
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **branch** | **String** | specify the branch to use | [optional]
8
- **q** | **String** | Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
8
+ **q** | **String** | Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; &lt;i&gt;Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).&lt;/i&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
9
9
  **sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
10
10
  **order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
11
11
 
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **branch** | **String** | specify the branch to use | [optional]
8
8
  **locale_id** | **String** | specify the locale of the translations to be verified | [optional]
9
- **q** | **String** | Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
9
+ **q** | **String** | Specify a query to find translations by content (including wildcards).&lt;br&gt;&lt;br&gt; &lt;i&gt;Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).&lt;/i&gt;&lt;br&gt; The following qualifiers are supported in the query:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;id:translation_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:XYZ&lt;/code&gt; for tags on the translation&lt;/li&gt; &lt;li&gt;&lt;code&gt;unverified:{true|false}&lt;/code&gt; for verification status&lt;/li&gt; &lt;li&gt;&lt;code&gt;excluded:{true|false}&lt;/code&gt; for exclusion status&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
10
10
 
11
11
  ## Code Sample
12
12
 
data/docs/UploadsApi.md CHANGED
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.phrase.com/v2*
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**upload_create**](UploadsApi.md#upload_create) | **POST** /projects/{project_id}/uploads | Upload a new file
8
- [**upload_show**](UploadsApi.md#upload_show) | **GET** /projects/{project_id}/uploads/{id} | View upload details
8
+ [**upload_show**](UploadsApi.md#upload_show) | **GET** /projects/{project_id}/uploads/{id} | Get a single upload
9
9
  [**uploads_list**](UploadsApi.md#uploads_list) | **GET** /projects/{project_id}/uploads | List uploads
10
10
 
11
11
 
@@ -105,7 +105,7 @@ Response<([**Upload**](Upload.md))>
105
105
 
106
106
  > Upload upload_show(project_id, id, opts)
107
107
 
108
- View upload details
108
+ Get a single upload
109
109
 
110
110
  View details and summary for a single upload.
111
111
 
@@ -134,7 +134,7 @@ opts = {
134
134
  }
135
135
 
136
136
  begin
137
- #View upload details
137
+ #Get a single upload
138
138
  result = api_instance.upload_show(project_id, id, opts)
139
139
  pp result
140
140
  rescue Phrase::ApiError => e
@@ -8,7 +8,7 @@ module Phrase
8
8
  @api_client = api_client
9
9
  end
10
10
  # Export from Phrase Strings to Bitbucket
11
- # Export translations from Phrase Strings to Bitbucket according to the .phraseapp.yml file within the Bitbucket Repository.
11
+ # Export translations from Phrase Strings to Bitbucket according to the .phraseapp.yml file within the Bitbucket Repository. <br><br><i>Note: Export is done asynchronously and may take several seconds depending on the project size.</i>
12
12
  # @param id [String] ID
13
13
  # @param bitbucket_sync_export_parameters [BitbucketSyncExportParameters]
14
14
  # @param [Hash] opts the optional parameters
@@ -20,7 +20,7 @@ module Phrase
20
20
  end
21
21
 
22
22
  # Export from Phrase Strings to Bitbucket
23
- # Export translations from Phrase Strings to Bitbucket according to the .phraseapp.yml file within the Bitbucket Repository.
23
+ # Export translations from Phrase Strings to Bitbucket according to the .phraseapp.yml file within the Bitbucket Repository. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Export is done asynchronously and may take several seconds depending on the project size.&lt;/i&gt;
24
24
  # @param id [String] ID
25
25
  # @param bitbucket_sync_export_parameters [BitbucketSyncExportParameters]
26
26
  # @param [Hash] opts the optional parameters
@@ -82,7 +82,7 @@ module Phrase
82
82
  end
83
83
 
84
84
  # Import to Phrase Strings from Bitbucket
85
- # Import translations from Bitbucket to Phrase Strings according to the .phraseapp.yml file within the Bitbucket repository.
85
+ # Import translations from Bitbucket to Phrase Strings according to the .phraseapp.yml file within the Bitbucket repository. <br><br><i>Note: Import is done asynchronously and may take several seconds depending on the project size.</i>
86
86
  # @param id [String] ID
87
87
  # @param bitbucket_sync_import_parameters [BitbucketSyncImportParameters]
88
88
  # @param [Hash] opts the optional parameters
@@ -94,7 +94,7 @@ module Phrase
94
94
  end
95
95
 
96
96
  # Import to Phrase Strings from Bitbucket
97
- # Import translations from Bitbucket to Phrase Strings according to the .phraseapp.yml file within the Bitbucket repository.
97
+ # Import translations from Bitbucket to Phrase Strings according to the .phraseapp.yml file within the Bitbucket repository. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Import is done asynchronously and may take several seconds depending on the project size.&lt;/i&gt;
98
98
  # @param id [String] ID
99
99
  # @param bitbucket_sync_import_parameters [BitbucketSyncImportParameters]
100
100
  # @param [Hash] opts the optional parameters
@@ -8,7 +8,7 @@ module Phrase
8
8
  @api_client = api_client
9
9
  end
10
10
  # Compare branches
11
- # Compare branch with main branch.
11
+ # Compare branch with main branch. <br><br><i>Note: Comparing a branch may take several minutes depending on the project size.</i>
12
12
  # @param project_id [String] Project ID
13
13
  # @param name [String] name
14
14
  # @param [Hash] opts the optional parameters
@@ -20,7 +20,7 @@ module Phrase
20
20
  end
21
21
 
22
22
  # Compare branches
23
- # Compare branch with main branch.
23
+ # Compare branch with main branch. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Comparing a branch may take several minutes depending on the project size.&lt;/i&gt;
24
24
  # @param project_id [String] Project ID
25
25
  # @param name [String] name
26
26
  # @param [Hash] opts the optional parameters
@@ -78,7 +78,7 @@ module Phrase
78
78
  end
79
79
 
80
80
  # Create a branch
81
- # Create a new branch.
81
+ # Create a new branch. <br><br><i>Note: Creating a new branch may take several minutes depending on the project size.</i>
82
82
  # @param project_id [String] Project ID
83
83
  # @param branch_create_parameters [BranchCreateParameters]
84
84
  # @param [Hash] opts the optional parameters
@@ -90,7 +90,7 @@ module Phrase
90
90
  end
91
91
 
92
92
  # Create a branch
93
- # Create a new branch.
93
+ # Create a new branch. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Creating a new branch may take several minutes depending on the project size.&lt;/i&gt;
94
94
  # @param project_id [String] Project ID
95
95
  # @param branch_create_parameters [BranchCreateParameters]
96
96
  # @param [Hash] opts the optional parameters
@@ -222,7 +222,7 @@ module Phrase
222
222
  end
223
223
 
224
224
  # Merge a branch
225
- # Merge an existing branch.
225
+ # Merge an existing branch. <br><br><i>Note: Merging a branch may take several minutes depending on diff size.</i>
226
226
  # @param project_id [String] Project ID
227
227
  # @param name [String] name
228
228
  # @param branch_merge_parameters [BranchMergeParameters]
@@ -235,7 +235,7 @@ module Phrase
235
235
  end
236
236
 
237
237
  # Merge a branch
238
- # Merge an existing branch.
238
+ # Merge an existing branch. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Merging a branch may take several minutes depending on diff size.&lt;/i&gt;
239
239
  # @param project_id [String] Project ID
240
240
  # @param name [String] name
241
241
  # @param branch_merge_parameters [BranchMergeParameters]
@@ -8,7 +8,7 @@ module Phrase
8
8
  @api_client = api_client
9
9
  end
10
10
  # Export from Phrase Strings to GitHub
11
- # Export translations from Phrase Strings to GitHub according to the .phraseapp.yml file within the GitHub repository.
11
+ # Export translations from Phrase Strings to GitHub according to the .phraseapp.yml file within the GitHub repository. <br><br><i>Note: Export is done asynchronously and may take several seconds depending on the project size.</i>
12
12
  # @param github_sync_export_parameters [GithubSyncExportParameters]
13
13
  # @param [Hash] opts the optional parameters
14
14
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
@@ -19,7 +19,7 @@ module Phrase
19
19
  end
20
20
 
21
21
  # Export from Phrase Strings to GitHub
22
- # Export translations from Phrase Strings to GitHub according to the .phraseapp.yml file within the GitHub repository.
22
+ # Export translations from Phrase Strings to GitHub according to the .phraseapp.yml file within the GitHub repository. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Export is done asynchronously and may take several seconds depending on the project size.&lt;/i&gt;
23
23
  # @param github_sync_export_parameters [GithubSyncExportParameters]
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
@@ -76,7 +76,7 @@ module Phrase
76
76
  end
77
77
 
78
78
  # Import to Phrase Strings from GitHub
79
- # Import files to Phrase Strings from your connected GitHub repository.
79
+ # Import files to Phrase Strings from your connected GitHub repository. <br><br><i>Note: Import is done asynchronously and may take several seconds depending on the project size.</i>
80
80
  # @param github_sync_import_parameters [GithubSyncImportParameters]
81
81
  # @param [Hash] opts the optional parameters
82
82
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
@@ -87,7 +87,7 @@ module Phrase
87
87
  end
88
88
 
89
89
  # Import to Phrase Strings from GitHub
90
- # Import files to Phrase Strings from your connected GitHub repository.
90
+ # Import files to Phrase Strings from your connected GitHub repository. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Import is done asynchronously and may take several seconds depending on the project size.&lt;/i&gt;
91
91
  # @param github_sync_import_parameters [GithubSyncImportParameters]
92
92
  # @param [Hash] opts the optional parameters
93
93
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
@@ -75,7 +75,7 @@ module Phrase
75
75
  end
76
76
 
77
77
  # Export from Phrase Strings to GitLab
78
- # Export translations from Phrase Strings to GitLab according to the .phraseapp.yml file within the GitLab repository.
78
+ # Export translations from Phrase Strings to GitLab according to the .phraseapp.yml file within the GitLab repository. <br><br><i>Note: Export is done asynchronously and may take several seconds depending on the project size.</i>
79
79
  # @param gitlab_sync_id [String] Gitlab Sync ID
80
80
  # @param gitlab_sync_export_parameters [GitlabSyncExportParameters]
81
81
  # @param [Hash] opts the optional parameters
@@ -87,7 +87,7 @@ module Phrase
87
87
  end
88
88
 
89
89
  # Export from Phrase Strings to GitLab
90
- # Export translations from Phrase Strings to GitLab according to the .phraseapp.yml file within the GitLab repository.
90
+ # Export translations from Phrase Strings to GitLab according to the .phraseapp.yml file within the GitLab repository. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Export is done asynchronously and may take several seconds depending on the project size.&lt;/i&gt;
91
91
  # @param gitlab_sync_id [String] Gitlab Sync ID
92
92
  # @param gitlab_sync_export_parameters [GitlabSyncExportParameters]
93
93
  # @param [Hash] opts the optional parameters
@@ -224,7 +224,7 @@ module Phrase
224
224
  end
225
225
 
226
226
  # Import from GitLab to Phrase
227
- # Import translations from GitLab to Phrase Strings according to the .phraseapp.yml file within the GitLab repository.
227
+ # Import translations from GitLab to Phrase Strings according to the .phraseapp.yml file within the GitLab repository. <br><br><i>Note: Import is done asynchronously and may take several seconds depending on the project size.</i>
228
228
  # @param gitlab_sync_id [String] Gitlab Sync ID
229
229
  # @param gitlab_sync_import_parameters [GitlabSyncImportParameters]
230
230
  # @param [Hash] opts the optional parameters
@@ -236,7 +236,7 @@ module Phrase
236
236
  end
237
237
 
238
238
  # Import from GitLab to Phrase
239
- # Import translations from GitLab to Phrase Strings according to the .phraseapp.yml file within the GitLab repository.
239
+ # Import translations from GitLab to Phrase Strings according to the .phraseapp.yml file within the GitLab repository. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Import is done asynchronously and may take several seconds depending on the project size.&lt;/i&gt;
240
240
  # @param gitlab_sync_id [String] Gitlab Sync ID
241
241
  # @param gitlab_sync_import_parameters [GitlabSyncImportParameters]
242
242
  # @param [Hash] opts the optional parameters
@@ -174,7 +174,7 @@ module Phrase
174
174
  # @param [Hash] opts the optional parameters
175
175
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
176
176
  # @option opts [String] :branch specify the branch to use
177
- # @return [Object]
177
+ # @return [JobComment]
178
178
  def job_comment_show(project_id, job_id, id, opts = {})
179
179
  data, _status_code, _headers = job_comment_show_with_http_info(project_id, job_id, id, opts)
180
180
  data
@@ -188,7 +188,7 @@ module Phrase
188
188
  # @param [Hash] opts the optional parameters
189
189
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
190
190
  # @option opts [String] :branch specify the branch to use
191
- # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
191
+ # @return [Array<(Response<(JobComment)>, Integer, Hash)>] Response<(JobComment)> data, response status code and response headers
192
192
  def job_comment_show_with_http_info(project_id, job_id, id, opts = {})
193
193
  if @api_client.config.debugging
194
194
  @api_client.config.logger.debug 'Calling API: JobCommentsApi.job_comment_show ...'
@@ -225,7 +225,7 @@ module Phrase
225
225
  post_body = opts[:body]
226
226
 
227
227
  # return_type
228
- return_type = opts[:return_type] || 'Object'
228
+ return_type = opts[:return_type] || 'JobComment'
229
229
 
230
230
  # auth_names
231
231
  auth_names = opts[:auth_names] || ['Basic', 'Token']
@@ -255,7 +255,7 @@ module Phrase
255
255
  # @param job_comment_update_parameters [JobCommentUpdateParameters]
256
256
  # @param [Hash] opts the optional parameters
257
257
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
258
- # @return [Object]
258
+ # @return [JobComment]
259
259
  def job_comment_update(project_id, key_id, id, job_comment_update_parameters, opts = {})
260
260
  data, _status_code, _headers = job_comment_update_with_http_info(project_id, key_id, id, job_comment_update_parameters, opts)
261
261
  data
@@ -269,7 +269,7 @@ module Phrase
269
269
  # @param job_comment_update_parameters [JobCommentUpdateParameters]
270
270
  # @param [Hash] opts the optional parameters
271
271
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
272
- # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
272
+ # @return [Array<(Response<(JobComment)>, Integer, Hash)>] Response<(JobComment)> data, response status code and response headers
273
273
  def job_comment_update_with_http_info(project_id, key_id, id, job_comment_update_parameters, opts = {})
274
274
  if @api_client.config.debugging
275
275
  @api_client.config.logger.debug 'Calling API: JobCommentsApi.job_comment_update ...'
@@ -311,7 +311,7 @@ module Phrase
311
311
  post_body = opts[:body] || @api_client.object_to_http_body(job_comment_update_parameters)
312
312
 
313
313
  # return_type
314
- return_type = opts[:return_type] || 'Object'
314
+ return_type = opts[:return_type] || 'JobComment'
315
315
 
316
316
  # auth_names
317
317
  auth_names = opts[:auth_names] || ['Basic', 'Token']
@@ -340,7 +340,7 @@ module Phrase
340
340
  # @param [Hash] opts the optional parameters
341
341
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
342
342
  # @option opts [String] :branch specify the branch to use
343
- # @return [Array<Object>]
343
+ # @return [Array<JobComment>]
344
344
  def job_comments_list(project_id, job_id, opts = {})
345
345
  data, _status_code, _headers = job_comments_list_with_http_info(project_id, job_id, opts)
346
346
  data
@@ -353,7 +353,7 @@ module Phrase
353
353
  # @param [Hash] opts the optional parameters
354
354
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
355
355
  # @option opts [String] :branch specify the branch to use
356
- # @return [Array<(Response<(Array<Object>)>, Integer, Hash)>] Response<(Array<Object>)> data, response status code and response headers
356
+ # @return [Array<(Response<(Array<JobComment>)>, Integer, Hash)>] Response<(Array<JobComment>)> data, response status code and response headers
357
357
  def job_comments_list_with_http_info(project_id, job_id, opts = {})
358
358
  if @api_client.config.debugging
359
359
  @api_client.config.logger.debug 'Calling API: JobCommentsApi.job_comments_list ...'
@@ -386,7 +386,7 @@ module Phrase
386
386
  post_body = opts[:body]
387
387
 
388
388
  # return_type
389
- return_type = opts[:return_type] || 'Array<Object>'
389
+ return_type = opts[:return_type] || 'Array<JobComment>'
390
390
 
391
391
  # auth_names
392
392
  auth_names = opts[:auth_names] || ['Basic', 'Token']