phrase 2.8.2 → 2.8.7

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 (178) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +15 -12
  4. data/docs/AccountsApi.md +2 -2
  5. data/docs/AuthorizationsApi.md +2 -2
  6. data/docs/BitbucketSyncApi.md +2 -2
  7. data/docs/BlacklistedKeysApi.md +2 -2
  8. data/docs/BranchesApi.md +5 -5
  9. data/docs/CommentsApi.md +2 -2
  10. data/docs/DistributionsApi.md +2 -2
  11. data/docs/DocumentsApi.md +2 -2
  12. data/docs/GitHubSyncApi.md +2 -2
  13. data/docs/GitLabSyncApi.md +4 -4
  14. data/docs/GlossariesApi.md +2 -2
  15. data/docs/GlossaryTermsApi.md +2 -2
  16. data/docs/InvitationsApi.md +2 -2
  17. data/docs/JobCommentsApi.md +6 -6
  18. data/docs/JobLocale.md +3 -1
  19. data/docs/JobLocaleUpdateParameters.md +5 -1
  20. data/docs/JobLocalesApi.md +2 -2
  21. data/docs/JobLocalesCreateParameters.md +6 -2
  22. data/docs/JobTemplateDetails.md +35 -0
  23. data/docs/JobTemplateDetails1.md +21 -0
  24. data/docs/JobTemplateLocaleUpdateParameters.md +6 -2
  25. data/docs/{JobTemplateLocale.md → JobTemplateLocales.md} +6 -4
  26. data/docs/JobTemplateLocalesApi.md +10 -10
  27. data/docs/JobTemplateLocalesCreateParameters.md +5 -1
  28. data/docs/JobTemplatesApi.md +41 -41
  29. data/docs/JobsApi.md +4 -4
  30. data/docs/KeysApi.md +4 -4
  31. data/docs/KeysSearchParameters.md +1 -1
  32. data/docs/LocaleTeamPreview.md +21 -0
  33. data/docs/{JobTemplateUserPreview.md → LocaleUserPreview.md} +2 -2
  34. data/docs/LocalesApi.md +12 -8
  35. data/docs/MembersApi.md +2 -2
  36. data/docs/NotificationGroupDetail.md +1 -1
  37. data/docs/NotificationGroupsApi.md +6 -6
  38. data/docs/NotificationsApi.md +8 -6
  39. data/docs/OrdersApi.md +2 -2
  40. data/docs/Project.md +2 -0
  41. data/docs/ProjectCreateParameters.md +5 -1
  42. data/docs/ProjectDetails.md +2 -0
  43. data/docs/ProjectUpdateParameters.md +5 -1
  44. data/docs/ProjectsApi.md +2 -2
  45. data/docs/ReleasesApi.md +2 -2
  46. data/docs/ScreenshotMarkersApi.md +2 -2
  47. data/docs/ScreenshotsApi.md +2 -2
  48. data/docs/SearchApi.md +1 -1
  49. data/docs/SpacesApi.md +4 -4
  50. data/docs/StyleGuidesApi.md +2 -2
  51. data/docs/TagsApi.md +2 -2
  52. data/docs/TeamsApi.md +2 -2
  53. data/docs/TranslationsApi.md +31 -27
  54. data/docs/TranslationsExcludeParameters.md +1 -1
  55. data/docs/TranslationsIncludeParameters.md +1 -1
  56. data/docs/TranslationsReviewParameters.md +1 -1
  57. data/docs/TranslationsSearchParameters.md +1 -1
  58. data/docs/TranslationsUnverifyParameters.md +1 -1
  59. data/docs/TranslationsVerifyParameters.md +1 -1
  60. data/docs/UploadsApi.md +5 -5
  61. data/docs/VariablesApi.md +2 -2
  62. data/docs/VersionsHistoryApi.md +2 -2
  63. data/docs/WebhooksApi.md +2 -2
  64. data/lib/phrase/api/accounts_api.rb +2 -2
  65. data/lib/phrase/api/authorizations_api.rb +2 -2
  66. data/lib/phrase/api/bitbucket_sync_api.rb +4 -4
  67. data/lib/phrase/api/blacklisted_keys_api.rb +2 -2
  68. data/lib/phrase/api/branches_api.rb +8 -8
  69. data/lib/phrase/api/comments_api.rb +2 -2
  70. data/lib/phrase/api/distributions_api.rb +2 -2
  71. data/lib/phrase/api/documents_api.rb +2 -2
  72. data/lib/phrase/api/git_hub_sync_api.rb +4 -4
  73. data/lib/phrase/api/git_lab_sync_api.rb +6 -6
  74. data/lib/phrase/api/glossaries_api.rb +2 -2
  75. data/lib/phrase/api/glossary_terms_api.rb +2 -2
  76. data/lib/phrase/api/invitations_api.rb +2 -2
  77. data/lib/phrase/api/job_comments_api.rb +9 -9
  78. data/lib/phrase/api/job_locales_api.rb +2 -2
  79. data/lib/phrase/api/job_template_locales_api.rb +14 -14
  80. data/lib/phrase/api/job_templates_api.rb +72 -72
  81. data/lib/phrase/api/jobs_api.rb +4 -4
  82. data/lib/phrase/api/keys_api.rb +4 -4
  83. data/lib/phrase/api/locales_api.rb +14 -8
  84. data/lib/phrase/api/members_api.rb +2 -2
  85. data/lib/phrase/api/notification_groups_api.rb +8 -8
  86. data/lib/phrase/api/notifications_api.rb +11 -8
  87. data/lib/phrase/api/orders_api.rb +2 -2
  88. data/lib/phrase/api/projects_api.rb +2 -2
  89. data/lib/phrase/api/releases_api.rb +2 -2
  90. data/lib/phrase/api/screenshot_markers_api.rb +2 -2
  91. data/lib/phrase/api/screenshots_api.rb +2 -2
  92. data/lib/phrase/api/search_api.rb +2 -2
  93. data/lib/phrase/api/spaces_api.rb +4 -4
  94. data/lib/phrase/api/style_guides_api.rb +2 -2
  95. data/lib/phrase/api/tags_api.rb +2 -2
  96. data/lib/phrase/api/teams_api.rb +2 -2
  97. data/lib/phrase/api/translations_api.rb +28 -22
  98. data/lib/phrase/api/uploads_api.rb +4 -4
  99. data/lib/phrase/api/variables_api.rb +2 -2
  100. data/lib/phrase/api/versions_history_api.rb +2 -2
  101. data/lib/phrase/api/webhooks_api.rb +2 -2
  102. data/lib/phrase/models/job_locale.rb +13 -2
  103. data/lib/phrase/models/job_locale_update_parameters.rb +28 -4
  104. data/lib/phrase/models/job_locales_create_parameters.rb +33 -4
  105. data/lib/phrase/models/job_template_details.rb +285 -0
  106. data/lib/phrase/models/job_template_details1.rb +214 -0
  107. data/lib/phrase/models/job_template_locale_update_parameters.rb +28 -9
  108. data/lib/phrase/models/{job_template_locale.rb → job_template_locales.rb} +18 -7
  109. data/lib/phrase/models/job_template_locales_create_parameters.rb +28 -4
  110. data/lib/phrase/models/keys_search_parameters.rb +1 -1
  111. data/lib/phrase/models/locale_team_preview.rb +212 -0
  112. data/lib/phrase/models/{job_template_user_preview.rb → locale_user_preview.rb} +3 -3
  113. data/lib/phrase/models/notification_group_detail.rb +1 -1
  114. data/lib/phrase/models/project.rb +10 -1
  115. data/lib/phrase/models/project_create_parameters.rb +22 -2
  116. data/lib/phrase/models/project_details.rb +10 -1
  117. data/lib/phrase/models/project_update_parameters.rb +22 -2
  118. data/lib/phrase/models/translations_exclude_parameters.rb +1 -1
  119. data/lib/phrase/models/translations_include_parameters.rb +1 -1
  120. data/lib/phrase/models/translations_review_parameters.rb +1 -1
  121. data/lib/phrase/models/translations_search_parameters.rb +1 -1
  122. data/lib/phrase/models/translations_unverify_parameters.rb +1 -1
  123. data/lib/phrase/models/translations_verify_parameters.rb +1 -1
  124. data/lib/phrase/version.rb +1 -1
  125. data/lib/phrase.rb +5 -2
  126. data/spec/api/accounts_api_spec.rb +1 -1
  127. data/spec/api/authorizations_api_spec.rb +1 -1
  128. data/spec/api/bitbucket_sync_api_spec.rb +2 -2
  129. data/spec/api/blacklisted_keys_api_spec.rb +1 -1
  130. data/spec/api/branches_api_spec.rb +4 -4
  131. data/spec/api/comments_api_spec.rb +1 -1
  132. data/spec/api/distributions_api_spec.rb +1 -1
  133. data/spec/api/documents_api_spec.rb +1 -1
  134. data/spec/api/git_hub_sync_api_spec.rb +2 -2
  135. data/spec/api/git_lab_sync_api_spec.rb +3 -3
  136. data/spec/api/glossaries_api_spec.rb +1 -1
  137. data/spec/api/glossary_terms_api_spec.rb +1 -1
  138. data/spec/api/invitations_api_spec.rb +1 -1
  139. data/spec/api/job_comments_api_spec.rb +3 -3
  140. data/spec/api/job_locales_api_spec.rb +1 -1
  141. data/spec/api/job_template_locales_api_spec.rb +5 -5
  142. data/spec/api/job_templates_api_spec.rb +18 -18
  143. data/spec/api/jobs_api_spec.rb +2 -2
  144. data/spec/api/keys_api_spec.rb +2 -2
  145. data/spec/api/locales_api_spec.rb +6 -4
  146. data/spec/api/members_api_spec.rb +1 -1
  147. data/spec/api/notification_groups_api_spec.rb +3 -3
  148. data/spec/api/notifications_api_spec.rb +4 -3
  149. data/spec/api/orders_api_spec.rb +1 -1
  150. data/spec/api/projects_api_spec.rb +1 -1
  151. data/spec/api/releases_api_spec.rb +1 -1
  152. data/spec/api/screenshot_markers_api_spec.rb +1 -1
  153. data/spec/api/screenshots_api_spec.rb +1 -1
  154. data/spec/api/search_api_spec.rb +1 -1
  155. data/spec/api/spaces_api_spec.rb +2 -2
  156. data/spec/api/style_guides_api_spec.rb +1 -1
  157. data/spec/api/tags_api_spec.rb +1 -1
  158. data/spec/api/teams_api_spec.rb +1 -1
  159. data/spec/api/translations_api_spec.rb +13 -11
  160. data/spec/api/uploads_api_spec.rb +2 -2
  161. data/spec/api/variables_api_spec.rb +1 -1
  162. data/spec/api/versions_history_api_spec.rb +1 -1
  163. data/spec/api/webhooks_api_spec.rb +1 -1
  164. data/spec/models/job_locale_spec.rb +6 -0
  165. data/spec/models/job_locale_update_parameters_spec.rb +12 -0
  166. data/spec/models/job_locales_create_parameters_spec.rb +12 -0
  167. data/spec/models/job_template_details1_spec.rb +41 -0
  168. data/spec/models/job_template_details_spec.rb +83 -0
  169. data/spec/models/job_template_locale_update_parameters_spec.rb +12 -0
  170. data/spec/models/job_template_locales_create_parameters_spec.rb +12 -0
  171. data/spec/models/{job_template_locale_spec.rb → job_template_locales_spec.rb} +12 -6
  172. data/spec/models/locale_team_preview_spec.rb +41 -0
  173. data/spec/models/{job_template_user_preview_spec.rb → locale_user_preview_spec.rb} +6 -6
  174. data/spec/models/project_create_parameters_spec.rb +12 -0
  175. data/spec/models/project_details_spec.rb +6 -0
  176. data/spec/models/project_spec.rb +6 -0
  177. data/spec/models/project_update_parameters_spec.rb +12 -0
  178. metadata +237 -225
