phrase 1.0.2 → 1.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (122) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +12 -3
  3. data/docs/Account.md +2 -0
  4. data/docs/AccountDetails.md +3 -3
  5. data/docs/AccountsApi.md +2 -2
  6. data/docs/AuthorizationsApi.md +2 -2
  7. data/docs/BlacklistedKeysApi.md +4 -2
  8. data/docs/BranchesApi.md +2 -2
  9. data/docs/CommentsApi.md +2 -2
  10. data/docs/DistributionsApi.md +2 -2
  11. data/docs/Document.md +23 -0
  12. data/docs/DocumentsApi.md +137 -0
  13. data/docs/GitHubSyncApi.md +130 -0
  14. data/docs/GitLabSyncApi.md +2 -2
  15. data/docs/GithubSyncExportParameters.md +17 -0
  16. data/docs/GithubSyncImportParameters.md +17 -0
  17. data/docs/GlossariesApi.md +2 -2
  18. data/docs/GlossaryTermsApi.md +2 -2
  19. data/docs/InlineResponse422.md +19 -0
  20. data/docs/InlineResponse422Errors.md +21 -0
  21. data/docs/InvitationsApi.md +2 -2
  22. data/docs/JobLocalesApi.md +2 -2
  23. data/docs/JobsApi.md +2 -2
  24. data/docs/KeysApi.md +4 -4
  25. data/docs/LocalesApi.md +2 -2
  26. data/docs/MembersApi.md +2 -2
  27. data/docs/OrdersApi.md +2 -2
  28. data/docs/Project.md +2 -0
  29. data/docs/ProjectDetails.md +2 -2
  30. data/docs/ProjectsApi.md +2 -2
  31. data/docs/ReleasesApi.md +2 -2
  32. data/docs/ScreenshotMarkersApi.md +2 -2
  33. data/docs/ScreenshotsApi.md +2 -2
  34. data/docs/SpacesApi.md +4 -4
  35. data/docs/StyleGuidesApi.md +2 -2
  36. data/docs/TagsApi.md +2 -2
  37. data/docs/TeamsApi.md +2 -2
  38. data/docs/TranslationsApi.md +8 -8
  39. data/docs/UploadsApi.md +2 -2
  40. data/docs/VersionsHistoryApi.md +2 -2
  41. data/docs/WebhooksApi.md +2 -2
  42. data/lib/phrase.rb +7 -0
  43. data/lib/phrase/api/accounts_api.rb +2 -2
  44. data/lib/phrase/api/authorizations_api.rb +2 -2
  45. data/lib/phrase/api/blacklisted_keys_api.rb +5 -2
  46. data/lib/phrase/api/branches_api.rb +2 -2
  47. data/lib/phrase/api/comments_api.rb +2 -2
  48. data/lib/phrase/api/distributions_api.rb +2 -2
  49. data/lib/phrase/api/documents_api.rb +152 -0
  50. data/lib/phrase/api/git_hub_sync_api.rb +146 -0
  51. data/lib/phrase/api/git_lab_sync_api.rb +2 -2
  52. data/lib/phrase/api/glossaries_api.rb +2 -2
  53. data/lib/phrase/api/glossary_terms_api.rb +2 -2
  54. data/lib/phrase/api/invitations_api.rb +2 -2
  55. data/lib/phrase/api/job_locales_api.rb +2 -2
  56. data/lib/phrase/api/jobs_api.rb +2 -2
  57. data/lib/phrase/api/keys_api.rb +4 -4
  58. data/lib/phrase/api/locales_api.rb +2 -2
  59. data/lib/phrase/api/members_api.rb +2 -2
  60. data/lib/phrase/api/orders_api.rb +2 -2
  61. data/lib/phrase/api/projects_api.rb +2 -2
  62. data/lib/phrase/api/releases_api.rb +2 -2
  63. data/lib/phrase/api/screenshot_markers_api.rb +2 -2
  64. data/lib/phrase/api/screenshots_api.rb +2 -2
  65. data/lib/phrase/api/spaces_api.rb +4 -4
  66. data/lib/phrase/api/style_guides_api.rb +2 -2
  67. data/lib/phrase/api/tags_api.rb +2 -2
  68. data/lib/phrase/api/teams_api.rb +2 -2
  69. data/lib/phrase/api/translations_api.rb +8 -8
  70. data/lib/phrase/api/uploads_api.rb +2 -2
  71. data/lib/phrase/api/versions_history_api.rb +2 -2
  72. data/lib/phrase/api/webhooks_api.rb +2 -2
  73. data/lib/phrase/models/account.rb +10 -1
  74. data/lib/phrase/models/account_details.rb +13 -13
  75. data/lib/phrase/models/document.rb +221 -0
  76. data/lib/phrase/models/github_sync_export_parameters.rb +195 -0
  77. data/lib/phrase/models/github_sync_import_parameters.rb +195 -0
  78. data/lib/phrase/models/inline_response422.rb +205 -0
  79. data/lib/phrase/models/inline_response422_errors.rb +212 -0
  80. data/lib/phrase/models/project.rb +10 -1
  81. data/lib/phrase/models/project_details.rb +10 -10
  82. data/lib/phrase/version.rb +1 -1
  83. data/spec/api/accounts_api_spec.rb +1 -1
  84. data/spec/api/authorizations_api_spec.rb +1 -1
  85. data/spec/api/blacklisted_keys_api_spec.rb +2 -1
  86. data/spec/api/branches_api_spec.rb +1 -1
  87. data/spec/api/comments_api_spec.rb +1 -1
  88. data/spec/api/distributions_api_spec.rb +1 -1
  89. data/spec/api/documents_api_spec.rb +52 -0
  90. data/spec/api/git_hub_sync_api_spec.rb +49 -0
  91. data/spec/api/git_lab_sync_api_spec.rb +1 -1
  92. data/spec/api/glossaries_api_spec.rb +1 -1
  93. data/spec/api/glossary_terms_api_spec.rb +1 -1
  94. data/spec/api/invitations_api_spec.rb +1 -1
  95. data/spec/api/job_locales_api_spec.rb +1 -1
  96. data/spec/api/jobs_api_spec.rb +1 -1
  97. data/spec/api/keys_api_spec.rb +2 -2
  98. data/spec/api/locales_api_spec.rb +1 -1
  99. data/spec/api/members_api_spec.rb +1 -1
  100. data/spec/api/orders_api_spec.rb +1 -1
  101. data/spec/api/projects_api_spec.rb +1 -1
  102. data/spec/api/releases_api_spec.rb +1 -1
  103. data/spec/api/screenshot_markers_api_spec.rb +1 -1
  104. data/spec/api/screenshots_api_spec.rb +1 -1
  105. data/spec/api/spaces_api_spec.rb +2 -2
  106. data/spec/api/style_guides_api_spec.rb +1 -1
  107. data/spec/api/tags_api_spec.rb +1 -1
  108. data/spec/api/teams_api_spec.rb +1 -1
  109. data/spec/api/translations_api_spec.rb +4 -4
  110. data/spec/api/uploads_api_spec.rb +1 -1
  111. data/spec/api/versions_history_api_spec.rb +1 -1
  112. data/spec/api/webhooks_api_spec.rb +1 -1
  113. data/spec/models/account_details_spec.rb +4 -4
  114. data/spec/models/account_spec.rb +6 -0
  115. data/spec/models/document_spec.rb +47 -0
  116. data/spec/models/github_sync_export_parameters_spec.rb +29 -0
  117. data/spec/models/github_sync_import_parameters_spec.rb +29 -0
  118. data/spec/models/inline_response422_errors_spec.rb +41 -0
  119. data/spec/models/inline_response422_spec.rb +35 -0
  120. data/spec/models/project_details_spec.rb +6 -6
  121. data/spec/models/project_spec.rb +6 -0
  122. metadata +181 -153
