ruby-lokalise-api 6.0.0 → 6.1.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/README.md +1 -1
- data/lib/ruby_lokalise_api/rest/comments.rb +5 -5
- data/lib/ruby_lokalise_api/rest/contributors.rb +5 -5
- data/lib/ruby_lokalise_api/rest/custom_translation_statuses.rb +6 -6
- data/lib/ruby_lokalise_api/rest/files.rb +14 -3
- data/lib/ruby_lokalise_api/rest/keys.rb +7 -7
- data/lib/ruby_lokalise_api/rest/languages.rb +6 -6
- data/lib/ruby_lokalise_api/rest/payment_cards.rb +3 -3
- data/lib/ruby_lokalise_api/rest/projects.rb +6 -6
- data/lib/ruby_lokalise_api/rest/queued_processes.rb +2 -2
- data/lib/ruby_lokalise_api/rest/screenshots.rb +5 -5
- data/lib/ruby_lokalise_api/rest/segments.rb +3 -3
- data/lib/ruby_lokalise_api/rest/snapshots.rb +4 -4
- data/lib/ruby_lokalise_api/rest/tasks.rb +5 -5
- data/lib/ruby_lokalise_api/rest/team_user_billing_details.rb +3 -3
- data/lib/ruby_lokalise_api/rest/team_users.rb +4 -4
- data/lib/ruby_lokalise_api/rest/teams.rb +1 -1
- data/lib/ruby_lokalise_api/rest/translation_providers.rb +2 -2
- data/lib/ruby_lokalise_api/rest/translations.rb +3 -3
- data/lib/ruby_lokalise_api/rest/webhooks.rb +5 -5
- data/lib/ruby_lokalise_api/version.rb +1 -1
- data/ruby-lokalise-api.gemspec +1 -1
- metadata +18 -64
- data/spec/lib/ruby_lokalise_api/client/branches_spec.rb +0 -140
- data/spec/lib/ruby_lokalise_api/client/comments_spec.rb +0 -118
- data/spec/lib/ruby_lokalise_api/client/contributors_spec.rb +0 -132
- data/spec/lib/ruby_lokalise_api/client/custom_translation_statuses_spec.rb +0 -131
- data/spec/lib/ruby_lokalise_api/client/files_spec.rb +0 -66
- data/spec/lib/ruby_lokalise_api/client/keys_spec.rb +0 -199
- data/spec/lib/ruby_lokalise_api/client/languages_spec.rb +0 -134
- data/spec/lib/ruby_lokalise_api/client/orders_spec.rb +0 -113
- data/spec/lib/ruby_lokalise_api/client/payment_cards_spec.rb +0 -92
- data/spec/lib/ruby_lokalise_api/client/projects_spec.rb +0 -150
- data/spec/lib/ruby_lokalise_api/client/queued_processes_spec.rb +0 -57
- data/spec/lib/ruby_lokalise_api/client/screenshots_spec.rb +0 -127
- data/spec/lib/ruby_lokalise_api/client/segments_spec.rb +0 -106
- data/spec/lib/ruby_lokalise_api/client/snapshots_spec.rb +0 -117
- data/spec/lib/ruby_lokalise_api/client/tasks_spec.rb +0 -145
- data/spec/lib/ruby_lokalise_api/client/team_user_billing_details_spec.rb +0 -48
- data/spec/lib/ruby_lokalise_api/client/team_user_groups_spec.rb +0 -278
- data/spec/lib/ruby_lokalise_api/client/team_users_spec.rb +0 -95
- data/spec/lib/ruby_lokalise_api/client/teams_spec.rb +0 -25
- data/spec/lib/ruby_lokalise_api/client/translation_providers_spec.rb +0 -48
- data/spec/lib/ruby_lokalise_api/client/translations_spec.rb +0 -118
- data/spec/lib/ruby_lokalise_api/client/webhooks_spec.rb +0 -126
- data/spec/lib/ruby_lokalise_api/connection_spec.rb +0 -68
- data/spec/lib/ruby_lokalise_api/custom_json_parser_spec.rb +0 -81
- data/spec/lib/ruby_lokalise_api/error_spec.rb +0 -41
- data/spec/lib/ruby_lokalise_api/oauth2/auth_spec.rb +0 -73
- data/spec/lib/ruby_lokalise_api_spec.rb +0 -47
- data/spec/spec_helper.rb +0 -22
- data/spec/support/test_client.rb +0 -15
- data/spec/support/vcr.rb +0 -15
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 83ba3c3b7e6b33c712f31ef3e1d66daaed33604fd227b2fcef1cb8ed71fddd1c
|
4
|
+
data.tar.gz: 78b7decbd94a6bdd45c5b684cb07a0ee50a21045a757b3b7e61ab5c10c8618c6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a8cd7b58cf1c83534cc2faad45fd998ba200102db25a6a191483dd6d4ecb15809ca4563bd9965f052082fac93257daf53e4668fae7d3696bf90a886dd5fe1c11
|
7
|
+
data.tar.gz: '008fe8a740c7a1d3d53229367df62082b83b1a5665f97b6a6d03ac29fe863b8b970c5fb77eb7196c26690234ff07e62abb58e7f014a85ec1fde78ca32adb51ea'
|
data/README.md
CHANGED
@@ -20,7 +20,7 @@ $ gem install ruby-lokalise-api
|
|
20
20
|
Obtain an API token in your [personal profile](https://lokalise.com/profile#apitokens) (*API tokens* section) and initialize the client:
|
21
21
|
|
22
22
|
```ruby
|
23
|
-
require '
|
23
|
+
require 'ruby_lokalise_api'
|
24
24
|
|
25
25
|
@client = RubyLokaliseApi.client 'YOUR_TOKEN_HERE'
|
26
26
|
```
|
@@ -5,7 +5,7 @@ module RubyLokaliseApi
|
|
5
5
|
module Comments
|
6
6
|
# Returns a single comment for the given key
|
7
7
|
#
|
8
|
-
# @see https://
|
8
|
+
# @see https://developers.lokalise.com/reference/retrieve-a-comment
|
9
9
|
# @return [RubyLokaliseApi::Resources::Comment]
|
10
10
|
# @param project_id [String]
|
11
11
|
# @param key_id [String, Integer]
|
@@ -16,7 +16,7 @@ module RubyLokaliseApi
|
|
16
16
|
|
17
17
|
# Returns all comments for all keys inside the given project
|
18
18
|
#
|
19
|
-
# @see https://
|
19
|
+
# @see https://developers.lokalise.com/reference/list-project-comments
|
20
20
|
# @return [RubyLokaliseApi::Collection::Comment<RubyLokaliseApi::Resources::Comment>]
|
21
21
|
# @param project_id [String]
|
22
22
|
# @param params [Hash]
|
@@ -26,7 +26,7 @@ module RubyLokaliseApi
|
|
26
26
|
|
27
27
|
# Returns all comments for the given key inside the given project
|
28
28
|
#
|
29
|
-
# @see https://
|
29
|
+
# @see https://developers.lokalise.com/reference/list-key-comments
|
30
30
|
# @return [RubyLokaliseApi::Collection::Comment<RubyLokaliseApi::Resources::Comment>]
|
31
31
|
# @param project_id [String]
|
32
32
|
# @param key_id [String, Integer]
|
@@ -37,7 +37,7 @@ module RubyLokaliseApi
|
|
37
37
|
|
38
38
|
# Creates one or more comments for the given key inside the given project
|
39
39
|
#
|
40
|
-
# @see https://
|
40
|
+
# @see https://developers.lokalise.com/reference/create-comments
|
41
41
|
# @return [RubyLokaliseApi::Collection::Comment<RubyLokaliseApi::Resources::Comment>]
|
42
42
|
# @param project_id [String]
|
43
43
|
# @param key_id [String, Integer]
|
@@ -48,7 +48,7 @@ module RubyLokaliseApi
|
|
48
48
|
|
49
49
|
# Deletes comment for the given key inside the given project
|
50
50
|
#
|
51
|
-
# @see https://
|
51
|
+
# @see https://developers.lokalise.com/reference/delete-a-comment
|
52
52
|
# @return [Hash]
|
53
53
|
# @param project_id [String]
|
54
54
|
# @param key_id [String, Integer]
|
@@ -5,7 +5,7 @@ module RubyLokaliseApi
|
|
5
5
|
module Contributors
|
6
6
|
# Returns all contributors for the given project
|
7
7
|
#
|
8
|
-
# @see https://
|
8
|
+
# @see https://developers.lokalise.com/reference/list-all-contributors
|
9
9
|
# @return [RubyLokaliseApi::Collection::Contributor<RubyLokaliseApi::Resources::Contributor>]
|
10
10
|
# @param project_id [String]
|
11
11
|
# @param params [Hash]
|
@@ -15,7 +15,7 @@ module RubyLokaliseApi
|
|
15
15
|
|
16
16
|
# Returns a single contributor for the given project
|
17
17
|
#
|
18
|
-
# @see https://
|
18
|
+
# @see https://developers.lokalise.com/reference/retrieve-a-contributor
|
19
19
|
# @return [RubyLokaliseApi::Resources::Contributor]
|
20
20
|
# @param project_id [String]
|
21
21
|
# @param contributor_id [String, Integer]
|
@@ -25,7 +25,7 @@ module RubyLokaliseApi
|
|
25
25
|
|
26
26
|
# Creates one or more contributors inside the given project
|
27
27
|
#
|
28
|
-
# @see https://
|
28
|
+
# @see https://developers.lokalise.com/reference/create-contributors
|
29
29
|
# @return [RubyLokaliseApi::Collection::Contributor<RubyLokaliseApi::Resources::Contributor>]
|
30
30
|
# @param project_id [String]
|
31
31
|
# @param params [Hash, Array<Hash>]
|
@@ -35,7 +35,7 @@ module RubyLokaliseApi
|
|
35
35
|
|
36
36
|
# Updates the given contributor inside the given project
|
37
37
|
#
|
38
|
-
# @see https://
|
38
|
+
# @see https://developers.lokalise.com/reference/update-a-contributor
|
39
39
|
# @return [RubyLokaliseApi::Resources::Contributor]
|
40
40
|
# @param project_id [String]
|
41
41
|
# @param contributor_id [String, Integer]
|
@@ -46,7 +46,7 @@ module RubyLokaliseApi
|
|
46
46
|
|
47
47
|
# Deletes contributor inside the given project
|
48
48
|
#
|
49
|
-
# @see https://
|
49
|
+
# @see https://developers.lokalise.com/reference/delete-a-contributor
|
50
50
|
# @return [Hash]
|
51
51
|
# @param project_id [String]
|
52
52
|
# @param contributor_id [String, Integer]
|
@@ -5,7 +5,7 @@ module RubyLokaliseApi
|
|
5
5
|
module CustomTranslationStatuses
|
6
6
|
# Returns all translation statuses for the given project
|
7
7
|
#
|
8
|
-
# @see https://
|
8
|
+
# @see https://developers.lokalise.com/reference/list-all-custom-translation-statuses
|
9
9
|
# @return [RubyLokaliseApi::Collection::CustomTranslationStatus<RubyLokaliseApi::Resources::CustomTranslationStatus>]
|
10
10
|
# @param project_id [String]
|
11
11
|
# @param params [Hash]
|
@@ -15,7 +15,7 @@ module RubyLokaliseApi
|
|
15
15
|
|
16
16
|
# Returns a single translation status for the given project
|
17
17
|
#
|
18
|
-
# @see https://
|
18
|
+
# @see https://developers.lokalise.com/reference/retrieve-a-custom-translation-status
|
19
19
|
# @return [RubyLokaliseApi::Resources::CustomTranslationStatus]
|
20
20
|
# @param project_id [String]
|
21
21
|
# @param status_id [String, Integer]
|
@@ -25,7 +25,7 @@ module RubyLokaliseApi
|
|
25
25
|
|
26
26
|
# Creates translation status inside the given project
|
27
27
|
#
|
28
|
-
# @see https://
|
28
|
+
# @see https://developers.lokalise.com/reference/create-a-custom-translation-status
|
29
29
|
# @return RubyLokaliseApi::Resources::CustomTranslationStatus
|
30
30
|
# @param project_id [String]
|
31
31
|
# @param params Hash
|
@@ -35,7 +35,7 @@ module RubyLokaliseApi
|
|
35
35
|
|
36
36
|
# Updates the given translation status inside the given project
|
37
37
|
#
|
38
|
-
# @see https://
|
38
|
+
# @see https://developers.lokalise.com/reference/update-a-custom-translation-status
|
39
39
|
# @return [RubyLokaliseApi::Resources::CustomTranslationStatus]
|
40
40
|
# @param project_id [String]
|
41
41
|
# @param status_id [String, Integer]
|
@@ -46,7 +46,7 @@ module RubyLokaliseApi
|
|
46
46
|
|
47
47
|
# Deletes translation status inside the given project
|
48
48
|
#
|
49
|
-
# @see https://
|
49
|
+
# @see https://developers.lokalise.com/reference/delete-a-custom-translation-status
|
50
50
|
# @return [Hash]
|
51
51
|
# @param project_id [String]
|
52
52
|
# @param status_id [String, Integer]
|
@@ -56,7 +56,7 @@ module RubyLokaliseApi
|
|
56
56
|
|
57
57
|
# Returns an array of available colors that can be assigned to custom translation statuses
|
58
58
|
#
|
59
|
-
# @see https://
|
59
|
+
# @see https://developers.lokalise.com/reference/retrieve-available-colors-for-custom-translation-statuses
|
60
60
|
# @return [Array]
|
61
61
|
# @param project_id [String]
|
62
62
|
def translation_status_colors(project_id)
|
@@ -5,7 +5,7 @@ module RubyLokaliseApi
|
|
5
5
|
module Files
|
6
6
|
# Returns all translation files for the given project
|
7
7
|
#
|
8
|
-
# @see https://
|
8
|
+
# @see https://developers.lokalise.com/reference/list-all-files
|
9
9
|
# @return [RubyLokaliseApi::Collection::File<RubyLokaliseApi::Resources::File>]
|
10
10
|
# @param project_id [String]
|
11
11
|
# @param params [Hash]
|
@@ -15,7 +15,7 @@ module RubyLokaliseApi
|
|
15
15
|
|
16
16
|
# Exports translation files as .zip bundle, uploads them to Amazon S3 and returns a URL to the generated bundle. The URL is valid for a year
|
17
17
|
#
|
18
|
-
# @see https://
|
18
|
+
# @see https://developers.lokalise.com/reference/download-files
|
19
19
|
# @return [Hash]
|
20
20
|
# @param project_id [String]
|
21
21
|
# @param params [Hash]
|
@@ -26,13 +26,24 @@ module RubyLokaliseApi
|
|
26
26
|
# Imports translation file to the given project. File data must base64-encoded.
|
27
27
|
# To encode your data in Base64, use `Base64.strict_encode64()` method.
|
28
28
|
#
|
29
|
-
# @see https://
|
29
|
+
# @see https://developers.lokalise.com/reference/upload-a-file
|
30
30
|
# @return [Hash]
|
31
31
|
# @param project_id [String]
|
32
32
|
# @param params [Hash]
|
33
33
|
def upload_file(project_id, params)
|
34
34
|
c_r RubyLokaliseApi::Resources::File, :upload, [project_id, 'upload'], params
|
35
35
|
end
|
36
|
+
|
37
|
+
# Deletes a file and it's associated keys from the project.
|
38
|
+
# File __unassigned__ cannot be deleted.
|
39
|
+
#
|
40
|
+
# @see https://developers.lokalise.com/reference/delete-a-file
|
41
|
+
# @return [Hash]
|
42
|
+
# @param project_id [String]
|
43
|
+
# @param params [Hash]
|
44
|
+
def destroy_file(project_id, file_id)
|
45
|
+
c_r RubyLokaliseApi::Resources::File, :destroy, [project_id, file_id]
|
46
|
+
end
|
36
47
|
end
|
37
48
|
end
|
38
49
|
end
|
@@ -5,7 +5,7 @@ module RubyLokaliseApi
|
|
5
5
|
module Keys
|
6
6
|
# Returns all translation keys for the given project
|
7
7
|
#
|
8
|
-
# @see https://
|
8
|
+
# @see https://developers.lokalise.com/reference/list-all-keys
|
9
9
|
# @return [RubyLokaliseApi::Collection::Key<RubyLokaliseApi::Resources::Key>]
|
10
10
|
# @param project_id [String]
|
11
11
|
# @param params [Hash]
|
@@ -15,7 +15,7 @@ module RubyLokaliseApi
|
|
15
15
|
|
16
16
|
# Returns a single translation key for the given project
|
17
17
|
#
|
18
|
-
# @see https://
|
18
|
+
# @see https://developers.lokalise.com/reference/retrieve-a-key
|
19
19
|
# @return [RubyLokaliseApi::Resources::Key]
|
20
20
|
# @param project_id [String]
|
21
21
|
# @param key_id [String, Integer]
|
@@ -26,7 +26,7 @@ module RubyLokaliseApi
|
|
26
26
|
|
27
27
|
# Creates one or more translation keys for the given project
|
28
28
|
#
|
29
|
-
# @see https://
|
29
|
+
# @see https://developers.lokalise.com/reference/create-keys
|
30
30
|
# @return [RubyLokaliseApi::Collection::Key<RubyLokaliseApi::Resources::Key>]
|
31
31
|
# @param project_id [String]
|
32
32
|
# @param params [Hash, Array<Hash>]
|
@@ -36,7 +36,7 @@ module RubyLokaliseApi
|
|
36
36
|
|
37
37
|
# Updates translation key for the given project
|
38
38
|
#
|
39
|
-
# @see https://
|
39
|
+
# @see https://developers.lokalise.com/reference/update-a-key
|
40
40
|
# @return [RubyLokaliseApi::Resources::Key]
|
41
41
|
# @param project_id [String]
|
42
42
|
# @param key_id [String, Integer]
|
@@ -47,7 +47,7 @@ module RubyLokaliseApi
|
|
47
47
|
|
48
48
|
# Updates one or multiple translation keys for the given project
|
49
49
|
#
|
50
|
-
# @see https://
|
50
|
+
# @see https://developers.lokalise.com/reference/bulk-update
|
51
51
|
# @return [RubyLokaliseApi::Collection::Key<RubyLokaliseApi::Resources::Key>]
|
52
52
|
# @param project_id [String]
|
53
53
|
# @param params [Hash, Array<Hash>]
|
@@ -57,7 +57,7 @@ module RubyLokaliseApi
|
|
57
57
|
|
58
58
|
# Deletes translation key for the given project
|
59
59
|
#
|
60
|
-
# @see https://
|
60
|
+
# @see https://developers.lokalise.com/reference/delete-a-key
|
61
61
|
# @return [Hash]
|
62
62
|
# @param project_id [String]
|
63
63
|
# @param key_id [String, Integer]
|
@@ -67,7 +67,7 @@ module RubyLokaliseApi
|
|
67
67
|
|
68
68
|
# Deletes one or multiple translation keys for the given project
|
69
69
|
#
|
70
|
-
# @see https://
|
70
|
+
# @see https://developers.lokalise.com/reference/delete-multiple-keys
|
71
71
|
# @return [Hash]
|
72
72
|
# @param project_id [String]
|
73
73
|
# @param key_ids [String, Integer, Array<String>, Array<Integer>]
|
@@ -5,7 +5,7 @@ module RubyLokaliseApi
|
|
5
5
|
module Languages
|
6
6
|
# Returns all languages supported by Lokalise
|
7
7
|
#
|
8
|
-
# @see https://
|
8
|
+
# @see https://developers.lokalise.com/reference/list-system-languages
|
9
9
|
# @return [RubyLokaliseApi::Collection::SystemLanguage<RubyLokaliseApi::Resources::SystemLanguage>]
|
10
10
|
# @param params [Hash]
|
11
11
|
def system_languages(params = {})
|
@@ -14,7 +14,7 @@ module RubyLokaliseApi
|
|
14
14
|
|
15
15
|
# Returns all languages for the given project
|
16
16
|
#
|
17
|
-
# @see https://
|
17
|
+
# @see https://developers.lokalise.com/reference/list-project-languages
|
18
18
|
# @return [RubyLokaliseApi::Collection::ProjectLanguage<RubyLokaliseApi::Resources::ProjectLanguage>]
|
19
19
|
# @param project_id [String, Integer]
|
20
20
|
# @param params [Hash]
|
@@ -24,7 +24,7 @@ module RubyLokaliseApi
|
|
24
24
|
|
25
25
|
# Returns a single language for the given project
|
26
26
|
#
|
27
|
-
# @see https://
|
27
|
+
# @see https://developers.lokalise.com/reference/retrieve-a-language
|
28
28
|
# @return [RubyLokaliseApi::Resources::ProjectLanguage]
|
29
29
|
# @param project_id [String]
|
30
30
|
# @param language_id [String, Integer]
|
@@ -34,7 +34,7 @@ module RubyLokaliseApi
|
|
34
34
|
|
35
35
|
# Creates one or more language for the given project
|
36
36
|
#
|
37
|
-
# @see https://
|
37
|
+
# @see https://developers.lokalise.com/reference/retrieve-a-language
|
38
38
|
# @return [RubyLokaliseApi::Collection::ProjectLanguage<RubyLokaliseApi::Resources::ProjectLanguage>]
|
39
39
|
# @param project_id [String]
|
40
40
|
# @param params [Hash]
|
@@ -44,7 +44,7 @@ module RubyLokaliseApi
|
|
44
44
|
|
45
45
|
# Updates language for the given project
|
46
46
|
#
|
47
|
-
# @see https://
|
47
|
+
# @see https://developers.lokalise.com/reference/update-a-language
|
48
48
|
# @return [RubyLokaliseApi::Resources::ProjectLanguage]
|
49
49
|
# @param project_id [String]
|
50
50
|
# @param language_id [String, Integer]
|
@@ -55,7 +55,7 @@ module RubyLokaliseApi
|
|
55
55
|
|
56
56
|
# Deletes language for the given project
|
57
57
|
#
|
58
|
-
# @see https://
|
58
|
+
# @see https://developers.lokalise.com/reference/delete-a-language
|
59
59
|
# @return [Hash]
|
60
60
|
# @param project_id [String]
|
61
61
|
# @param language_id [String, Integer]
|
@@ -5,7 +5,7 @@ module RubyLokaliseApi
|
|
5
5
|
module PaymentCards
|
6
6
|
# Returns all payment cards available to the user authorized with the API token
|
7
7
|
#
|
8
|
-
# @see https://
|
8
|
+
# @see https://developers.lokalise.com/reference/list-all-cards
|
9
9
|
# @return [RubyLokaliseApi::Collection::PaymentCard<RubyLokaliseApi::Resources::PaymentCard>]
|
10
10
|
# @param params [Hash]
|
11
11
|
def payment_cards(params = {})
|
@@ -14,7 +14,7 @@ module RubyLokaliseApi
|
|
14
14
|
|
15
15
|
# Returns a single payment card
|
16
16
|
#
|
17
|
-
# @see https://
|
17
|
+
# @see https://developers.lokalise.com/reference/retrieve-a-card
|
18
18
|
# @return [RubyLokaliseApi::Resources::PaymentCard]
|
19
19
|
# @param card_id [String, Integer]
|
20
20
|
def payment_card(card_id)
|
@@ -32,7 +32,7 @@ module RubyLokaliseApi
|
|
32
32
|
|
33
33
|
# Deletes the payment card
|
34
34
|
#
|
35
|
-
# @see https://
|
35
|
+
# @see https://developers.lokalise.com/reference/delete-a-card
|
36
36
|
# @return [Hash]
|
37
37
|
# @param card_id [String, Integer]
|
38
38
|
def destroy_payment_card(card_id)
|
@@ -5,7 +5,7 @@ module RubyLokaliseApi
|
|
5
5
|
module Projects
|
6
6
|
# Returns all projects available to the user authorized with the API token
|
7
7
|
#
|
8
|
-
# @see https://
|
8
|
+
# @see https://developers.lokalise.com/reference/list-all-projects
|
9
9
|
# @return [RubyLokaliseApi::Collection::Project<RubyLokaliseApi::Resources::Project>]
|
10
10
|
# @param params [Hash]
|
11
11
|
def projects(params = {})
|
@@ -14,7 +14,7 @@ module RubyLokaliseApi
|
|
14
14
|
|
15
15
|
# Returns a single project
|
16
16
|
#
|
17
|
-
# @see https://
|
17
|
+
# @see https://developers.lokalise.com/reference/retrieve-a-project
|
18
18
|
# @return [RubyLokaliseApi::Resources::Project]
|
19
19
|
# @param project_id [String, Integer]
|
20
20
|
def project(project_id)
|
@@ -23,7 +23,7 @@ module RubyLokaliseApi
|
|
23
23
|
|
24
24
|
# Creates project
|
25
25
|
#
|
26
|
-
# @see https://
|
26
|
+
# @see https://developers.lokalise.com/reference/create-a-project
|
27
27
|
# @return [RubyLokaliseApi::Resources::Project]
|
28
28
|
# @param params [Hash]
|
29
29
|
def create_project(params)
|
@@ -32,7 +32,7 @@ module RubyLokaliseApi
|
|
32
32
|
|
33
33
|
# Updates project
|
34
34
|
#
|
35
|
-
# @see https://
|
35
|
+
# @see https://developers.lokalise.com/reference/update-a-project
|
36
36
|
# @return [RubyLokaliseApi::Resources::Project]
|
37
37
|
# @param project_id [String, Integer]
|
38
38
|
# @param params [Hash]
|
@@ -42,7 +42,7 @@ module RubyLokaliseApi
|
|
42
42
|
|
43
43
|
# Deletes all keys and translations from the project
|
44
44
|
#
|
45
|
-
# @see https://
|
45
|
+
# @see https://developers.lokalise.com/reference/empty-a-project
|
46
46
|
# @return [Hash]
|
47
47
|
# @param project_id [String, Integer]
|
48
48
|
def empty_project(project_id)
|
@@ -51,7 +51,7 @@ module RubyLokaliseApi
|
|
51
51
|
|
52
52
|
# Deletes the project
|
53
53
|
#
|
54
|
-
# @see https://
|
54
|
+
# @see https://developers.lokalise.com/reference/delete-a-project
|
55
55
|
# @return [Hash]
|
56
56
|
# @param project_id [String, Integer]
|
57
57
|
def destroy_project(project_id)
|
@@ -5,7 +5,7 @@ module RubyLokaliseApi
|
|
5
5
|
module QueuedProcesses
|
6
6
|
# Returns all queued processes for the given project
|
7
7
|
#
|
8
|
-
# @see https://
|
8
|
+
# @see https://developers.lokalise.com/reference/list-all-processes
|
9
9
|
# @return [RubyLokaliseApi::Collection::QueuedProcess<RubyLokaliseApi::Resources::QueuedProcess>]
|
10
10
|
# @param project_id [String]
|
11
11
|
# @param params [Hash]
|
@@ -15,7 +15,7 @@ module RubyLokaliseApi
|
|
15
15
|
|
16
16
|
# Returns a queued process for the given project
|
17
17
|
#
|
18
|
-
# @see https://
|
18
|
+
# @see https://developers.lokalise.com/reference/retrieve-a-process
|
19
19
|
# @return [RubyLokaliseApi::Resources::QueuedProcess]
|
20
20
|
# @param project_id [String]
|
21
21
|
# @param process_id [String]
|
@@ -5,7 +5,7 @@ module RubyLokaliseApi
|
|
5
5
|
module Screenshots
|
6
6
|
# Returns all screenshots for the given project
|
7
7
|
#
|
8
|
-
# @see https://
|
8
|
+
# @see https://developers.lokalise.com/reference/list-all-screenshots
|
9
9
|
# @return [RubyLokaliseApi::Collection::Screenshot<RubyLokaliseApi::Resources::Screenshot>]
|
10
10
|
# @param project_id [String]
|
11
11
|
# @param params [Hash]
|
@@ -15,7 +15,7 @@ module RubyLokaliseApi
|
|
15
15
|
|
16
16
|
# Returns a single screenshot for the given project
|
17
17
|
#
|
18
|
-
# @see https://
|
18
|
+
# @see https://developers.lokalise.com/reference/retrieve-a-screenshot
|
19
19
|
# @return [RubyLokaliseApi::Resources::Screenshot]
|
20
20
|
# @param project_id [String]
|
21
21
|
# @param screenshot_id [String, Integer]
|
@@ -25,7 +25,7 @@ module RubyLokaliseApi
|
|
25
25
|
|
26
26
|
# Creates one or more screenshots for the given project
|
27
27
|
#
|
28
|
-
# @see https://
|
28
|
+
# @see https://developers.lokalise.com/reference/create-screenshots
|
29
29
|
# @return [RubyLokaliseApi::Collection::Screenshot<RubyLokaliseApi::Resources::Screenshot>]
|
30
30
|
# @param project_id [String]
|
31
31
|
# @param params [Hash]
|
@@ -35,7 +35,7 @@ module RubyLokaliseApi
|
|
35
35
|
|
36
36
|
# Updates screenshot
|
37
37
|
#
|
38
|
-
# @see https://
|
38
|
+
# @see https://developers.lokalise.com/reference/update-a-screenshot
|
39
39
|
# @return [RubyLokaliseApi::Resources::Screenshot]
|
40
40
|
# @param project_id [String]
|
41
41
|
# @param screenshot_id [String, Integer]
|
@@ -46,7 +46,7 @@ module RubyLokaliseApi
|
|
46
46
|
|
47
47
|
# Deletes screenshot
|
48
48
|
#
|
49
|
-
# @see https://
|
49
|
+
# @see https://developers.lokalise.com/reference/delete-a-screenshot
|
50
50
|
# @return [Hash]
|
51
51
|
# @param project_id [String]
|
52
52
|
# @param screenshot_id [String, Integer]
|
@@ -5,7 +5,7 @@ module RubyLokaliseApi
|
|
5
5
|
module Segments
|
6
6
|
# Returns all segments for the given key and language ISO code
|
7
7
|
#
|
8
|
-
# @see https://
|
8
|
+
# @see https://developers.lokalise.com/reference/list-all-segments-for-key-language
|
9
9
|
# @return [RubyLokaliseApi::Collection::Segments<RubyLokaliseApi::Resources::Segment>]
|
10
10
|
# @param project_id [String]
|
11
11
|
# @param key_id [String, Integer]
|
@@ -17,7 +17,7 @@ module RubyLokaliseApi
|
|
17
17
|
|
18
18
|
# Returns a segment under a given number for the given key and language ISO code
|
19
19
|
#
|
20
|
-
# @see https://
|
20
|
+
# @see https://developers.lokalise.com/reference/retrieve-a-segment-for-key-language
|
21
21
|
# @return [RubyLokaliseApi::Resources::Segment]
|
22
22
|
# @param project_id [String]
|
23
23
|
# @param key_id [String, Integer]
|
@@ -30,7 +30,7 @@ module RubyLokaliseApi
|
|
30
30
|
|
31
31
|
# Updates a segment under a given number for the given key and language ISO code
|
32
32
|
#
|
33
|
-
# @see https://
|
33
|
+
# @see https://developers.lokalise.com/reference/update-a-segment
|
34
34
|
# @return [RubyLokaliseApi::Resources::Segment]
|
35
35
|
# @param project_id [String]
|
36
36
|
# @param key_id [String, Integer]
|
@@ -5,7 +5,7 @@ module RubyLokaliseApi
|
|
5
5
|
module Snapshots
|
6
6
|
# Returns all snapshots for the given project
|
7
7
|
#
|
8
|
-
# @see https://
|
8
|
+
# @see https://developers.lokalise.com/reference/list-all-snapshots
|
9
9
|
# @return [RubyLokaliseApi::Collection::Snapshot<RubyLokaliseApi::Resources::Snapshot>]
|
10
10
|
# @param project_id [String]
|
11
11
|
# @param params [Hash]
|
@@ -15,7 +15,7 @@ module RubyLokaliseApi
|
|
15
15
|
|
16
16
|
# Creates snapshot for the given project
|
17
17
|
#
|
18
|
-
# @see https://
|
18
|
+
# @see https://developers.lokalise.com/reference/create-a-snapshot
|
19
19
|
# @return [RubyLokaliseApi::Resources::Snapshot]
|
20
20
|
# @param project_id [String]
|
21
21
|
# @param params [Hash]
|
@@ -25,7 +25,7 @@ module RubyLokaliseApi
|
|
25
25
|
|
26
26
|
# Restore project from the given snapshot by producing project's copy
|
27
27
|
#
|
28
|
-
# @see https://
|
28
|
+
# @see https://developers.lokalise.com/reference/restore-a-snapshot
|
29
29
|
# @return [RubyLokaliseApi::Resources::Project]
|
30
30
|
# @param project_id [String]
|
31
31
|
# @param snapshot_id [String, Integer]
|
@@ -35,7 +35,7 @@ module RubyLokaliseApi
|
|
35
35
|
|
36
36
|
# Deletes snapshot
|
37
37
|
#
|
38
|
-
# @see https://
|
38
|
+
# @see https://developers.lokalise.com/reference/delete-a-snapshot
|
39
39
|
# @return [Hash]
|
40
40
|
# @param project_id [String]
|
41
41
|
# @param snapshot_id [String, Integer]
|
@@ -5,7 +5,7 @@ module RubyLokaliseApi
|
|
5
5
|
module Tasks
|
6
6
|
# Returns all tasks for the given project
|
7
7
|
#
|
8
|
-
# @see https://
|
8
|
+
# @see https://developers.lokalise.com/reference/list-all-tasks
|
9
9
|
# @return [RubyLokaliseApi::Collection::Task<RubyLokaliseApi::Resources::Task>]
|
10
10
|
# @param project_id [String]
|
11
11
|
# @param params [Hash]
|
@@ -15,7 +15,7 @@ module RubyLokaliseApi
|
|
15
15
|
|
16
16
|
# Returns a single task for the given project
|
17
17
|
#
|
18
|
-
# @see https://
|
18
|
+
# @see https://developers.lokalise.com/reference/retrieve-a-task
|
19
19
|
# @return [RubyLokaliseApi::Resources::Task]
|
20
20
|
# @param project_id [String]
|
21
21
|
# @param task_id [String, Integer]
|
@@ -25,7 +25,7 @@ module RubyLokaliseApi
|
|
25
25
|
|
26
26
|
# Creates task for the given project
|
27
27
|
#
|
28
|
-
# @see https://
|
28
|
+
# @see https://developers.lokalise.com/reference/create-a-task
|
29
29
|
# @return [RubyLokaliseApi::Resources::Task]
|
30
30
|
# @param project_id [String]
|
31
31
|
# @param params [Hash]
|
@@ -35,7 +35,7 @@ module RubyLokaliseApi
|
|
35
35
|
|
36
36
|
# Updates task for the given project
|
37
37
|
#
|
38
|
-
# @see https://
|
38
|
+
# @see https://developers.lokalise.com/reference/update-a-task
|
39
39
|
# @return [RubyLokaliseApi::Resources::Task]
|
40
40
|
# @param project_id [String]
|
41
41
|
# @param task_id [String, Integer]
|
@@ -46,7 +46,7 @@ module RubyLokaliseApi
|
|
46
46
|
|
47
47
|
# Deletes task for the given project
|
48
48
|
#
|
49
|
-
# @see https://
|
49
|
+
# @see https://developers.lokalise.com/reference/delete-a-task
|
50
50
|
# @return [Hash]
|
51
51
|
# @param project_id [String]
|
52
52
|
# @param task_id [String, Integer]
|
@@ -5,7 +5,7 @@ module RubyLokaliseApi
|
|
5
5
|
module TeamUserBillingDetails
|
6
6
|
# Returns team user billing details
|
7
7
|
#
|
8
|
-
# @see https://
|
8
|
+
# @see https://developers.lokalise.com/reference/retrieve-team-user-billing-details
|
9
9
|
# @return [RubyLokaliseApi::Resources::TeamUserBillingDetails]
|
10
10
|
# @param team_id [String]
|
11
11
|
def team_user_billing_details(team_id)
|
@@ -14,7 +14,7 @@ module RubyLokaliseApi
|
|
14
14
|
|
15
15
|
# Creates team user billing details
|
16
16
|
#
|
17
|
-
# @see https://
|
17
|
+
# @see https://developers.lokalise.com/reference/create-team-user-billing-details
|
18
18
|
# @return [RubyLokaliseApi::Resources::TeamUserBillingDetails]
|
19
19
|
# @param team_id [String]
|
20
20
|
# @param params [Hash]
|
@@ -24,7 +24,7 @@ module RubyLokaliseApi
|
|
24
24
|
|
25
25
|
# Updates team user billing details
|
26
26
|
#
|
27
|
-
# @see https://
|
27
|
+
# @see https://developers.lokalise.com/reference/create-team-user-billing-details
|
28
28
|
# @return [RubyLokaliseApi::Resources::TeamUserBillingDetails]
|
29
29
|
# @param team_id [String]
|
30
30
|
# @param params [Hash]
|
@@ -5,7 +5,7 @@ module RubyLokaliseApi
|
|
5
5
|
module TeamUsers
|
6
6
|
# Returns all team users for the given team
|
7
7
|
#
|
8
|
-
# @see https://
|
8
|
+
# @see https://developers.lokalise.com/reference/list-all-team-users
|
9
9
|
# @return [RubyLokaliseApi::Collection::TeamUser<RubyLokaliseApi::Resources::TeamUser>]
|
10
10
|
# @param team_id [String]
|
11
11
|
# @param params [Hash]
|
@@ -15,7 +15,7 @@ module RubyLokaliseApi
|
|
15
15
|
|
16
16
|
# Returns team user from the given team
|
17
17
|
#
|
18
|
-
# @see https://
|
18
|
+
# @see https://developers.lokalise.com/reference/retrieve-a-team-user
|
19
19
|
# @return [RubyLokaliseApi::Resources::TeamUser]
|
20
20
|
# @param team_id [String]
|
21
21
|
# @param user_id [String, Integer]
|
@@ -25,7 +25,7 @@ module RubyLokaliseApi
|
|
25
25
|
|
26
26
|
# Updates team user for the given team
|
27
27
|
#
|
28
|
-
# @see https://
|
28
|
+
# @see https://developers.lokalise.com/reference/update-a-team-user
|
29
29
|
# @return [RubyLokaliseApi::Resources::TeamUser]
|
30
30
|
# @param team_id [String]
|
31
31
|
# @param user_id [String, Integer]
|
@@ -36,7 +36,7 @@ module RubyLokaliseApi
|
|
36
36
|
|
37
37
|
# Deletes team user from the given team
|
38
38
|
#
|
39
|
-
# @see https://
|
39
|
+
# @see https://developers.lokalise.com/reference/delete-a-team-user
|
40
40
|
# @return [RubyLokaliseApi::Resources::TeamUser]
|
41
41
|
# @param team_id [String]
|
42
42
|
# @param user_id [String, Integer]
|
@@ -5,7 +5,7 @@ module RubyLokaliseApi
|
|
5
5
|
module Teams
|
6
6
|
# Returns all teams available to the user
|
7
7
|
#
|
8
|
-
# @see https://
|
8
|
+
# @see https://developers.lokalise.com/reference/list-all-teams
|
9
9
|
# @return [RubyLokaliseApi::Collection::Team<RubyLokaliseApi::Resources::Team>]
|
10
10
|
# @param params [Hash]
|
11
11
|
def teams(params = {})
|