data/docs/TranslationsSearchParameters.md CHANGED
@@ -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
 
data/docs/TranslationsUnverifyParameters.md CHANGED
@@ -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
 
data/docs/TranslationsVerifyParameters.md CHANGED
@@ -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
@@ -195,7 +195,7 @@ project_id = 'project_id_example' # String | Project ID
195
195
  opts = {
196
196
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
197
197
  page: 1, # Integer | Page number
198
- per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
198
+ per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
199
199
  branch: 'my-feature-branch' # String | specify the branch to use
200
200
  }
201
201
 
@@ -216,7 +216,7 @@ Name | Type | Description | Notes
216
216
  **project_id** | **String**| Project ID |
217
217
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
218
218
  **page** | **Integer**| Page number | [optional]
219
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
219
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
220
220
  **branch** | **String**| specify the branch to use | [optional]
221
221
 
222
222
  ### Return type
data/docs/VariablesApi.md CHANGED
@@ -294,7 +294,7 @@ project_id = 'project_id_example' # String | Project ID
294
294
  opts = {
295
295
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
296
296
  page: 1, # Integer | Page number
297
- per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
297
+ per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
298
298
  }
299
299
 
300
300
  begin
@@ -314,7 +314,7 @@ Name | Type | Description | Notes
314
314
  **project_id** | **String**| Project ID |