@@ -232,7 +232,7 @@ project_id = 'project_id_example' # String | Project ID
232
232
  opts = {
233
233
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
234
234
  page: 1, # Integer | Page number
235
- per_page: 10, # Integer | allows you to specify a page size up to 100 items, 10 by default
235
+ per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
236
236
  branch: 'my-feature-branch' # String | specify the branch to use
237
237
  }
238
238
 
@@ -253,7 +253,7 @@ Name | Type | Description | Notes
253
253
  **project_id** | **String**| Project ID |
254
254
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
255
255
  **page** | **Integer**| Page number | [optional]
256
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional]
256
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
257
257
  **branch** | **String**| specify the branch to use | [optional]
258
258
 
259
259
  ### Return type
@@ -300,7 +300,7 @@ account_id = 'account_id_example' # String | Account ID
300
300
  opts = {
301
301
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
302
302
  page: 1, # Integer | Page number
303
- per_page: 10 # Integer | allows you to specify a page size up to 100 items, 10 by default
303
+ per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
304
304
  }
305
305
 
306
306
  begin
@@ -320,7 +320,7 @@ Name | Type | Description | Notes
320
320
  **account_id** | **String**| Account ID |
321
321
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
322
322
  **page** | **Integer**| Page number | [optional]
323
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional]
323
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
324
324
 
