phrase 4.22.0 → 4.23.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +13 -0
- data/README.md +8 -6
- data/docs/AccountDetails.md +1 -1
- data/docs/AuthorizationsApi.md +1 -1
- data/docs/Automation.md +6 -0
- data/docs/AutomationsApi.md +1 -1
- data/docs/AutomationsCreateParameters.md +5 -1
- data/docs/AutomationsCreateParameters1.md +5 -1
- data/docs/BlacklistedKeysApi.md +1 -1
- data/docs/Branch.md +2 -0
- data/docs/BranchCreateParameters.md +3 -1
- data/docs/BranchMergeParameters.md +1 -1
- data/docs/BranchSyncParameters.md +1 -1
- data/docs/BranchesApi.md +10 -10
- data/docs/CommentsApi.md +7 -7
- data/docs/Distribution.md +4 -4
- data/docs/{DistributionPreview.md → DistributionDetails.md} +9 -3
- data/docs/DistributionsApi.md +9 -9
- data/docs/DocumentDelete422Response.md +19 -0
- data/docs/{CustomMetadataPropertyCreate422ResponseErrorsInner.md → DocumentDelete422ResponseErrorsInner.md} +2 -2
- data/docs/DocumentsApi.md +4 -2
- data/docs/FigmaAttachmentsApi.md +1 -1
- data/docs/GlossariesApi.md +1 -1
- data/docs/Glossary.md +2 -0
- data/docs/GlossaryTerm.md +2 -0
- data/docs/GlossaryTermGlossary.md +19 -0
- data/docs/GlossaryTermTranslationsApi.md +1 -1
- data/docs/GlossaryTermsApi.md +1 -1
- data/docs/IcuSkeletonParameters.md +3 -1
- data/docs/Invitation.md +2 -2
- data/docs/InvitationsApi.md +1 -1
- data/docs/Job.md +5 -1
- data/docs/JobDetails.md +8 -2
- data/docs/JobTemplate.md +2 -0
- data/docs/JobTemplateDetails.md +2 -0
- data/docs/JobTemplatesApi.md +1 -1
- data/docs/JobsApi.md +15 -9
- data/docs/KeyCreateParameters.md +6 -2
- data/docs/KeyUpdateParameters.md +6 -2
- data/docs/KeysApi.md +1 -1
- data/docs/LocalesApi.md +6 -2
- data/docs/MembersApi.md +1 -1
- data/docs/NotificationsApi.md +3 -1
- data/docs/OrdersApi.md +4 -2
- data/docs/OrganizationJobTemplate.md +4 -0
- data/docs/OrganizationJobTemplateDetails.md +4 -0
- data/docs/OrganizationJobTemplatesApi.md +1 -1
- data/docs/ProjectCreateParameters.md +17 -1
- data/docs/ProjectDetails.md +7 -1
- data/docs/ProjectUpdateParameters.md +17 -3
- data/docs/ProjectsApi.md +10 -8
- data/docs/Release.md +2 -0
- data/docs/ReleasesApi.md +1 -1
- data/docs/RepoSync.md +2 -0
- data/docs/ScreenshotMarker.md +2 -2
- data/docs/ScreenshotMarkerPresentation.md +23 -0
- data/docs/ScreenshotMarkersApi.md +1 -1
- data/docs/ScreenshotUpdateParameters.md +1 -1
- data/docs/ScreenshotsApi.md +1 -1
- data/docs/SearchInAccountParameters.md +3 -1
- data/docs/StyleGuidesApi.md +1 -1
- data/docs/StyleguideCreateParameters.md +3 -3
- data/docs/StyleguideUpdateParameters.md +3 -3
- data/docs/Tag.md +2 -0
- data/docs/TagWithStats.md +2 -0
- data/docs/TagsApi.md +5 -3
- data/docs/TranslationCreateParameters.md +5 -1
- data/docs/TranslationOrder.md +2 -2
- data/docs/TranslationUpdateParameters.md +3 -1
- data/docs/TranslationsApi.md +4 -0
- data/docs/UploadBatch.md +4 -2
- data/docs/UploadsApi.md +3 -1
- data/docs/VariablesApi.md +1 -1
- data/docs/WebhooksApi.md +7 -6
- data/lib/phrase/api/authorizations_api.rb +2 -0
- data/lib/phrase/api/automations_api.rb +2 -0
- data/lib/phrase/api/blacklisted_keys_api.rb +2 -0
- data/lib/phrase/api/branches_api.rb +20 -14
- data/lib/phrase/api/comments_api.rb +18 -4
- data/lib/phrase/api/distributions_api.rb +14 -12
- data/lib/phrase/api/documents_api.rb +5 -0
- data/lib/phrase/api/figma_attachments_api.rb +2 -0
- data/lib/phrase/api/glossaries_api.rb +2 -0
- data/lib/phrase/api/glossary_term_translations_api.rb +2 -0
- data/lib/phrase/api/glossary_terms_api.rb +2 -0
- data/lib/phrase/api/invitations_api.rb +2 -0
- data/lib/phrase/api/job_templates_api.rb +2 -0
- data/lib/phrase/api/jobs_api.rb +18 -6
- data/lib/phrase/api/keys_api.rb +2 -0
- data/lib/phrase/api/locales_api.rb +8 -0
- data/lib/phrase/api/members_api.rb +2 -0
- data/lib/phrase/api/notifications_api.rb +3 -0
- data/lib/phrase/api/orders_api.rb +5 -0
- data/lib/phrase/api/organization_job_templates_api.rb +2 -0
- data/lib/phrase/api/projects_api.rb +23 -10
- data/lib/phrase/api/releases_api.rb +2 -0
- data/lib/phrase/api/screenshot_markers_api.rb +2 -0
- data/lib/phrase/api/screenshots_api.rb +2 -0
- data/lib/phrase/api/style_guides_api.rb +2 -0
- data/lib/phrase/api/tags_api.rb +7 -2
- data/lib/phrase/api/translations_api.rb +6 -0
- data/lib/phrase/api/uploads_api.rb +3 -0
- data/lib/phrase/api/variables_api.rb +2 -0
- data/lib/phrase/api/webhooks_api.rb +9 -5
- data/lib/phrase/models/account_details.rb +1 -0
- data/lib/phrase/models/authorization_create_parameters.rb +22 -0
- data/lib/phrase/models/authorization_update_parameters.rb +22 -0
- data/lib/phrase/models/automation.rb +34 -1
- data/lib/phrase/models/automations_create_parameters.rb +24 -4
- data/lib/phrase/models/automations_create_parameters1.rb +24 -4
- data/lib/phrase/models/branch.rb +46 -1
- data/lib/phrase/models/branch_create_parameters.rb +14 -4
- data/lib/phrase/models/branch_merge_parameters.rb +35 -1
- data/lib/phrase/models/branch_sync_parameters.rb +35 -1
- data/lib/phrase/models/distribution.rb +17 -20
- data/lib/phrase/models/{distribution_preview.rb → distribution_details.rb} +46 -7
- data/lib/phrase/models/{custom_metadata_property_create422_response.rb → document_delete422_response.rb} +4 -4
- data/lib/phrase/models/{custom_metadata_property_create422_response_errors_inner.rb → document_delete422_response_errors_inner.rb} +3 -3
- data/lib/phrase/models/glossary.rb +12 -1
- data/lib/phrase/models/glossary_term.rb +10 -1
- data/lib/phrase/models/glossary_term_glossary.rb +206 -0
- data/lib/phrase/models/icu_skeleton_parameters.rb +12 -2
- data/lib/phrase/models/invitation.rb +9 -8
- data/lib/phrase/models/job.rb +26 -4
- data/lib/phrase/models/job_details.rb +37 -4
- data/lib/phrase/models/job_template.rb +11 -1
- data/lib/phrase/models/job_template_details.rb +11 -1
- data/lib/phrase/models/key_create_parameters.rb +26 -4
- data/lib/phrase/models/key_update_parameters.rb +26 -4
- data/lib/phrase/models/organization_job_template.rb +22 -1
- data/lib/phrase/models/organization_job_template_details.rb +22 -1
- data/lib/phrase/models/project_create_parameters.rb +115 -1
- data/lib/phrase/models/project_details.rb +31 -4
- data/lib/phrase/models/project_update_parameters.rb +75 -5
- data/lib/phrase/models/release.rb +10 -1
- data/lib/phrase/models/repo_sync.rb +12 -1
- data/lib/phrase/models/screenshot_marker.rb +2 -1
- data/lib/phrase/models/screenshot_marker_presentation.rb +224 -0
- data/lib/phrase/models/search_in_account_parameters.rb +16 -4
- data/lib/phrase/models/styleguide_create_parameters.rb +61 -3
- data/lib/phrase/models/styleguide_update_parameters.rb +61 -3
- data/lib/phrase/models/tag.rb +11 -1
- data/lib/phrase/models/tag_with_stats.rb +11 -1
- data/lib/phrase/models/translation_create_parameters.rb +24 -4
- data/lib/phrase/models/translation_order.rb +8 -7
- data/lib/phrase/models/translation_update_parameters.rb +14 -4
- data/lib/phrase/models/upload_batch.rb +24 -14
- data/lib/phrase/version.rb +1 -1
- data/lib/phrase.rb +5 -3
- data/spec/api/branches_api_spec.rb +7 -7
- data/spec/api/comments_api_spec.rb +2 -2
- data/spec/api/distributions_api_spec.rb +4 -4
- data/spec/api/documents_api_spec.rb +1 -0
- data/spec/api/jobs_api_spec.rb +4 -2
- data/spec/api/notifications_api_spec.rb +1 -0
- data/spec/api/orders_api_spec.rb +1 -0
- data/spec/api/projects_api_spec.rb +6 -5
- data/spec/api/tags_api_spec.rb +2 -1
- data/spec/api/translations_api_spec.rb +2 -0
- data/spec/api/webhooks_api_spec.rb +2 -2
- data/spec/models/authorization_create_parameters_spec.rb +4 -0
- data/spec/models/authorization_update_parameters_spec.rb +4 -0
- data/spec/models/automation_spec.rb +18 -0
- data/spec/models/automations_create_parameters1_spec.rb +12 -0
- data/spec/models/automations_create_parameters_spec.rb +12 -0
- data/spec/models/branch_create_parameters_spec.rb +6 -0
- data/spec/models/branch_merge_parameters_spec.rb +4 -0
- data/spec/models/branch_spec.rb +10 -0
- data/spec/models/branch_sync_parameters_spec.rb +4 -0
- data/spec/models/{distribution_preview_spec.rb → distribution_details_spec.rb} +24 -6
- data/spec/models/distribution_spec.rb +3 -3
- data/spec/models/{custom_metadata_property_create422_response_errors_inner_spec.rb → document_delete422_response_errors_inner_spec.rb} +6 -6
- data/spec/models/{custom_metadata_property_create422_response_spec.rb → document_delete422_response_spec.rb} +6 -6
- data/spec/models/glossary_spec.rb +6 -0
- data/spec/models/glossary_term_glossary_spec.rb +35 -0
- data/spec/models/glossary_term_spec.rb +6 -0
- data/spec/models/icu_skeleton_parameters_spec.rb +6 -0
- data/spec/models/invitation_spec.rb +1 -1
- data/spec/models/job_details_spec.rb +18 -0
- data/spec/models/job_spec.rb +12 -0
- data/spec/models/job_template_details_spec.rb +6 -0
- data/spec/models/job_template_spec.rb +6 -0
- data/spec/models/key_create_parameters_spec.rb +12 -0
- data/spec/models/key_update_parameters_spec.rb +12 -0
- data/spec/models/organization_job_template_details_spec.rb +12 -0
- data/spec/models/organization_job_template_spec.rb +12 -0
- data/spec/models/project_create_parameters_spec.rb +52 -0
- data/spec/models/project_details_spec.rb +18 -0
- data/spec/models/project_update_parameters_spec.rb +42 -0
- data/spec/models/release_spec.rb +6 -0
- data/spec/models/repo_sync_spec.rb +6 -0
- data/spec/models/screenshot_marker_presentation_spec.rb +47 -0
- data/spec/models/search_in_account_parameters_spec.rb +6 -0
- data/spec/models/styleguide_create_parameters_spec.rb +12 -0
- data/spec/models/styleguide_update_parameters_spec.rb +12 -0
- data/spec/models/tag_spec.rb +6 -0
- data/spec/models/tag_with_stats_spec.rb +6 -0
- data/spec/models/translation_create_parameters_spec.rb +12 -0
- data/spec/models/translation_order_spec.rb +1 -1
- data/spec/models/translation_update_parameters_spec.rb +6 -0
- data/spec/models/upload_batch_spec.rb +8 -2
- metadata +267 -259
- data/docs/CustomMetadataPropertyCreate422Response.md +0 -19
|
@@ -156,7 +156,7 @@ module Phrase
|
|
|
156
156
|
end
|
|
157
157
|
|
|
158
158
|
# Create a branch
|
|
159
|
-
# Create a new branch. *Note: Creating a new branch may take several minutes depending on the project size.*
|
|
159
|
+
# Create a new branch. Branch project provisioning runs asynchronously, so the newly created branch is returned in a transitional state (typically `creating_branch`) and only reaches `success` once the underlying project has been set up. Poll the branch resource until its `state` becomes `success` before performing further operations on it. Requires the Branching feature to be enabled on the account. *Note: Creating a new branch may take several minutes depending on the project size.*
|
|
160
160
|
# @param project_id [String] Project ID
|
|
161
161
|
# @param branch_create_parameters [BranchCreateParameters]
|
|
162
162
|
# @param [Hash] opts the optional parameters
|
|
@@ -168,7 +168,7 @@ module Phrase
|
|
|
168
168
|
end
|
|
169
169
|
|
|
170
170
|
# Create a branch
|
|
171
|
-
# Create a new branch. *Note: Creating a new branch may take several minutes depending on the project size.*
|
|
171
|
+
# Create a new branch. Branch project provisioning runs asynchronously, so the newly created branch is returned in a transitional state (typically `creating_branch`) and only reaches `success` once the underlying project has been set up. Poll the branch resource until its `state` becomes `success` before performing further operations on it. Requires the Branching feature to be enabled on the account. *Note: Creating a new branch may take several minutes depending on the project size.*
|
|
172
172
|
# @param project_id [String] Project ID
|
|
173
173
|
# @param branch_create_parameters [BranchCreateParameters]
|
|
174
174
|
# @param [Hash] opts the optional parameters
|
|
@@ -230,7 +230,7 @@ module Phrase
|
|
|
230
230
|
end
|
|
231
231
|
|
|
232
232
|
# Delete a branch
|
|
233
|
-
# Delete an existing branch.
|
|
233
|
+
# Delete an existing branch. A branch cannot be deleted while it still has open jobs or open translation orders attached to its branch project — in that case the request is rejected with `409 Conflict`. A branch whose current `state` does not allow deletion (for example, while a merge or sync is in progress) is rejected with `422 Unprocessable Entity`. Requires the Branching feature to be enabled on the account.
|
|
234
234
|
# @param project_id [String] Project ID
|
|
235
235
|
# @param name [String] name
|
|
236
236
|
# @param [Hash] opts the optional parameters
|
|
@@ -242,7 +242,7 @@ module Phrase
|
|
|
242
242
|
end
|
|
243
243
|
|
|
244
244
|
# Delete a branch
|
|
245
|
-
# Delete an existing branch.
|
|
245
|
+
# Delete an existing branch. A branch cannot be deleted while it still has open jobs or open translation orders attached to its branch project — in that case the request is rejected with `409 Conflict`. A branch whose current `state` does not allow deletion (for example, while a merge or sync is in progress) is rejected with `422 Unprocessable Entity`. Requires the Branching feature to be enabled on the account.
|
|
246
246
|
# @param project_id [String] Project ID
|
|
247
247
|
# @param name [String] name
|
|
248
248
|
# @param [Hash] opts the optional parameters
|
|
@@ -268,6 +268,8 @@ module Phrase
|
|
|
268
268
|
|
|
269
269
|
# header parameters
|
|
270
270
|
header_params = opts[:header_params] || {}
|
|
271
|
+
# HTTP header 'Accept' (if needed)
|
|
272
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
271
273
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
272
274
|
|
|
273
275
|
# form parameters
|
|
@@ -300,7 +302,7 @@ module Phrase
|
|
|
300
302
|
end
|
|
301
303
|
|
|
302
304
|
# Merge a branch
|
|
303
|
-
# Merge an existing branch. *Note: Merging a branch may take several minutes depending on diff size.*
|
|
305
|
+
# Merge an existing branch back into its base branch. The merge runs asynchronously. The branch transitions to `merging_branch` and settles in `merged`, `merge_error`, or `merge_conflict` once the background job completes; the response body for this request is empty. Poll the branch resource to observe the final state. A branch cannot be merged while it still has open jobs or open translation orders attached to its branch project — in that case the request is rejected with `409 Conflict`. A branch whose current `state` does not allow a merge is rejected with `422 Unprocessable Entity`. Requires the Branching feature to be enabled on the account. *Note: Merging a branch may take several minutes depending on diff size.*
|
|
304
306
|
# @param project_id [String] Project ID
|
|
305
307
|
# @param name [String] name
|
|
306
308
|
# @param branch_merge_parameters [BranchMergeParameters]
|
|
@@ -313,7 +315,7 @@ module Phrase
|
|
|
313
315
|
end
|
|
314
316
|
|
|
315
317
|
# Merge a branch
|
|
316
|
-
# Merge an existing branch. *Note: Merging a branch may take several minutes depending on diff size.*
|
|
318
|
+
# Merge an existing branch back into its base branch. The merge runs asynchronously. The branch transitions to `merging_branch` and settles in `merged`, `merge_error`, or `merge_conflict` once the background job completes; the response body for this request is empty. Poll the branch resource to observe the final state. A branch cannot be merged while it still has open jobs or open translation orders attached to its branch project — in that case the request is rejected with `409 Conflict`. A branch whose current `state` does not allow a merge is rejected with `422 Unprocessable Entity`. Requires the Branching feature to be enabled on the account. *Note: Merging a branch may take several minutes depending on diff size.*
|
|
317
319
|
# @param project_id [String] Project ID
|
|
318
320
|
# @param name [String] name
|
|
319
321
|
# @param branch_merge_parameters [BranchMergeParameters]
|
|
@@ -344,6 +346,8 @@ module Phrase
|
|
|
344
346
|
|
|
345
347
|
# header parameters
|
|
346
348
|
header_params = opts[:header_params] || {}
|
|
349
|
+
# HTTP header 'Accept' (if needed)
|
|
350
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
347
351
|
# HTTP header 'Content-Type'
|
|
348
352
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
349
353
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
@@ -378,7 +382,7 @@ module Phrase
|
|
|
378
382
|
end
|
|
379
383
|
|
|
380
384
|
# Get a single branch
|
|
381
|
-
# Get details on a single branch for a given project.
|
|
385
|
+
# Get details on a single branch for a given project. Requires the Branching feature to be enabled on the account.
|
|
382
386
|
# @param project_id [String] Project ID
|
|
383
387
|
# @param name [String] name
|
|
384
388
|
# @param [Hash] opts the optional parameters
|
|
@@ -390,7 +394,7 @@ module Phrase
|
|
|
390
394
|
end
|
|
391
395
|
|
|
392
396
|
# Get a single branch
|
|
393
|
-
# Get details on a single branch for a given project.
|
|
397
|
+
# Get details on a single branch for a given project. Requires the Branching feature to be enabled on the account.
|
|
394
398
|
# @param project_id [String] Project ID
|
|
395
399
|
# @param name [String] name
|
|
396
400
|
# @param [Hash] opts the optional parameters
|
|
@@ -450,7 +454,7 @@ module Phrase
|
|
|
450
454
|
end
|
|
451
455
|
|
|
452
456
|
# Sync a branch
|
|
453
|
-
#
|
|
457
|
+
# Pull changes from the base branch into this branch, applying the chosen conflict-resolution strategy. The sync runs asynchronously. The branch transitions to `syncing_branch` and settles back into `success` (or `merge_conflict` / `branch_error`) once the background job completes; the response body for this request is empty. Poll the branch resource to observe the final state. Only branches created with the newer branching system can be synced. Requests against branches from the older system, or against branches whose current state does not allow a sync, are rejected with `422 Unprocessable Entity` and an empty body. Requires the Branching feature to be enabled on the account.
|
|
454
458
|
# @param project_id [String] Project ID
|
|
455
459
|
# @param name [String] name
|
|
456
460
|
# @param branch_sync_parameters [BranchSyncParameters]
|
|
@@ -463,7 +467,7 @@ module Phrase
|
|
|
463
467
|
end
|
|
464
468
|
|
|
465
469
|
# Sync a branch
|
|
466
|
-
#
|
|
470
|
+
# Pull changes from the base branch into this branch, applying the chosen conflict-resolution strategy. The sync runs asynchronously. The branch transitions to `syncing_branch` and settles back into `success` (or `merge_conflict` / `branch_error`) once the background job completes; the response body for this request is empty. Poll the branch resource to observe the final state. Only branches created with the newer branching system can be synced. Requests against branches from the older system, or against branches whose current state does not allow a sync, are rejected with `422 Unprocessable Entity` and an empty body. Requires the Branching feature to be enabled on the account.
|
|
467
471
|
# @param project_id [String] Project ID
|
|
468
472
|
# @param name [String] name
|
|
469
473
|
# @param branch_sync_parameters [BranchSyncParameters]
|
|
@@ -494,6 +498,8 @@ module Phrase
|
|
|
494
498
|
|
|
495
499
|
# header parameters
|
|
496
500
|
header_params = opts[:header_params] || {}
|
|
501
|
+
# HTTP header 'Accept' (if needed)
|
|
502
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
497
503
|
# HTTP header 'Content-Type'
|
|
498
504
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
499
505
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
@@ -528,7 +534,7 @@ module Phrase
|
|
|
528
534
|
end
|
|
529
535
|
|
|
530
536
|
# Update a branch
|
|
531
|
-
# Update an existing branch.
|
|
537
|
+
# Update an existing branch. Only the branch name can be changed. Requires the Branching feature to be enabled on the account.
|
|
532
538
|
# @param project_id [String] Project ID
|
|
533
539
|
# @param name [String] name
|
|
534
540
|
# @param branch_update_parameters [BranchUpdateParameters]
|
|
@@ -541,7 +547,7 @@ module Phrase
|
|
|
541
547
|
end
|
|
542
548
|
|
|
543
549
|
# Update a branch
|
|
544
|
-
# Update an existing branch.
|
|
550
|
+
# Update an existing branch. Only the branch name can be changed. Requires the Branching feature to be enabled on the account.
|
|
545
551
|
# @param project_id [String] Project ID
|
|
546
552
|
# @param name [String] name
|
|
547
553
|
# @param branch_update_parameters [BranchUpdateParameters]
|
|
@@ -608,7 +614,7 @@ module Phrase
|
|
|
608
614
|
end
|
|
609
615
|
|
|
610
616
|
# List branches
|
|
611
|
-
# List all branches
|
|
617
|
+
# List all branches of the current project. Requires the Branching feature to be enabled on the account.
|
|
612
618
|
# @param project_id [String] Project ID
|
|
613
619
|
# @param [Hash] opts the optional parameters
|
|
614
620
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
@@ -621,7 +627,7 @@ module Phrase
|
|
|
621
627
|
end
|
|
622
628
|
|
|
623
629
|
# List branches
|
|
624
|
-
# List all branches
|
|
630
|
+
# List all branches of the current project. Requires the Branching feature to be enabled on the account.
|
|
625
631
|
# @param project_id [String] Project ID
|
|
626
632
|
# @param [Hash] opts the optional parameters
|
|
627
633
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
@@ -135,6 +135,8 @@ module Phrase
|
|
|
135
135
|
|
|
136
136
|
# header parameters
|
|
137
137
|
header_params = opts[:header_params] || {}
|
|
138
|
+
# HTTP header 'Accept' (if needed)
|
|
139
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
138
140
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
139
141
|
|
|
140
142
|
# form parameters
|
|
@@ -296,6 +298,8 @@ module Phrase
|
|
|
296
298
|
|
|
297
299
|
# header parameters
|
|
298
300
|
header_params = opts[:header_params] || {}
|
|
301
|
+
# HTTP header 'Accept' (if needed)
|
|
302
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
299
303
|
# HTTP header 'Content-Type'
|
|
300
304
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
301
305
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
@@ -377,6 +381,8 @@ module Phrase
|
|
|
377
381
|
|
|
378
382
|
# header parameters
|
|
379
383
|
header_params = opts[:header_params] || {}
|
|
384
|
+
# HTTP header 'Accept' (if needed)
|
|
385
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
380
386
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
381
387
|
|
|
382
388
|
# form parameters
|
|
@@ -586,8 +592,8 @@ module Phrase
|
|
|
586
592
|
# @option opts [String] :branch specify the branch to use
|
|
587
593
|
# @option opts [String] :query Search query for comment messages
|
|
588
594
|
# @option opts [Array<String>] :locale_ids Search comments by their assigned locales
|
|
589
|
-
# @option opts [Array<String>] :filters Specify the filter for the comments
|
|
590
|
-
# @option opts [String] :order Order direction.
|
|
595
|
+
# @option opts [Array<String>] :filters Specify the filter for the comments. Supported values are `read` and `unread`. Combine both to return all comments (read + unread) without filtering.
|
|
596
|
+
# @option opts [String] :order Order direction. Defaults to `desc`. Values other than `asc` and `desc` fall back to `desc`.
|
|
591
597
|
# @return [Array<Comment>]
|
|
592
598
|
def comments_list(project_id, key_id, opts = {})
|
|
593
599
|
data, _status_code, _headers = comments_list_with_http_info(project_id, key_id, opts)
|
|
@@ -605,8 +611,8 @@ module Phrase
|
|
|
605
611
|
# @option opts [String] :branch specify the branch to use
|
|
606
612
|
# @option opts [String] :query Search query for comment messages
|
|
607
613
|
# @option opts [Array<String>] :locale_ids Search comments by their assigned locales
|
|
608
|
-
# @option opts [Array<String>] :filters Specify the filter for the comments
|
|
609
|
-
# @option opts [String] :order Order direction.
|
|
614
|
+
# @option opts [Array<String>] :filters Specify the filter for the comments. Supported values are `read` and `unread`. Combine both to return all comments (read + unread) without filtering.
|
|
615
|
+
# @option opts [String] :order Order direction. Defaults to `desc`. Values other than `asc` and `desc` fall back to `desc`.
|
|
610
616
|
# @return [Array<(Response<(Array<Comment>)>, Integer, Hash)>] Response<(Array<Comment>)> data, response status code and response headers
|
|
611
617
|
def comments_list_with_http_info(project_id, key_id, opts = {})
|
|
612
618
|
if @api_client.config.debugging
|
|
@@ -620,6 +626,14 @@ module Phrase
|
|
|
620
626
|
if @api_client.config.client_side_validation && key_id.nil?
|
|
621
627
|
fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comments_list"
|
|
622
628
|
end
|
|
629
|
+
allowable_values = ["read", "unread"]
|
|
630
|
+
if @api_client.config.client_side_validation && opts[:'filters'] && !opts[:'filters'].all? { |item| allowable_values.include?(item) }
|
|
631
|
+
fail ArgumentError, "invalid value for \"filters\", must include one of #{allowable_values}"
|
|
632
|
+
end
|
|
633
|
+
allowable_values = ["asc", "desc"]
|
|
634
|
+
if @api_client.config.client_side_validation && opts[:'order'] && !allowable_values.include?(opts[:'order'])
|
|
635
|
+
fail ArgumentError, "invalid value for \"order\", must be one of #{allowable_values}"
|
|
636
|
+
end
|
|
623
637
|
# resource path
|
|
624
638
|
local_var_path = '/projects/{project_id}/keys/{key_id}/comments'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s))
|
|
625
639
|
|
|
@@ -13,7 +13,7 @@ module Phrase
|
|
|
13
13
|
# @param distribution_create_parameters [DistributionCreateParameters]
|
|
14
14
|
# @param [Hash] opts the optional parameters
|
|
15
15
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
16
|
-
# @return [
|
|
16
|
+
# @return [DistributionDetails]
|
|
17
17
|
def distribution_create(account_id, distribution_create_parameters, opts = {})
|
|
18
18
|
data, _status_code, _headers = distribution_create_with_http_info(account_id, distribution_create_parameters, opts)
|
|
19
19
|
data
|
|
@@ -25,7 +25,7 @@ module Phrase
|
|
|
25
25
|
# @param distribution_create_parameters [DistributionCreateParameters]
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
28
|
-
# @return [Array<(Response<(
|
|
28
|
+
# @return [Array<(Response<(DistributionDetails)>, Integer, Hash)>] Response<(DistributionDetails)> data, response status code and response headers
|
|
29
29
|
def distribution_create_with_http_info(account_id, distribution_create_parameters, opts = {})
|
|
30
30
|
if @api_client.config.debugging
|
|
31
31
|
@api_client.config.logger.debug 'Calling API: DistributionsApi.distribution_create ...'
|
|
@@ -59,7 +59,7 @@ module Phrase
|
|
|
59
59
|
post_body = opts[:body] || @api_client.object_to_http_body(distribution_create_parameters)
|
|
60
60
|
|
|
61
61
|
# return_type
|
|
62
|
-
return_type = opts[:return_type] || '
|
|
62
|
+
return_type = opts[:return_type] || 'DistributionDetails'
|
|
63
63
|
|
|
64
64
|
# auth_names
|
|
65
65
|
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
|
@@ -120,6 +120,8 @@ module Phrase
|
|
|
120
120
|
|
|
121
121
|
# header parameters
|
|
122
122
|
header_params = opts[:header_params] || {}
|
|
123
|
+
# HTTP header 'Accept' (if needed)
|
|
124
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
123
125
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
124
126
|
|
|
125
127
|
# form parameters
|
|
@@ -157,7 +159,7 @@ module Phrase
|
|
|
157
159
|
# @param id [String] ID
|
|
158
160
|
# @param [Hash] opts the optional parameters
|
|
159
161
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
160
|
-
# @return [
|
|
162
|
+
# @return [DistributionDetails]
|
|
161
163
|
def distribution_show(account_id, id, opts = {})
|
|
162
164
|
data, _status_code, _headers = distribution_show_with_http_info(account_id, id, opts)
|
|
163
165
|
data
|
|
@@ -169,7 +171,7 @@ module Phrase
|
|
|
169
171
|
# @param id [String] ID
|
|
170
172
|
# @param [Hash] opts the optional parameters
|
|
171
173
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
172
|
-
# @return [Array<(Response<(
|
|
174
|
+
# @return [Array<(Response<(DistributionDetails)>, Integer, Hash)>] Response<(DistributionDetails)> data, response status code and response headers
|
|
173
175
|
def distribution_show_with_http_info(account_id, id, opts = {})
|
|
174
176
|
if @api_client.config.debugging
|
|
175
177
|
@api_client.config.logger.debug 'Calling API: DistributionsApi.distribution_show ...'
|
|
@@ -201,7 +203,7 @@ module Phrase
|
|
|
201
203
|
post_body = opts[:body]
|
|
202
204
|
|
|
203
205
|
# return_type
|
|
204
|
-
return_type = opts[:return_type] || '
|
|
206
|
+
return_type = opts[:return_type] || 'DistributionDetails'
|
|
205
207
|
|
|
206
208
|
# auth_names
|
|
207
209
|
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
|
@@ -230,7 +232,7 @@ module Phrase
|
|
|
230
232
|
# @param distribution_update_parameters [DistributionUpdateParameters]
|
|
231
233
|
# @param [Hash] opts the optional parameters
|
|
232
234
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
233
|
-
# @return [
|
|
235
|
+
# @return [DistributionDetails]
|
|
234
236
|
def distribution_update(account_id, id, distribution_update_parameters, opts = {})
|
|
235
237
|
data, _status_code, _headers = distribution_update_with_http_info(account_id, id, distribution_update_parameters, opts)
|
|
236
238
|
data
|
|
@@ -243,7 +245,7 @@ module Phrase
|
|
|
243
245
|
# @param distribution_update_parameters [DistributionUpdateParameters]
|
|
244
246
|
# @param [Hash] opts the optional parameters
|
|
245
247
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
246
|
-
# @return [Array<(Response<(
|
|
248
|
+
# @return [Array<(Response<(DistributionDetails)>, Integer, Hash)>] Response<(DistributionDetails)> data, response status code and response headers
|
|
247
249
|
def distribution_update_with_http_info(account_id, id, distribution_update_parameters, opts = {})
|
|
248
250
|
if @api_client.config.debugging
|
|
249
251
|
@api_client.config.logger.debug 'Calling API: DistributionsApi.distribution_update ...'
|
|
@@ -281,7 +283,7 @@ module Phrase
|
|
|
281
283
|
post_body = opts[:body] || @api_client.object_to_http_body(distribution_update_parameters)
|
|
282
284
|
|
|
283
285
|
# return_type
|
|
284
|
-
return_type = opts[:return_type] || '
|
|
286
|
+
return_type = opts[:return_type] || 'DistributionDetails'
|
|
285
287
|
|
|
286
288
|
# auth_names
|
|
287
289
|
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
|
@@ -310,7 +312,7 @@ module Phrase
|
|
|
310
312
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
311
313
|
# @option opts [Integer] :page Page number
|
|
312
314
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
313
|
-
# @return [Array<
|
|
315
|
+
# @return [Array<Distribution>]
|
|
314
316
|
def distributions_list(account_id, opts = {})
|
|
315
317
|
data, _status_code, _headers = distributions_list_with_http_info(account_id, opts)
|
|
316
318
|
data
|
|
@@ -323,7 +325,7 @@ module Phrase
|
|
|
323
325
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
324
326
|
# @option opts [Integer] :page Page number
|
|
325
327
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
326
|
-
# @return [Array<(Response<(Array<
|
|
328
|
+
# @return [Array<(Response<(Array<Distribution>)>, Integer, Hash)>] Response<(Array<Distribution>)> data, response status code and response headers
|
|
327
329
|
def distributions_list_with_http_info(account_id, opts = {})
|
|
328
330
|
if @api_client.config.debugging
|
|
329
331
|
@api_client.config.logger.debug 'Calling API: DistributionsApi.distributions_list ...'
|
|
@@ -353,7 +355,7 @@ module Phrase
|
|
|
353
355
|
post_body = opts[:body]
|
|
354
356
|
|
|
355
357
|
# return_type
|
|
356
|
-
return_type = opts[:return_type] || 'Array<
|
|
358
|
+
return_type = opts[:return_type] || 'Array<Distribution>'
|
|
357
359
|
|
|
358
360
|
# auth_names
|
|
359
361
|
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
|
@@ -46,6 +46,8 @@ module Phrase
|
|
|
46
46
|
|
|
47
47
|
# header parameters
|
|
48
48
|
header_params = opts[:header_params] || {}
|
|
49
|
+
# HTTP header 'Accept' (if needed)
|
|
50
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
49
51
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
50
52
|
|
|
51
53
|
# form parameters
|
|
@@ -84,6 +86,7 @@ module Phrase
|
|
|
84
86
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
85
87
|
# @option opts [Integer] :page Page number
|
|
86
88
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
89
|
+
# @option opts [String] :q Search query. Filters documents by name (case-insensitive substring match).
|
|
87
90
|
# @return [Array<Document>]
|
|
88
91
|
def documents_list(project_id, opts = {})
|
|
89
92
|
data, _status_code, _headers = documents_list_with_http_info(project_id, opts)
|
|
@@ -97,6 +100,7 @@ module Phrase
|
|
|
97
100
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
98
101
|
# @option opts [Integer] :page Page number
|
|
99
102
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
103
|
+
# @option opts [String] :q Search query. Filters documents by name (case-insensitive substring match).
|
|
100
104
|
# @return [Array<(Response<(Array<Document>)>, Integer, Hash)>] Response<(Array<Document>)> data, response status code and response headers
|
|
101
105
|
def documents_list_with_http_info(project_id, opts = {})
|
|
102
106
|
if @api_client.config.debugging
|
|
@@ -113,6 +117,7 @@ module Phrase
|
|
|
113
117
|
query_params = opts[:query_params] || {}
|
|
114
118
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
115
119
|
query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
|
|
120
|
+
query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
|
|
116
121
|
|
|
117
122
|
# header parameters
|
|
118
123
|
header_params = opts[:header_params] || {}
|
|
@@ -126,6 +126,8 @@ module Phrase
|
|
|
126
126
|
|
|
127
127
|
# header parameters
|
|
128
128
|
header_params = opts[:header_params] || {}
|
|
129
|
+
# HTTP header 'Accept' (if needed)
|
|
130
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
129
131
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
130
132
|
|
|
131
133
|
# form parameters
|
|
@@ -192,6 +192,8 @@ module Phrase
|
|
|
192
192
|
|
|
193
193
|
# header parameters
|
|
194
194
|
header_params = opts[:header_params] || {}
|
|
195
|
+
# HTTP header 'Accept' (if needed)
|
|
196
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
195
197
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
196
198
|
|
|
197
199
|
# form parameters
|
|
@@ -144,6 +144,8 @@ module Phrase
|
|
|
144
144
|
|
|
145
145
|
# header parameters
|
|
146
146
|
header_params = opts[:header_params] || {}
|
|
147
|
+
# HTTP header 'Accept' (if needed)
|
|
148
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
147
149
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
148
150
|
|
|
149
151
|
# form parameters
|
|
@@ -132,6 +132,8 @@ module Phrase
|
|
|
132
132
|
|
|
133
133
|
# header parameters
|
|
134
134
|
header_params = opts[:header_params] || {}
|
|
135
|
+
# HTTP header 'Accept' (if needed)
|
|
136
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
135
137
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
136
138
|
|
|
137
139
|
# form parameters
|
|
@@ -120,6 +120,8 @@ module Phrase
|
|
|
120
120
|
|
|
121
121
|
# header parameters
|
|
122
122
|
header_params = opts[:header_params] || {}
|
|
123
|
+
# HTTP header 'Accept' (if needed)
|
|
124
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
123
125
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
124
126
|
|
|
125
127
|
# form parameters
|
|
@@ -123,6 +123,8 @@ module Phrase
|
|
|
123
123
|
|
|
124
124
|
# header parameters
|
|
125
125
|
header_params = opts[:header_params] || {}
|
|
126
|
+
# HTTP header 'Accept' (if needed)
|
|
127
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
126
128
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
127
129
|
|
|
128
130
|
# form parameters
|
data/lib/phrase/api/jobs_api.rb
CHANGED
|
@@ -203,6 +203,8 @@ module Phrase
|
|
|
203
203
|
|
|
204
204
|
# header parameters
|
|
205
205
|
header_params = opts[:header_params] || {}
|
|
206
|
+
# HTTP header 'Accept' (if needed)
|
|
207
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
206
208
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
207
209
|
|
|
208
210
|
# form parameters
|
|
@@ -399,7 +401,7 @@ module Phrase
|
|
|
399
401
|
# @param [Hash] opts the optional parameters
|
|
400
402
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
401
403
|
# @option opts [String] :branch specify the branch to use
|
|
402
|
-
# @return [
|
|
404
|
+
# @return [JobDetails]
|
|
403
405
|
def job_lock(project_id, id, opts = {})
|
|
404
406
|
data, _status_code, _headers = job_lock_with_http_info(project_id, id, opts)
|
|
405
407
|
data
|
|
@@ -412,7 +414,7 @@ module Phrase
|
|
|
412
414
|
# @param [Hash] opts the optional parameters
|
|
413
415
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
414
416
|
# @option opts [String] :branch specify the branch to use
|
|
415
|
-
# @return [Array<(Response
|
|
417
|
+
# @return [Array<(Response<(JobDetails)>, Integer, Hash)>] Response<(JobDetails)> data, response status code and response headers
|
|
416
418
|
def job_lock_with_http_info(project_id, id, opts = {})
|
|
417
419
|
if @api_client.config.debugging
|
|
418
420
|
@api_client.config.logger.debug 'Calling API: JobsApi.job_lock ...'
|
|
@@ -434,6 +436,8 @@ module Phrase
|
|
|
434
436
|
|
|
435
437
|
# header parameters
|
|
436
438
|
header_params = opts[:header_params] || {}
|
|
439
|
+
# HTTP header 'Accept' (if needed)
|
|
440
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
437
441
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
438
442
|
|
|
439
443
|
# form parameters
|
|
@@ -443,7 +447,7 @@ module Phrase
|
|
|
443
447
|
post_body = opts[:body]
|
|
444
448
|
|
|
445
449
|
# return_type
|
|
446
|
-
return_type = opts[:return_type]
|
|
450
|
+
return_type = opts[:return_type] || 'JobDetails'
|
|
447
451
|
|
|
448
452
|
# auth_names
|
|
449
453
|
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
|
@@ -713,7 +717,7 @@ module Phrase
|
|
|
713
717
|
# @param [Hash] opts the optional parameters
|
|
714
718
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
715
719
|
# @option opts [String] :branch specify the branch to use
|
|
716
|
-
# @return [
|
|
720
|
+
# @return [JobDetails]
|
|
717
721
|
def job_unlock(project_id, id, opts = {})
|
|
718
722
|
data, _status_code, _headers = job_unlock_with_http_info(project_id, id, opts)
|
|
719
723
|
data
|
|
@@ -726,7 +730,7 @@ module Phrase
|
|
|
726
730
|
# @param [Hash] opts the optional parameters
|
|
727
731
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
728
732
|
# @option opts [String] :branch specify the branch to use
|
|
729
|
-
# @return [Array<(Response
|
|
733
|
+
# @return [Array<(Response<(JobDetails)>, Integer, Hash)>] Response<(JobDetails)> data, response status code and response headers
|
|
730
734
|
def job_unlock_with_http_info(project_id, id, opts = {})
|
|
731
735
|
if @api_client.config.debugging
|
|
732
736
|
@api_client.config.logger.debug 'Calling API: JobsApi.job_unlock ...'
|
|
@@ -748,6 +752,8 @@ module Phrase
|
|
|
748
752
|
|
|
749
753
|
# header parameters
|
|
750
754
|
header_params = opts[:header_params] || {}
|
|
755
|
+
# HTTP header 'Accept' (if needed)
|
|
756
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
751
757
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
752
758
|
|
|
753
759
|
# form parameters
|
|
@@ -757,7 +763,7 @@ module Phrase
|
|
|
757
763
|
post_body = opts[:body]
|
|
758
764
|
|
|
759
765
|
# return_type
|
|
760
|
-
return_type = opts[:return_type]
|
|
766
|
+
return_type = opts[:return_type] || 'JobDetails'
|
|
761
767
|
|
|
762
768
|
# auth_names
|
|
763
769
|
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
|
@@ -954,6 +960,8 @@ module Phrase
|
|
|
954
960
|
# @option opts [String] :owned_by filter by user owning job
|
|
955
961
|
# @option opts [String] :assigned_to filter by user assigned to job
|
|
956
962
|
# @option opts [String] :state filter by state of job; valid states are: `draft`, `in_progress`, `completed`
|
|
963
|
+
# @option opts [Array<String>] :states Filter by multiple job states at once. Accepted values are the same as `state`. When supplied, `state` is ignored. Rejected with `400 Bad Request` if any value is unknown.
|
|
964
|
+
# @option opts [String] :key_id Filter to jobs that include the translation key identified by this code (matches via the job's tags).
|
|
957
965
|
# @option opts [String] :updated_since filter by jobs updated since given date
|
|
958
966
|
# @return [Array<Job>]
|
|
959
967
|
def jobs_list(project_id, opts = {})
|
|
@@ -972,6 +980,8 @@ module Phrase
|
|
|
972
980
|
# @option opts [String] :owned_by filter by user owning job
|
|
973
981
|
# @option opts [String] :assigned_to filter by user assigned to job
|
|
974
982
|
# @option opts [String] :state filter by state of job; valid states are: `draft`, `in_progress`, `completed`
|
|
983
|
+
# @option opts [Array<String>] :states Filter by multiple job states at once. Accepted values are the same as `state`. When supplied, `state` is ignored. Rejected with `400 Bad Request` if any value is unknown.
|
|
984
|
+
# @option opts [String] :key_id Filter to jobs that include the translation key identified by this code (matches via the job's tags).
|
|
975
985
|
# @option opts [String] :updated_since filter by jobs updated since given date
|
|
976
986
|
# @return [Array<(Response<(Array<Job>)>, Integer, Hash)>] Response<(Array<Job>)> data, response status code and response headers
|
|
977
987
|
def jobs_list_with_http_info(project_id, opts = {})
|
|
@@ -993,6 +1003,8 @@ module Phrase
|
|
|
993
1003
|
query_params[:'owned_by'] = opts[:'owned_by'] if !opts[:'owned_by'].nil?
|
|
994
1004
|
query_params[:'assigned_to'] = opts[:'assigned_to'] if !opts[:'assigned_to'].nil?
|
|
995
1005
|
query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
|
|
1006
|
+
query_params[:'states'] = @api_client.build_collection_param(opts[:'states'], :multi) if !opts[:'states'].nil?
|
|
1007
|
+
query_params[:'key_id'] = opts[:'key_id'] if !opts[:'key_id'].nil?
|
|
996
1008
|
query_params[:'updated_since'] = opts[:'updated_since'] if !opts[:'updated_since'].nil?
|
|
997
1009
|
|
|
998
1010
|
# header parameters
|
data/lib/phrase/api/keys_api.rb
CHANGED
|
@@ -123,6 +123,8 @@ module Phrase
|
|
|
123
123
|
|
|
124
124
|
# header parameters
|
|
125
125
|
header_params = opts[:header_params] || {}
|
|
126
|
+
# HTTP header 'Accept' (if needed)
|
|
127
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
126
128
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
127
129
|
|
|
128
130
|
# form parameters
|
|
@@ -12,6 +12,8 @@ module Phrase
|
|
|
12
12
|
# @param id [String] ID
|
|
13
13
|
# @param [Hash] opts the optional parameters
|
|
14
14
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
15
|
+
# @option opts [Integer] :page Page number
|
|
16
|
+
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
15
17
|
# @return [Array<LocalePreview1>]
|
|
16
18
|
def account_locales(id, opts = {})
|
|
17
19
|
data, _status_code, _headers = account_locales_with_http_info(id, opts)
|
|
@@ -23,6 +25,8 @@ module Phrase
|
|
|
23
25
|
# @param id [String] ID
|
|
24
26
|
# @param [Hash] opts the optional parameters
|
|
25
27
|
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
|
28
|
+
# @option opts [Integer] :page Page number
|
|
29
|
+
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
26
30
|
# @return [Array<(Response<(Array<LocalePreview1>)>, Integer, Hash)>] Response<(Array<LocalePreview1>)> data, response status code and response headers
|
|
27
31
|
def account_locales_with_http_info(id, opts = {})
|
|
28
32
|
if @api_client.config.debugging
|
|
@@ -37,6 +41,8 @@ module Phrase
|
|
|
37
41
|
|
|
38
42
|
# query parameters
|
|
39
43
|
query_params = opts[:query_params] || {}
|
|
44
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
45
|
+
query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
|
|
40
46
|
|
|
41
47
|
# header parameters
|
|
42
48
|
header_params = opts[:header_params] || {}
|
|
@@ -189,6 +195,8 @@ module Phrase
|
|
|
189
195
|
|
|
190
196
|
# header parameters
|
|
191
197
|
header_params = opts[:header_params] || {}
|
|
198
|
+
# HTTP header 'Accept' (if needed)
|
|
199
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
192
200
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
193
201
|
|
|
194
202
|
# form parameters
|
|
@@ -46,6 +46,8 @@ module Phrase
|
|
|
46
46
|
|
|
47
47
|
# header parameters
|
|
48
48
|
header_params = opts[:header_params] || {}
|
|
49
|
+
# HTTP header 'Accept' (if needed)
|
|
50
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
49
51
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
50
52
|
|
|
51
53
|
# form parameters
|
|
@@ -14,6 +14,7 @@ module Phrase
|
|
|
14
14
|
# @option opts [Integer] :page Page number
|
|
15
15
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
16
16
|
# @option opts [Boolean] :unseen Include only unseen notifications
|
|
17
|
+
# @option opts [Integer] :last_days Restrict the results to notifications created within the last N days. Coerced to integer; non-numeric values resolve to 0 (returning nothing).
|
|
17
18
|
# @return [Array<Notification>]
|
|
18
19
|
def notifications_list(opts = {})
|
|
19
20
|
data, _status_code, _headers = notifications_list_with_http_info(opts)
|
|
@@ -27,6 +28,7 @@ module Phrase
|
|
|
27
28
|
# @option opts [Integer] :page Page number
|
|
28
29
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
29
30
|
# @option opts [Boolean] :unseen Include only unseen notifications
|
|
31
|
+
# @option opts [Integer] :last_days Restrict the results to notifications created within the last N days. Coerced to integer; non-numeric values resolve to 0 (returning nothing).
|
|
30
32
|
# @return [Array<(Response<(Array<Notification>)>, Integer, Hash)>] Response<(Array<Notification>)> data, response status code and response headers
|
|
31
33
|
def notifications_list_with_http_info(opts = {})
|
|
32
34
|
if @api_client.config.debugging
|
|
@@ -40,6 +42,7 @@ module Phrase
|
|
|
40
42
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
41
43
|
query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
|
|
42
44
|
query_params[:'unseen'] = opts[:'unseen'] if !opts[:'unseen'].nil?
|
|
45
|
+
query_params[:'last_days'] = opts[:'last_days'] if !opts[:'last_days'].nil?
|
|
43
46
|
|
|
44
47
|
# header parameters
|
|
45
48
|
header_params = opts[:header_params] || {}
|
|
@@ -203,6 +203,8 @@ module Phrase
|
|
|
203
203
|
|
|
204
204
|
# header parameters
|
|
205
205
|
header_params = opts[:header_params] || {}
|
|
206
|
+
# HTTP header 'Accept' (if needed)
|
|
207
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
206
208
|
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
|
207
209
|
|
|
208
210
|
# form parameters
|
|
@@ -317,6 +319,7 @@ module Phrase
|
|
|
317
319
|
# @option opts [Integer] :page Page number
|
|
318
320
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
319
321
|
# @option opts [String] :branch specify the branch to use
|
|
322
|
+
# @option opts [String] :translation_id Filter the result to orders that include the given translation. When supplied with a translation code that does not exist, an empty list is returned.
|
|
320
323
|
# @return [Array<TranslationOrder>]
|
|
321
324
|
def orders_list(project_id, opts = {})
|
|
322
325
|
data, _status_code, _headers = orders_list_with_http_info(project_id, opts)
|
|
@@ -331,6 +334,7 @@ module Phrase
|
|
|
331
334
|
# @option opts [Integer] :page Page number
|
|
332
335
|
# @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
|
|
333
336
|
# @option opts [String] :branch specify the branch to use
|
|
337
|
+
# @option opts [String] :translation_id Filter the result to orders that include the given translation. When supplied with a translation code that does not exist, an empty list is returned.
|
|
334
338
|
# @return [Array<(Response<(Array<TranslationOrder>)>, Integer, Hash)>] Response<(Array<TranslationOrder>)> data, response status code and response headers
|
|
335
339
|
def orders_list_with_http_info(project_id, opts = {})
|
|
336
340
|
if @api_client.config.debugging
|
|
@@ -348,6 +352,7 @@ module Phrase
|
|
|
348
352
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
349
353
|
query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
|
|
350
354
|
query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
|
|
355
|
+
query_params[:'translation_id'] = opts[:'translation_id'] if !opts[:'translation_id'].nil?
|
|
351
356
|
|
|
352
357
|
# header parameters
|
|
353
358
|
header_params = opts[:header_params] || {}
|