315
315
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
316
316
  **page** | **Integer**| Page number | [optional]
317
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
317
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
318
318
 
319
319
  ### Return type
320
320
 
data/docs/VersionsHistoryApi.md CHANGED
@@ -106,7 +106,7 @@ translation_id = 'translation_id_example' # String | Translation ID
106
106
  opts = {
107
107
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
108
108
  page: 1, # Integer | Page number
109
- per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
109
+ per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
110
110
  branch: 'my-feature-branch' # String | specify the branch to use
111
111
  }
112
112
 
@@ -128,7 +128,7 @@ Name | Type | Description | Notes
128
128
  **translation_id** | **String**| Translation ID |
129
129
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
130
130
  **page** | **Integer**| Page number | [optional]
131
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
131
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
132
132
  **branch** | **String**| specify the branch to use | [optional]
133
133
 
134
134
  ### Return type
data/docs/WebhooksApi.md CHANGED
@@ -357,7 +357,7 @@ project_id = 'project_id_example' # String | Project ID
357
357
  opts = {
358
358
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
359
359
  page: 1, # Integer | Page number
360
- per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
360
+ per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
361
361
  }
362
362
 
363
363
  begin
@@ -377,7 +377,7 @@ Name | Type | Description | Notes
377
377
  **project_id** | **String**| Project ID |