325
325
  ### Return type
326
326
 
@@ -572,7 +572,7 @@ key_id = 'key_id_example' # String | Translation Key ID
572
572
  opts = {
573
573
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
574
574
  page: 1, # Integer | Page number
575
- per_page: 10, # Integer | allows you to specify a page size up to 100 items, 10 by default
575
+ per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
576
576
  branch: 'my-feature-branch', # String | specify the branch to use
577
577
  sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
578
578
  order: 'desc', # String | Order direction. Can be one of: asc, desc.
@@ -597,7 +597,7 @@ Name | Type | Description | Notes
597
597
  **key_id** | **String**| Translation Key ID |
598
598
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
599
599
  **page** | **Integer**| Page number | [optional]
600
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional]
600
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
601
601
  **branch** | **String**| specify the branch to use | [optional]
602
602
  **sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
603
603
  **order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
@@ -647,7 +647,7 @@ locale_id = 'locale_id_example' # String | Locale ID
647
647
  opts = {
648
648
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
649
649
  page: 1, # Integer | Page number
650
- per_page: 10, # Integer | allows you to specify a page size up to 100 items, 10 by default
650
+ per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
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.
@@ -672,7 +672,7 @@ Name | Type | Description | Notes
672
672
  **locale_id** | **String**| Locale ID |
673
673
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
674
674
  **page** | **Integer**| Page number | [optional]
675
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional]
675
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
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]
@@ -847,7 +847,7 @@ 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
849
  page: 1, # Integer | Page number
850
- per_page: 10, # Integer | allows you to specify a page size up to 100 items, 10 by default
850
+ per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
851
851
  branch: 'my-feature-branch', # String | specify the branch to use
852
852
  sort: 'updated_at', # String | Sort criteria. Can be one of: key_name, created_at, updated_at.
853
853
  order: 'desc', # String | Order direction. Can be one of: asc, desc.
@@ -871,7 +871,7 @@ Name | Type | Description | Notes
871
871
  **project_id** | **String**| Project ID |
872
872
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
873
873
  **page** | **Integer**| Page number | [optional]
874
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional]
874
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
875
875
  **branch** | **String**| specify the branch to use | [optional]
876
876
  **sort** | **String**| Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
877
877
  **order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
@@ -984,7 +984,7 @@ translations_search_parameters = Phrase::TranslationsSearchParameters.new # Tran
984
984
  opts = {
985
985
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
986
986
  page: 1, # Integer | Page number
987
- per_page: 10 # Integer | allows you to specify a page size up to 100 items, 10 by default
987
+ per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
988
988
  }
989
989
 
990
990
  begin
@@ -1005,7 +1005,7 @@ Name | Type | Description | Notes
1005
1005
  **translations_search_parameters** | [**TranslationsSearchParameters**](TranslationsSearchParameters.md)| |
1006
1006
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
1007
1007
  **page** | **Integer**| Page number | [optional]
1008
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional]
1008
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
1009
1009
 
1010
1010
  ### Return type
1011
1011
 
@@ -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: 10, # Integer | allows you to specify a page size up to 100 items, 10 by default
198
+ per_page: 25, # Integer | allows you to specify a page size up to 100 items, 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, 10 by default | [optional]
219
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
220
220
  **branch** | **String**| specify the branch to use | [optional]
221
221
 
222
222
  ### Return type
@@ -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: 10, # Integer | allows you to specify a page size up to 100 items, 10 by default
109
+ per_page: 25, # Integer | allows you to specify a page size up to 100 items, 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, 10 by default | [optional]
131
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
132
132
  **branch** | **String**| specify the branch to use | [optional]
133
133
 
134
134
  ### Return type
