phrase 2.8.3 → 2.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (127) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +31 -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/OrganizationJobTemplate.md +25 -0
  27. data/docs/OrganizationJobTemplateCreateParameters.md +19 -0
  28. data/docs/OrganizationJobTemplateDetails.md +31 -0
  29. data/docs/OrganizationJobTemplateLocaleUpdateParameters.md +27 -0
  30. data/docs/OrganizationJobTemplateLocalesApi.md +341 -0
  31. data/docs/OrganizationJobTemplateLocalesCreateParameters.md +27 -0
  32. data/docs/OrganizationJobTemplateUpdateParameters.md +19 -0
  33. data/docs/OrganizationJobTemplatesApi.md +331 -0
  34. data/docs/Project.md +2 -0
  35. data/docs/ProjectCreateParameters.md +5 -1
  36. data/docs/ProjectDetails.md +2 -0
  37. data/docs/ProjectUpdateParameters.md +5 -1
  38. data/docs/SearchApi.md +1 -1
  39. data/docs/TranslationsApi.md +23 -19
  40. data/docs/TranslationsExcludeParameters.md +1 -1
  41. data/docs/TranslationsIncludeParameters.md +1 -1
  42. data/docs/TranslationsReviewParameters.md +1 -1
  43. data/docs/TranslationsSearchParameters.md +1 -1
  44. data/docs/TranslationsUnverifyParameters.md +1 -1
  45. data/docs/TranslationsVerifyParameters.md +1 -1
  46. data/docs/UploadsApi.md +3 -3
  47. data/lib/phrase/api/bitbucket_sync_api.rb +4 -4
  48. data/lib/phrase/api/branches_api.rb +6 -6
  49. data/lib/phrase/api/git_hub_sync_api.rb +4 -4
  50. data/lib/phrase/api/git_lab_sync_api.rb +4 -4
  51. data/lib/phrase/api/job_comments_api.rb +9 -9
  52. data/lib/phrase/api/job_template_locales_api.rb +12 -12
  53. data/lib/phrase/api/job_templates_api.rb +72 -72
  54. data/lib/phrase/api/locales_api.rb +10 -4
  55. data/lib/phrase/api/notification_groups_api.rb +6 -6
  56. data/lib/phrase/api/notifications_api.rb +6 -6
  57. data/lib/phrase/api/organization_job_template_locales_api.rb +408 -0
  58. data/lib/phrase/api/organization_job_templates_api.rb +378 -0
  59. data/lib/phrase/api/search_api.rb +2 -2
  60. data/lib/phrase/api/translations_api.rb +20 -14
  61. data/lib/phrase/api/uploads_api.rb +2 -2
  62. data/lib/phrase/models/job_locale.rb +13 -2
  63. data/lib/phrase/models/job_locale_update_parameters.rb +28 -4
  64. data/lib/phrase/models/job_locales_create_parameters.rb +33 -4
  65. data/lib/phrase/models/job_template_details.rb +285 -0
  66. data/lib/phrase/models/job_template_details1.rb +214 -0
  67. data/lib/phrase/models/job_template_locale_update_parameters.rb +28 -9
  68. data/lib/phrase/models/{job_template_locale.rb → job_template_locales.rb} +18 -7
  69. data/lib/phrase/models/job_template_locales_create_parameters.rb +28 -4
  70. data/lib/phrase/models/keys_search_parameters.rb +1 -1
  71. data/lib/phrase/models/locale_team_preview.rb +212 -0
  72. data/lib/phrase/models/{job_template_user_preview.rb → locale_user_preview.rb} +3 -3
  73. data/lib/phrase/models/notification_group_detail.rb +1 -1
  74. data/lib/phrase/models/organization_job_template.rb +230 -0
  75. data/lib/phrase/models/organization_job_template_create_parameters.rb +210 -0
  76. data/lib/phrase/models/organization_job_template_details.rb +267 -0
  77. data/lib/phrase/models/organization_job_template_locale_update_parameters.rb +253 -0
  78. data/lib/phrase/models/organization_job_template_locales_create_parameters.rb +263 -0
  79. data/lib/phrase/models/organization_job_template_update_parameters.rb +210 -0
  80. data/lib/phrase/models/project.rb +10 -1
  81. data/lib/phrase/models/project_create_parameters.rb +22 -2
  82. data/lib/phrase/models/project_details.rb +10 -1
  83. data/lib/phrase/models/project_update_parameters.rb +22 -2
  84. data/lib/phrase/models/translations_exclude_parameters.rb +1 -1
  85. data/lib/phrase/models/translations_include_parameters.rb +1 -1
  86. data/lib/phrase/models/translations_review_parameters.rb +1 -1
  87. data/lib/phrase/models/translations_search_parameters.rb +1 -1
  88. data/lib/phrase/models/translations_unverify_parameters.rb +1 -1
  89. data/lib/phrase/models/translations_verify_parameters.rb +1 -1
  90. data/lib/phrase/version.rb +1 -1
  91. data/lib/phrase.rb +13 -2
  92. data/spec/api/bitbucket_sync_api_spec.rb +2 -2
  93. data/spec/api/branches_api_spec.rb +3 -3
  94. data/spec/api/git_hub_sync_api_spec.rb +2 -2
  95. data/spec/api/git_lab_sync_api_spec.rb +2 -2
  96. data/spec/api/job_comments_api_spec.rb +3 -3
  97. data/spec/api/job_template_locales_api_spec.rb +4 -4
  98. data/spec/api/job_templates_api_spec.rb +17 -17
  99. data/spec/api/locales_api_spec.rb +4 -2
  100. data/spec/api/notification_groups_api_spec.rb +2 -2
  101. data/spec/api/notifications_api_spec.rb +2 -2
  102. data/spec/api/organization_job_template_locales_api_spec.rb +100 -0
  103. data/spec/api/organization_job_templates_api_spec.rb +95 -0
  104. data/spec/api/search_api_spec.rb +1 -1
  105. data/spec/api/translations_api_spec.rb +9 -7
  106. data/spec/api/uploads_api_spec.rb +1 -1
  107. data/spec/models/job_locale_spec.rb +6 -0
  108. data/spec/models/job_locale_update_parameters_spec.rb +12 -0
  109. data/spec/models/job_locales_create_parameters_spec.rb +12 -0
  110. data/spec/models/job_template_details1_spec.rb +41 -0
  111. data/spec/models/job_template_details_spec.rb +83 -0
  112. data/spec/models/job_template_locale_update_parameters_spec.rb +12 -0
  113. data/spec/models/job_template_locales_create_parameters_spec.rb +12 -0
  114. data/spec/models/{job_template_locale_spec.rb → job_template_locales_spec.rb} +12 -6
  115. data/spec/models/locale_team_preview_spec.rb +41 -0
  116. data/spec/models/{job_template_user_preview_spec.rb → locale_user_preview_spec.rb} +6 -6
  117. data/spec/models/organization_job_template_create_parameters_spec.rb +35 -0
  118. data/spec/models/organization_job_template_details_spec.rb +71 -0
  119. data/spec/models/organization_job_template_locale_update_parameters_spec.rb +59 -0
  120. data/spec/models/organization_job_template_locales_create_parameters_spec.rb +59 -0
  121. data/spec/models/organization_job_template_spec.rb +53 -0
  122. data/spec/models/organization_job_template_update_parameters_spec.rb +35 -0
  123. data/spec/models/project_create_parameters_spec.rb +12 -0
  124. data/spec/models/project_details_spec.rb +6 -0
  125. data/spec/models/project_spec.rb +6 -0
  126. data/spec/models/project_update_parameters_spec.rb +12 -0
  127. metadata +269 -225