378
378
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
379
379
  **page** | **Integer**| Page number | [optional]
380
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
380
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
381
381
 
382
382
  ### Return type
383
383
 
data/lib/phrase/api/accounts_api.rb CHANGED
@@ -78,7 +78,7 @@ module Phrase
78
78
  # @param [Hash] opts the optional parameters
79
79
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
80
80
  # @option opts [Integer] :page Page number
81
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
81
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
82
82
  # @return [Array<Account>]
83
83
  def accounts_list(opts = {})
84
84
  data, _status_code, _headers = accounts_list_with_http_info(opts)
@@ -90,7 +90,7 @@ module Phrase
90
90
  # @param [Hash] opts the optional parameters
91
91
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
92
92
  # @option opts [Integer] :page Page number
93
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
93
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
94
94
  # @return [Array<(Response<(Array<Account>)>, Integer, Hash)>] Response<(Array<Account>)> data, response status code and response headers
95
95
  def accounts_list_with_http_info(opts = {})
96
96
  if @api_client.config.debugging
data/lib/phrase/api/authorizations_api.rb CHANGED
@@ -284,7 +284,7 @@ module Phrase
284
284
  # @param [Hash] opts the optional parameters
285
285
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
286
286
  # @option opts [Integer] :page Page number
287
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
287
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
288
288
  # @return [Array<Authorization>]
289
289
  def authorizations_list(opts = {})
290
290
  data, _status_code, _headers = authorizations_list_with_http_info(opts)
@@ -296,7 +296,7 @@ module Phrase
296
296
  # @param [Hash] opts the optional parameters
297
297
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
298
298
  # @option opts [Integer] :page Page number
299
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
299
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
300
300
  # @return [Array<(Response<(Array<Authorization>)>, Integer, Hash)>] Response<(Array<Authorization>)> data, response status code and response headers
301
301
  def authorizations_list_with_http_info(opts = {})
302
302
  if @api_client.config.debugging
data/lib/phrase/api/bitbucket_sync_api.rb CHANGED
@@ -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
data/lib/phrase/api/blacklisted_keys_api.rb CHANGED
@@ -309,7 +309,7 @@ module Phrase
309
309
  # @param [Hash] opts the optional parameters
310
310
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
311
311
  # @option opts [Integer] :page Page number
312
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
312
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
313
313
  # @option opts [String] :branch specify the branch to use
314
314
  # @return [Array<BlacklistedKey>]
315
315
  def blacklisted_keys_list(project_id, opts = {})
@@ -323,7 +323,7 @@ module Phrase
323
323
  # @param [Hash] opts the optional parameters
324
324
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
325
325
  # @option opts [Integer] :page Page number
326
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
326
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
327
327
  # @option opts [String] :branch specify the branch to use
328
328
  # @return [Array<(Response<(Array<BlacklistedKey>)>, Integer, Hash)>] Response<(Array<BlacklistedKey>)> data, response status code and response headers
