phrase 2.7.2 → 2.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (40) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +39 -13
  3. data/docs/BitbucketSyncApi.md +9 -9
  4. data/docs/BranchMergeParameters.md +2 -2
  5. data/docs/GitHubSyncApi.md +8 -8
  6. data/docs/GitLabSyncApi.md +8 -8
  7. data/docs/LocaleCreateParameters.md +3 -3
  8. data/docs/LocaleUpdateParameters.md +3 -3
  9. data/docs/LocalesApi.md +4 -4
  10. data/docs/ProjectCreateParameters.md +4 -4
  11. data/docs/ProjectUpdateParameters.md +4 -4
  12. data/docs/TeamsApi.md +3 -3
  13. data/docs/TranslationCreateParameters.md +1 -1
  14. data/docs/TranslationUpdateParameters.md +1 -1
  15. data/docs/WebhookDeliveriesApi.md +206 -0
  16. data/docs/WebhookDelivery.md +29 -0
  17. data/lib/phrase/api/bitbucket_sync_api.rb +10 -10
  18. data/lib/phrase/api/git_hub_sync_api.rb +8 -8
  19. data/lib/phrase/api/git_lab_sync_api.rb +10 -10
  20. data/lib/phrase/api/locales_api.rb +4 -4
  21. data/lib/phrase/api/teams_api.rb +3 -3
  22. data/lib/phrase/api/webhook_deliveries_api.rb +241 -0
  23. data/lib/phrase/models/branch_merge_parameters.rb +1 -1
  24. data/lib/phrase/models/locale_create_parameters.rb +3 -3
  25. data/lib/phrase/models/locale_update_parameters.rb +3 -3
  26. data/lib/phrase/models/project_create_parameters.rb +4 -4
  27. data/lib/phrase/models/project_update_parameters.rb +4 -4
  28. data/lib/phrase/models/translation_create_parameters.rb +1 -1
  29. data/lib/phrase/models/translation_update_parameters.rb +1 -1
  30. data/lib/phrase/models/webhook_delivery.rb +248 -0
  31. data/lib/phrase/version.rb +1 -1
  32. data/lib/phrase.rb +2 -0
  33. data/phrase.gemspec +2 -2
  34. data/spec/api/bitbucket_sync_api_spec.rb +5 -5
  35. data/spec/api/git_hub_sync_api_spec.rb +4 -4
  36. data/spec/api/git_lab_sync_api_spec.rb +5 -5
  37. data/spec/api/locales_api_spec.rb +2 -2
  38. data/spec/api/webhook_deliveries_api_spec.rb +68 -0
  39. data/spec/models/webhook_delivery_spec.rb +65 -0
  40. metadata +212 -204
data/phrase.gemspec CHANGED
@@ -10,8 +10,8 @@ Gem::Specification.new do |s|
10
10
  s.authors = ["Phrase"]
11
11
  s.email = ["support@phrase.com"]
12
12
  s.homepage = "https://phrase.com"
13
- s.summary = "You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase for your account."
14
- s.description = "Phrase is a translation management platform for software projects."
13
+ s.summary = "You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase Strings for your account."
14
+ s.description = "Phrase Strings is a translation management platform for software projects."
15
15
  s.license = 'MIT'
16
16
  s.required_ruby_version = ">= 2.6.0"
17
17
 
@@ -21,8 +21,8 @@ describe 'BitbucketSyncApi' do
21
21
  end
22
22
 
23
23
  # unit tests for bitbucket_sync_export
24
- # Export from Phrase to Bitbucket
25
- # Export translations from Phrase to Bitbucket according to the .phraseapp.yml file within the Bitbucket Repository.
24
+ # Export from Phrase Strings to Bitbucket
25
+ # Export translations from Phrase Strings to Bitbucket according to the .phraseapp.yml file within the Bitbucket Repository.
26
26
  # @param id ID
27
27
  # @param bitbucket_sync_export_parameters
28
28
  # @param [Hash] opts the optional parameters
@@ -35,8 +35,8 @@ describe 'BitbucketSyncApi' do
35
35
  end
36
36
 
37
37
  # unit tests for bitbucket_sync_import
38
- # Import to Phrase from Bitbucket
39
- # Import translations from Bitbucket to Phrase according to the .phraseapp.yml file within the Bitbucket repository.
38
+ # Import to Phrase Strings from Bitbucket
39
+ # Import translations from Bitbucket to Phrase Strings according to the .phraseapp.yml file within the Bitbucket repository.
40
40
  # @param id ID
41
41
  # @param bitbucket_sync_import_parameters
42
42
  # @param [Hash] opts the optional parameters
@@ -50,7 +50,7 @@ describe 'BitbucketSyncApi' do
50
50
 
51
51
  # unit tests for bitbucket_syncs_list
52
52
  # List Bitbucket syncs