@@ -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).<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>. | [optional]
10
+ **q** | **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>. | [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).<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>. | [optional]
8
+ **q** | **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>. | [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).<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>. | [optional]
9
+ **q** | **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>. | [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']
@@ -94,7 +94,7 @@ module Phrase
94
94
  # @param [Hash] opts the optional parameters
95
95
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
96
96
  # @option opts [String] :branch specify the branch to use
97
- # @return [Object]
97
+ # @return [JobTemplateLocales]
98
98
  def job_template_locale_show(project_id, job_template_id, job_template_locale_id, opts = {})
99
99
  data, _status_code, _headers = job_template_locale_show_with_http_info(project_id, job_template_id, job_template_locale_id, opts)
100
100
  data
@@ -108,7 +108,7 @@ module Phrase
108
108
  # @param [Hash] opts the optional parameters
109
109
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
110
110
  # @option opts [String] :branch specify the branch to use
111
- # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
111
+ # @return [Array<(Response<(JobTemplateLocales)>, Integer, Hash)>] Response<(JobTemplateLocales)> data, response status code and response headers
112
112
  def job_template_locale_show_with_http_info(project_id, job_template_id, job_template_locale_id, opts = {})
113
113
  if @api_client.config.debugging
114
114
  @api_client.config.logger.debug 'Calling API: JobTemplateLocalesApi.job_template_locale_show ...'
@@ -145,7 +145,7 @@ module Phrase
145
145
  post_body = opts[:body]
146
146
 
147
147
  # return_type
148
- return_type = opts[:return_type] || 'Object'
148
+ return_type = opts[:return_type] || 'JobTemplateLocales'
149
149
 
150
150
  # auth_names
151
151
  auth_names = opts[:auth_names] || ['Basic', 'Token']
@@ -175,7 +175,7 @@ module Phrase
175
175
  # @param job_template_locale_update_parameters [JobTemplateLocaleUpdateParameters]
176
176
  # @param [Hash] opts the optional parameters
177
177
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
178
- # @return [Object]
178
+ # @return [JobTemplateLocales]
179
179
  def job_template_locale_update(project_id, job_template_id, job_template_locale_id, job_template_locale_update_parameters, opts = {})
180
180
  data, _status_code, _headers = job_template_locale_update_with_http_info(project_id, job_template_id, job_template_locale_id, job_template_locale_update_parameters, opts)
181
181
  data
@@ -189,7 +189,7 @@ module Phrase
189
189
  # @param job_template_locale_update_parameters [JobTemplateLocaleUpdateParameters]
190
190
  # @param [Hash] opts the optional parameters
191
191
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
192
- # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
192
+ # @return [Array<(Response<(JobTemplateLocales)>, Integer, Hash)>] Response<(JobTemplateLocales)> data, response status code and response headers
193
193
  def job_template_locale_update_with_http_info(project_id, job_template_id, job_template_locale_id, job_template_locale_update_parameters, opts = {})
194
194
  if @api_client.config.debugging
195
195
  @api_client.config.logger.debug 'Calling API: JobTemplateLocalesApi.job_template_locale_update ...'
@@ -231,7 +231,7 @@ module Phrase
231
231
  post_body = opts[:body] || @api_client.object_to_http_body(job_template_locale_update_parameters)
232
232
 
233
233
  # return_type
234
- return_type = opts[:return_type] || 'Object'
234
+ return_type = opts[:return_type] || 'JobTemplateLocales'
235
235
 
236
236
  # auth_names
237
237
  auth_names = opts[:auth_names] || ['Basic', 'Token']
@@ -260,7 +260,7 @@ module Phrase
260
260
  # @param job_template_locales_create_parameters [JobTemplateLocalesCreateParameters]
261
261
  # @param [Hash] opts the optional parameters
262
262
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
263
- # @return [JobTemplateLocale]
263
+ # @return [JobTemplateLocales]
264
264
  def job_template_locales_create(project_id, job_template_id, job_template_locales_create_parameters, opts = {})
265
265
  data, _status_code, _headers = job_template_locales_create_with_http_info(project_id, job_template_id, job_template_locales_create_parameters, opts)
266
266
  data
@@ -273,7 +273,7 @@ module Phrase
273
273
  # @param job_template_locales_create_parameters [JobTemplateLocalesCreateParameters]
274
274
  # @param [Hash] opts the optional parameters
275
275
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
276
- # @return [Array<(Response<(JobTemplateLocale)>, Integer, Hash)>] Response<(JobTemplateLocale)> data, response status code and response headers
276
+ # @return [Array<(Response<(JobTemplateLocales)>, Integer, Hash)>] Response<(JobTemplateLocales)> data, response status code and response headers
277
277
  def job_template_locales_create_with_http_info(project_id, job_template_id, job_template_locales_create_parameters, opts = {})
278
278
  if @api_client.config.debugging
279
279
  @api_client.config.logger.debug 'Calling API: JobTemplateLocalesApi.job_template_locales_create ...'
@@ -311,7 +311,7 @@ module Phrase
311
311
  post_body = opts[:body] || @api_client.object_to_http_body(job_template_locales_create_parameters)
312
312
 
313
313
  # return_type
314
- return_type = opts[:return_type] || 'JobTemplateLocale'
314
+ return_type = opts[:return_type] || 'JobTemplateLocales'
315
315
 
316
316
  # auth_names
317
317
  auth_names = opts[:auth_names] || ['Basic', 'Token']
@@ -342,7 +342,7 @@ module Phrase
342
342
  # @option opts [Integer] :page Page number
343
343
  # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
344
344
  # @option opts [String] :branch specify the branch to use
345
- # @return [Array<Object>]
345
+ # @return [Array<JobTemplateLocales>]
346
346
  def job_template_locales_list(project_id, job_template_id, opts = {})
347
347
  data, _status_code, _headers = job_template_locales_list_with_http_info(project_id, job_template_id, opts)
348
348
  data
@@ -357,7 +357,7 @@ module Phrase
357
357
  # @option opts [Integer] :page Page number
358
358
  # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
359
359
  # @option opts [String] :branch specify the branch to use
360
- # @return [Array<(Response<(Array<Object>)>, Integer, Hash)>] Response<(Array<Object>)> data, response status code and response headers
360
+ # @return [Array<(Response<(Array<JobTemplateLocales>)>, Integer, Hash)>] Response<(Array<JobTemplateLocales>)> data, response status code and response headers
361
361
  def job_template_locales_list_with_http_info(project_id, job_template_id, opts = {})
362
362
  if @api_client.config.debugging
363
363
  @api_client.config.logger.debug 'Calling API: JobTemplateLocalesApi.job_template_locales_list ...'
@@ -392,7 +392,7 @@ module Phrase
392
392
  post_body = opts[:body]
393
393
 
394
394
  # return_type
395
- return_type = opts[:return_type] || 'Array<Object>'
395
+ return_type = opts[:return_type] || 'Array<JobTemplateLocales>'
396
396
 
397
397
  # auth_names
398
398
  auth_names = opts[:auth_names] || ['Basic', 'Token']