329
329
  def blacklisted_keys_list_with_http_info(project_id, opts = {})
data/lib/phrase/api/branches_api.rb CHANGED
@@ -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]
@@ -457,7 +457,7 @@ module Phrase
457
457
  # @param [Hash] opts the optional parameters
458
458
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
459
459
  # @option opts [Integer] :page Page number
460
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
460
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
461
461
  # @return [Array<Branch>]
462
462
  def branches_list(project_id, opts = {})
463
463
  data, _status_code, _headers = branches_list_with_http_info(project_id, opts)
@@ -470,7 +470,7 @@ module Phrase
470
470
  # @param [Hash] opts the optional parameters
471
471
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
472
472
  # @option opts [Integer] :page Page number
473
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
473
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
474
474
  # @return [Array<(Response<(Array<Branch>)>, Integer, Hash)>] Response<(Array<Branch>)> data, response status code and response headers
475
475
  def branches_list_with_http_info(project_id, opts = {})
476
476
  if @api_client.config.debugging
data/lib/phrase/api/comments_api.rb CHANGED
@@ -582,7 +582,7 @@ module Phrase
582
582
  # @param [Hash] opts the optional parameters
583
583
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
584
584
  # @option opts [Integer] :page Page number
585
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
585
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
586
586
  # @option opts [String] :branch specify the branch to use
587
587
  # @return [Array<Comment>]
588
588
  def comments_list(project_id, key_id, opts = {})
@@ -597,7 +597,7 @@ module Phrase
597
597
  # @param [Hash] opts the optional parameters
598
598
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
599
599
  # @option opts [Integer] :page Page number
600
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
600
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
601
601
  # @option opts [String] :branch specify the branch to use
602
602
  # @return [Array<(Response<(Array<Comment>)>, Integer, Hash)>] Response<(Array<Comment>)> data, response status code and response headers
603
603
  def comments_list_with_http_info(project_id, key_id, opts = {})
data/lib/phrase/api/distributions_api.rb CHANGED
@@ -309,7 +309,7 @@ module Phrase
309
309
  # @param [Hash] opts the optional parameters
310
310
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
311
311
  # @option opts [Integer] :page Page number
312
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
312
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
313
313
  # @return [Array<DistributionPreview>]
314
314
  def distributions_list(account_id, opts = {})
315
315
  data, _status_code, _headers = distributions_list_with_http_info(account_id, opts)
@@ -322,7 +322,7 @@ module Phrase
322
322
  # @param [Hash] opts the optional parameters
323
323
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
324
324
  # @option opts [Integer] :page Page number
325
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
325
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
326
326
  # @return [Array<(Response<(Array<DistributionPreview>)>, Integer, Hash)>] Response<(Array<DistributionPreview>)> data, response status code and response headers
327
327
  def distributions_list_with_http_info(account_id, opts = {})
328
328
  if @api_client.config.debugging
data/lib/phrase/api/documents_api.rb CHANGED
@@ -83,7 +83,7 @@ module Phrase
83
83
  # @param [Hash] opts the optional parameters
84
84
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
85
85
  # @option opts [Integer] :page Page number
86
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
86
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
87
87
  # @return [Array<Document>]
88
88
  def documents_list(project_id, opts = {})
89
89
  data, _status_code, _headers = documents_list_with_http_info(project_id, opts)
@@ -96,7 +96,7 @@ module Phrase
96
96
  # @param [Hash] opts the optional parameters
97
97
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
98
98
  # @option opts [Integer] :page Page number
99
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
99
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
100
100
  # @return [Array<(Response<(Array<Document>)>, Integer, Hash)>] Response<(Array<Document>)> data, response status code and response headers
101
101
  def documents_list_with_http_info(project_id, opts = {})
102
102
  if @api_client.config.debugging
data/lib/phrase/api/git_hub_sync_api.rb CHANGED
@@ -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)
data/lib/phrase/api/git_lab_sync_api.rb CHANGED
@@ -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
@@ -154,7 +154,7 @@ module Phrase
154
154
  # @param [Hash] opts the optional parameters
155
155
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
156
156
  # @option opts [Integer] :page Page number
157
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
157
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
158
158
  # @option opts [String] :account_id Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.
159
159
  # @return [Array<GitlabSyncHistory>]
160
160
  def gitlab_sync_history(gitlab_sync_id, opts = {})