53
- # List all Bitbucket repositories for which synchronisation with Phrase is activated.
53
+ # List all Bitbucket repositories for which synchronisation with Phrase Strings is activated.
54
54
  # @param [Hash] opts the optional parameters
55
55
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
56
56
  # @option opts [String] :account_id Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts.
@@ -21,8 +21,8 @@ describe 'GitHubSyncApi' do
21
21
  end
22
22
 
23
23
  # unit tests for github_sync_export
24
- # Export from Phrase to GitHub
25
- # Export translations from Phrase to GitHub according to the .phraseapp.yml file within the GitHub repository.
24
+ # Export from Phrase Strings to GitHub
25
+ # Export translations from Phrase Strings to GitHub according to the .phraseapp.yml file within the GitHub repository.
26
26
  # @param github_sync_export_parameters
27
27
  # @param [Hash] opts the optional parameters
28
28
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
@@ -34,8 +34,8 @@ describe 'GitHubSyncApi' do
34
34
  end
35
35
 
36
36
  # unit tests for github_sync_import
37
- # Import to Phrase from GitHub
38
- # Import files to Phrase from your connected GitHub repository.
37
+ # Import to Phrase Strings from GitHub
38
+ # Import files to Phrase Strings from your connected GitHub repository.
39
39
  # @param github_sync_import_parameters
40
40
  # @param [Hash] opts the optional parameters
41
41
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
@@ -35,8 +35,8 @@ describe 'GitLabSyncApi' do
35
35
  end
36
36
 
37
37
  # unit tests for gitlab_sync_export
38
- # Export from Phrase to GitLab
39
- # Export translations from Phrase to GitLab according to the .phraseapp.yml file within the GitLab repository.
38
+ # Export from Phrase Strings to GitLab
39
+ # Export translations from Phrase Strings to GitLab according to the .phraseapp.yml file within the GitLab repository.
40
40
  # @param gitlab_sync_id Gitlab Sync ID
41
41
  # @param gitlab_sync_export_parameters
42
42
  # @param [Hash] opts the optional parameters
@@ -66,7 +66,7 @@ describe 'GitLabSyncApi' do
66
66
 
67
67
  # unit tests for gitlab_sync_import
68
68
  # Import from GitLab to Phrase
69
- # Import translations from GitLab to Phrase according to the .phraseapp.yml file within the GitLab repository.
69
+ # Import translations from GitLab to Phrase Strings according to the .phraseapp.yml file within the GitLab repository.
70
70
  # @param gitlab_sync_id Gitlab Sync ID
71
71
  # @param gitlab_sync_import_parameters
72
72
  # @param [Hash] opts the optional parameters
@@ -80,7 +80,7 @@ describe 'GitLabSyncApi' do
80
80
 
81
81
  # unit tests for gitlab_sync_list
82
82
  # List GitLab syncs
83
- # List all GitLab Sync Settings for which synchronisation with Phrase and GitLab is activated.
83
+ # List all GitLab Sync Settings for which synchronisation with Phrase Strings and GitLab is activated.
84
84
  # @param [Hash] opts the optional parameters
85
85
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
86
86
  # @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.
@@ -112,7 +112,7 @@ describe 'GitLabSyncApi' do
112
112
  # @param [Hash] opts the optional parameters
113
113
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
114
114
  # @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.
115
- # @option opts [String] :phrase_project_code Code of the related Phrase Project.
115
+ # @option opts [String] :phrase_project_code Code of the related Phrase Strings Project.
116
116
  # @option opts [Integer] :gitlab_project_id ID of the related GitLab Project.
117
117
  # @option opts [String] :gitlab_branch_name Name of the GitLab Branch.
118
118
  # @return [GitlabSync]
@@ -72,7 +72,7 @@ describe 'LocalesApi' do
72
72
  # @param [Hash] opts the optional parameters
73
73
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
74
74
  # @option opts [String] :branch specify the branch to use
75
- # @option opts [String] :file_format File format name. See the <a href=\"https://help.phrase.com/help/supported-platforms-and-formats\">format guide</a> for all supported file formats.
75
+ # @option opts [String] :file_format File format name. See the <a href=\"https://support.phrase.com/hc/en-us/articles/5784070560412\">format guide</a> for all supported file formats.
76
76
  # @option opts [String] :tags Limit results to keys tagged with a list of comma separated tag names.
77
77
  # @option opts [String] :tag Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead
78
78
  # @option opts [Boolean] :include_empty_translations Indicates whether keys without translations should be included in the output as well.
@@ -80,7 +80,7 @@ describe 'LocalesApi' do
80
80
  # @option opts [Boolean] :include_translated_keys Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
81
81
  # @option opts [Boolean] :keep_notranslate_tags Indicates whether [NOTRANSLATE] tags should be kept.
82
82
  # @option opts [Boolean] :convert_emoji This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.