@@ -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: 10 # Integer | allows you to specify a page size up to 100 items, 10 by default
360
+ per_page: 25 # Integer | allows you to specify a page size up to 100 items, 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, 10 by default | [optional]
380
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
381
381
 
382
382
  ### Return type
383
383
 
@@ -37,7 +37,10 @@ require 'phrase/models/distribution'
37
37
  require 'phrase/models/distribution_create_parameters'
38
38
  require 'phrase/models/distribution_preview'
39
39
  require 'phrase/models/distribution_update_parameters'
40
+ require 'phrase/models/document'
40
41
  require 'phrase/models/format'
42
+ require 'phrase/models/github_sync_export_parameters'
43
+ require 'phrase/models/github_sync_import_parameters'
41
44
  require 'phrase/models/gitlab_sync'
42
45
  require 'phrase/models/gitlab_sync_export'
43
46
  require 'phrase/models/gitlab_sync_export_parameters'
@@ -52,6 +55,8 @@ require 'phrase/models/glossary_term_translation_create_parameters'
52
55
  require 'phrase/models/glossary_term_translation_update_parameters'
53
56
  require 'phrase/models/glossary_term_update_parameters'
54
57
  require 'phrase/models/glossary_update_parameters'
58
+ require 'phrase/models/inline_response422'
59
+ require 'phrase/models/inline_response422_errors'
55
60
  require 'phrase/models/invitation'
56
61
  require 'phrase/models/invitation_create_parameters'
57
62
  require 'phrase/models/invitation_update_parameters'
@@ -168,7 +173,9 @@ require 'phrase/api/blacklisted_keys_api'
168
173
  require 'phrase/api/branches_api'
169
174
  require 'phrase/api/comments_api'
170
175
  require 'phrase/api/distributions_api'
176
+ require 'phrase/api/documents_api'
171
177
  require 'phrase/api/formats_api'
178
+ require 'phrase/api/git_hub_sync_api'
172
179
  require 'phrase/api/git_lab_sync_api'
173
180
  require 'phrase/api/glossaries_api'
174
181
  require 'phrase/api/glossary_term_translations_api'
@@ -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, 10 by default
81
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 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, 10 by default
93
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 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
@@ -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, 10 by default
287
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 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, 10 by default
299
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 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
@@ -309,7 +309,8 @@ 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, 10 by default
312
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
313
+ # @option opts [String] :branch specify the branch to use
313
314
  # @return [Array<BlacklistedKey>]
314
315
  def blacklisted_keys_list(project_id, opts = {})
315
316
  data, _status_code, _headers = blacklisted_keys_list_with_http_info(project_id, opts)
@@ -322,7 +323,8 @@ module Phrase
322
323
  # @param [Hash] opts the optional parameters
323
324
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
324
325
  # @option opts [Integer] :page Page number
325
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
326
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
327
+ # @option opts [String] :branch specify the branch to use
326
328
  # @return [Array<(Response<(Array<BlacklistedKey>)>, Integer, Hash)>] Response<(Array<BlacklistedKey>)> data, response status code and response headers
327
329
  def blacklisted_keys_list_with_http_info(project_id, opts = {})
328
330
  if @api_client.config.debugging
@@ -339,6 +341,7 @@ module Phrase
339
341
  query_params = opts[:query_params] || {}
340
342
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
341
343
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
344
+ query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
342
345
 
343
346
  # header parameters
344
347
  header_params = opts[:header_params] || {}