@@ -168,7 +168,7 @@ module Phrase
168
168
  # @param [Hash] opts the optional parameters
169
169
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
170
170
  # @option opts [Integer] :page Page number
171
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
171
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
172
172
  # @option opts [String] :account_id Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.
173
173
  # @return [Array<(Response<(Array<GitlabSyncHistory>)>, Integer, Hash)>] Response<(Array<GitlabSyncHistory>)> data, response status code and response headers
174
174
  def gitlab_sync_history_with_http_info(gitlab_sync_id, opts = {})
@@ -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
data/lib/phrase/api/glossaries_api.rb CHANGED
@@ -13,7 +13,7 @@ module Phrase
13
13
  # @param [Hash] opts the optional parameters
14
14
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
15
15
  # @option opts [Integer] :page Page number
16
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
16
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
17
17
  # @return [Array<Glossary>]
18
18
  def glossaries_list(account_id, opts = {})
19
19
  data, _status_code, _headers = glossaries_list_with_http_info(account_id, opts)
@@ -26,7 +26,7 @@ module Phrase
26
26
  # @param [Hash] opts the optional parameters
27
27
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
28
28
  # @option opts [Integer] :page Page number
29
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
29
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
30
30
  # @return [Array<(Response<(Array<Glossary>)>, Integer, Hash)>] Response<(Array<Glossary>)> data, response status code and response headers
31
31
  def glossaries_list_with_http_info(account_id, opts = {})
32
32
  if @api_client.config.debugging
data/lib/phrase/api/glossary_terms_api.rb CHANGED
@@ -334,7 +334,7 @@ module Phrase
334
334
  # @param [Hash] opts the optional parameters
335
335
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
336
336
  # @option opts [Integer] :page Page number
337
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
337
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
338
338
  # @return [Array<GlossaryTerm>]
339
339
  def glossary_terms_list(account_id, glossary_id, opts = {})
340
340
  data, _status_code, _headers = glossary_terms_list_with_http_info(account_id, glossary_id, opts)
@@ -348,7 +348,7 @@ module Phrase
348
348
  # @param [Hash] opts the optional parameters
349
349
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
350
350
  # @option opts [Integer] :page Page number
351
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
351
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
352
352
  # @return [Array<(Response<(Array<GlossaryTerm>)>, Integer, Hash)>] Response<(Array<GlossaryTerm>)> data, response status code and response headers
353
353
  def glossary_terms_list_with_http_info(account_id, glossary_id, opts = {})
354
354
  if @api_client.config.debugging
data/lib/phrase/api/invitations_api.rb CHANGED
@@ -461,7 +461,7 @@ module Phrase
461
461
  # @param [Hash] opts the optional parameters
462
462
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
463
463
  # @option opts [Integer] :page Page number
464
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
464
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
465
465
  # @return [Array<Invitation>]
466
466
  def invitations_list(account_id, opts = {})
467
467
  data, _status_code, _headers = invitations_list_with_http_info(account_id, opts)
@@ -474,7 +474,7 @@ module Phrase
474
474
  # @param [Hash] opts the optional parameters
475
475
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
476
476
  # @option opts [Integer] :page Page number
477
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
477
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
478
478
  # @return [Array<(Response<(Array<Invitation>)>, Integer, Hash)>] Response<(Array<Invitation>)> data, response status code and response headers
479
479
  def invitations_list_with_http_info(account_id, opts = {})
480
480
  if @api_client.config.debugging
data/lib/phrase/api/job_comments_api.rb CHANGED
@@ -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']
data/lib/phrase/api/job_locales_api.rb CHANGED
@@ -598,7 +598,7 @@ module Phrase
598
598
  # @param [Hash] opts the optional parameters
599
599
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
600
600
  # @option opts [Integer] :page Page number
601
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
601
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
602
602
  # @option opts [String] :branch specify the branch to use
603
603
  # @return [Array<JobLocale>]
604
604
  def job_locales_list(project_id, job_id, opts = {})
@@ -613,7 +613,7 @@ module Phrase
613
613
  # @param [Hash] opts the optional parameters
614
614
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
615
615
  # @option opts [Integer] :page Page number
616
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
616
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
617
617
  # @option opts [String] :branch specify the branch to use
618
618
  # @return [Array<(Response<(Array<JobLocale>)>, Integer, Hash)>] Response<(Array<JobLocale>)> data, response status code and response headers
619
619
  def job_locales_list_with_http_info(project_id, job_id, opts = {})