83
- # @option opts [Object] :format_options Additional formatting and render options. See the <a href=\"https://help.phrase.com/help/supported-platforms-and-formats\">format guide</a> for a list of options available for each format. Specify format options like this: <code>...&format_options[foo]=bar</code>
83
+ # @option opts [Object] :format_options Additional formatting and render options. See the <a href=\"https://support.phrase.com/hc/en-us/articles/5784070560412\">format guide</a> for a list of options available for each format. Specify format options like this: <code>...&format_options[foo]=bar</code>
84
84
  # @option opts [String] :encoding Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\".
85
85
  # @option opts [Boolean] :skip_unverified_translations Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with <code>include_unverified_translations</code>.
86
86
  # @option opts [Boolean] :include_unverified_translations if set to false unverified translations are excluded
@@ -0,0 +1,68 @@
1
+ require 'spec_helper'
2
+ require 'json'
3
+
4
+ # Unit tests for Phrase::WebhookDeliveriesApi
5
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
6
+ # Please update as you see appropriate
7
+ describe 'WebhookDeliveriesApi' do
8
+ before do
9
+ # run before each test
10
+ @api_instance = Phrase::WebhookDeliveriesApi.new
11
+ end
12
+
13
+ after do
14
+ # run after each test
15
+ end
16
+
17
+ describe 'test an instance of WebhookDeliveriesApi' do
18
+ it 'should create an instance of WebhookDeliveriesApi' do
19
+ expect(@api_instance).to be_instance_of(Phrase::WebhookDeliveriesApi)
20
+ end
21
+ end
22
+
23
+ # unit tests for webhook_deliveries_list
24
+ # List webhook deliveries
25
+ # List all webhook deliveries for the given webhook_id.
26
+ # @param project_id Project ID
27
+ # @param webhook_id Webhook ID
28
+ # @param [Hash] opts the optional parameters
29
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
30
+ # @option opts [String] :response_status_codes List of Response Status Codes
31
+ # @return [Array<WebhookDelivery>]
32
+ describe 'webhook_deliveries_list test' do
33
+ it 'should work' do
34
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
35
+ end
36
+ end
37
+
38
+ # unit tests for webhook_deliveries_redeliver
39
+ # Redeliver a single webhook delivery
40
+ # Trigger an individual webhook delivery to be redelivered.
41
+ # @param project_id Project ID
42
+ # @param webhook_id Webhook ID
43
+ # @param id ID
44
+ # @param [Hash] opts the optional parameters
45
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
46
+ # @return [WebhookDelivery]
47
+ describe 'webhook_deliveries_redeliver test' do
48
+ it 'should work' do
49
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
+ end
51
+ end
52
+
53
+ # unit tests for webhook_deliveries_show
54
+ # Get a single webhook delivery
55
+ # Get all information about a single webhook delivery for the given ID.
56
+ # @param project_id Project ID
57
+ # @param webhook_id Webhook ID
58
+ # @param id ID
59
+ # @param [Hash] opts the optional parameters
60
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
61
+ # @return [WebhookDelivery]
62
+ describe 'webhook_deliveries_show test' do
63
+ it 'should work' do
64
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
65
+ end
66
+ end
67
+
68
+ end
@@ -0,0 +1,65 @@
1
+ require 'spec_helper'
2
+ require 'json'
3
+ require 'date'
4
+
5
+ # Unit tests for Phrase::WebhookDelivery
6
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
7
+ # Please update as you see appropriate
8
+ describe 'WebhookDelivery' do
9
+ before do
10
+ # run before each test
11
+ @instance = Phrase::WebhookDelivery.new
12
+ end
13
+
14
+ after do
15
+ # run after each test
16
+ end
17
+
18
+ describe 'test an instance of WebhookDelivery' do
19
+ it 'should create an instance of WebhookDelivery' do
20
+ expect(@instance).to be_instance_of(Phrase::WebhookDelivery)
21
+ end
22
+ end
23
+ describe 'test attribute "id"' do
24
+ it 'should work' do
25
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
26
+ end
27
+ end
28
+
29
+ describe 'test attribute "webhook_id"' do
30
+ it 'should work' do
31
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
32
+ end
33
+ end
34
+
35
+ describe 'test attribute "response_status_code"' do
36
+ it 'should work' do
37
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
38
+ end
39
+ end
40
+
41
+ describe 'test attribute "delivered_at"' do
42
+ it 'should work' do
43
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
+ end
45
+ end
46
+
47
+ describe 'test attribute "duration_ms"' do
48
+ it 'should work' do
49
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
+ end
51
+ end
52
+
53
+ describe 'test attribute "created_at"' do
54
+ it 'should work' do
55
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
+ end
57
+ end
58
+
59
+ describe 'test attribute "updated_at"' do
60
+ it 'should work' do
61
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
62
+ end
63
+ end
64
+
65
+ end