@@ -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, 10 by default
460
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 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, 10 by default
473
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 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
@@ -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, 10 by default
585
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 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, 10 by default
600
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 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 = {})
@@ -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, 10 by default
312
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 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, 10 by default
325
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 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
@@ -0,0 +1,152 @@
1
+ require 'cgi'
2
+
3
+ module Phrase
4
+ class DocumentsApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+ # Delete document
11
+ # Delete an existing document.
12
+ # @param project_id [String] Project ID
13
+ # @param id [String] ID
14
+ # @param [Hash] opts the optional parameters
15
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
16
+ # @return [nil]
17
+ def document_delete(project_id, id, opts = {})
18
+ data, _status_code, _headers = document_delete_with_http_info(project_id, id, opts)
19
+ data
20
+ end
21
+
22
+ # Delete document
23
+ # Delete an existing document.
24
+ # @param project_id [String] Project ID
25
+ # @param id [String] ID
26
+ # @param [Hash] opts the optional parameters
27
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
28
+ # @return [Array<(Response, Integer, Hash)>] Response<(nil, response status code and response headers
29
+ def document_delete_with_http_info(project_id, id, opts = {})
30
+ if @api_client.config.debugging
31
+ @api_client.config.logger.debug 'Calling API: DocumentsApi.document_delete ...'
32
+ end
33
+ # verify the required parameter 'project_id' is set
34
+ if @api_client.config.client_side_validation && project_id.nil?
35
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling DocumentsApi.document_delete"
36
+ end
37
+ # verify the required parameter 'id' is set
38
+ if @api_client.config.client_side_validation && id.nil?
39
+ fail ArgumentError, "Missing the required parameter 'id' when calling DocumentsApi.document_delete"
40
+ end
41
+ # resource path
42
+ local_var_path = '/projects/{project_id}/documents/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
43
+
44
+ # query parameters
45
+ query_params = opts[:query_params] || {}
46
+
47
+ # header parameters
48
+ header_params = opts[:header_params] || {}
49
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
50
+
51
+ # form parameters
52
+ form_params = opts[:form_params] || {}
53
+
54
+ # http body (model)
55
+ post_body = opts[:body]
56
+
57
+ # return_type
58
+ return_type = opts[:return_type]
59
+
60
+ # auth_names
61
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
62
+
63
+ new_options = opts.merge(
64
+ :header_params => header_params,
65
+ :query_params => query_params,
66
+ :form_params => form_params,
67
+ :body => post_body,
68
+ :auth_names => auth_names,
69
+ :return_type => return_type
70
+ )
71
+
72
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
73
+ if @api_client.config.debugging
74
+ @api_client.config.logger.debug "API called: DocumentsApi#document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
75
+ end
76
+ response = ::Phrase::Response.new(data, headers)
77
+ return response, status_code, headers
78
+ end
79
+
80
+ # List documents
81
+ # List all documents the current user has access to.
82
+ # @param project_id [String] Project ID
83
+ # @param [Hash] opts the optional parameters
84
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
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
87
+ # @return [Array<Document>]
88
+ def documents_list(project_id, opts = {})
89
+ data, _status_code, _headers = documents_list_with_http_info(project_id, opts)
90
+ data
91
+ end
92
+
93
+ # List documents
94
+ # List all documents the current user has access to.
95
+ # @param project_id [String] Project ID
96
+ # @param [Hash] opts the optional parameters
97
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
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
100
+ # @return [Array<(Response<(Array<Document>)>, Integer, Hash)>] Response<(Array<Document>)> data, response status code and response headers
101
+ def documents_list_with_http_info(project_id, opts = {})
102
+ if @api_client.config.debugging
103
+ @api_client.config.logger.debug 'Calling API: DocumentsApi.documents_list ...'
104
+ end
105
+ # verify the required parameter 'project_id' is set
106
+ if @api_client.config.client_side_validation && project_id.nil?
107
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling DocumentsApi.documents_list"
108
+ end
109
+ # resource path
110
+ local_var_path = '/projects/{project_id}/documents'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
111
+
112
+ # query parameters
113
+ query_params = opts[:query_params] || {}
114
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
115
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
116
+
117
+ # header parameters
118
+ header_params = opts[:header_params] || {}
119
+ # HTTP header 'Accept' (if needed)
120
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
121
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
122
+
123
+ # form parameters
124
+ form_params = opts[:form_params] || {}
125
+
126
+ # http body (model)
127
+ post_body = opts[:body]
128
+
129
+ # return_type
130
+ return_type = opts[:return_type] || 'Array<Document>'
131
+
132
+ # auth_names
133
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
134
+
135
+ new_options = opts.merge(
136
+ :header_params => header_params,
137
+ :query_params => query_params,
138
+ :form_params => form_params,
139
+ :body => post_body,
140
+ :auth_names => auth_names,
141
+ :return_type => return_type
142
+ )
143
+
144
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
145
+ if @api_client.config.debugging
146
+ @api_client.config.logger.debug "API called: DocumentsApi#documents_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
147
+ end
148
+ response = ::Phrase::Response.new(data, headers)
149
+ return response, status_code, headers
150
+ end
151
+ end
152
+ end