class PhraseApp::Client
Usage example:
Require the gem
require 'phraseapp-ruby'
Setup Credentials for Authentication
credentials = PhraseApp::Auth::Credentials.new(token: "YOUR_ACCESS_TOKEN")
Create a client
client = PhraseApp::Client.new(credentials)
List Projects
rsp, err = client.projects_list(1, 10) puts rsp
Create a new key
params = PhraseApp::RequestParams::TranslationKeyParams.new(:name => "foo") rsp, err = client.key_create('YOUR_PROJECT_ID', params) puts rsp
Public Class Methods
# File lib/phraseapp-ruby.rb, line 3479 def initialize(credentials) @credentials = credentials end
Public Instance Methods
Get details on a single account. API Path: /api/v2/accounts/:id
Parameters:¶ ↑
- id
-
id
Returns:¶ ↑
PhraseApp::ResponseObjects::AccountDetails err
# File lib/phraseapp-ruby.rb, line 3493 def account_show(id) path = sprintf("/api/v2/accounts/%s", id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::AccountDetails.new(JSON.load(rc.body)), err end
List all accounts the current user has access to. API Path: /api/v2/accounts
Parameters:¶ ↑
Returns:¶ ↑
PhraseApp::ResponseObjects::Account err
# File lib/phraseapp-ruby.rb, line 3514 def accounts_list(page, per_page) path = sprintf("/api/v2/accounts") data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Account.new(item) }, err end
Export translations from PhraseApp
to Bitbucket according to the .phraseapp.yml file within the Bitbucket Repository. API Path: /api/v2/bitbucket_syncs/:id/export
Parameters:¶ ↑
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::BitbucketSyncParams
Returns:¶ ↑
PhraseApp::ResponseObjects::BitbucketSyncExportResponse err
# File lib/phraseapp-ruby.rb, line 3675 def bitbucket_sync_export(id, params) path = sprintf("/api/v2/bitbucket_syncs/%s/export", id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::BitbucketSyncParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::BitbucketSyncParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::BitbucketSyncExportResponse.new(JSON.load(rc.body)), err end
Import translations from Bitbucket to PhraseApp
according to the .phraseapp.yml file within the Bitbucket repository. API Path: /api/v2/bitbucket_syncs/:id/import
Parameters:¶ ↑
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::BitbucketSyncParams
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 3710 def bitbucket_sync_import(id, params) path = sprintf("/api/v2/bitbucket_syncs/%s/import", id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::BitbucketSyncParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::BitbucketSyncParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return err end
List all Bitbucket repositories for which synchronisation with PhraseApp
is activated. API Path: /api/v2/bitbucket_syncs
Parameters:¶ ↑
- params
-
Parameters of type
PhraseApp::RequestParams::BitbucketSyncParams
Returns:¶ ↑
PhraseApp::ResponseObjects::BitbucketSync err
# File lib/phraseapp-ruby.rb, line 3744 def bitbucket_syncs_list(page, per_page, params) path = sprintf("/api/v2/bitbucket_syncs") data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::BitbucketSyncParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::BitbucketSyncParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::BitbucketSync.new(item) }, err end
Create a new rule for blacklisting keys. API Path: /api/v2/projects/:project_id/blacklisted_keys
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::BlacklistedKeyParams
Returns:¶ ↑
PhraseApp::ResponseObjects::BlacklistedKey err
# File lib/phraseapp-ruby.rb, line 3780 def blacklisted_key_create(project_id, params) path = sprintf("/api/v2/projects/%s/blacklisted_keys", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::BlacklistedKeyParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::BlacklistedKeyParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::BlacklistedKey.new(JSON.load(rc.body)), err end
Delete an existing rule for blacklisting keys. API Path: /api/v2/projects/:project_id/blacklisted_keys/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 3815 def blacklisted_key_delete(project_id, id) path = sprintf("/api/v2/projects/%s/blacklisted_keys/%s", project_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Get details on a single rule for blacklisting keys for a given project. API Path: /api/v2/projects/:project_id/blacklisted_keys/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
Returns:¶ ↑
PhraseApp::ResponseObjects::BlacklistedKey err
# File lib/phraseapp-ruby.rb, line 3840 def blacklisted_key_show(project_id, id) path = sprintf("/api/v2/projects/%s/blacklisted_keys/%s", project_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::BlacklistedKey.new(JSON.load(rc.body)), err end
Update an existing rule for blacklisting keys. API Path: /api/v2/projects/:project_id/blacklisted_keys/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::BlacklistedKeyParams
Returns:¶ ↑
PhraseApp::ResponseObjects::BlacklistedKey err
# File lib/phraseapp-ruby.rb, line 3867 def blacklisted_key_update(project_id, id, params) path = sprintf("/api/v2/projects/%s/blacklisted_keys/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::BlacklistedKeyParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::BlacklistedKeyParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::BlacklistedKey.new(JSON.load(rc.body)), err end
List all rules for blacklisting keys for the given project. API Path: /api/v2/projects/:project_id/blacklisted_keys
Parameters:¶ ↑
- project_id
-
project_id
Returns:¶ ↑
PhraseApp::ResponseObjects::BlacklistedKey err
# File lib/phraseapp-ruby.rb, line 3901 def blacklisted_keys_list(project_id, page, per_page) path = sprintf("/api/v2/projects/%s/blacklisted_keys", project_id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::BlacklistedKey.new(item) }, err end
Create a new branch. API Path: /api/v2/projects/:project_id/branches
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::BranchParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Branch err
# File lib/phraseapp-ruby.rb, line 3926 def branch_create(project_id, params) path = sprintf("/api/v2/projects/%s/branches", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::BranchParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::BranchParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::Branch.new(JSON.load(rc.body)), err end
Delete an existing branch. API Path: /api/v2/projects/:project_id/branches/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 3961 def branch_delete(project_id, id) path = sprintf("/api/v2/projects/%s/branches/%s", project_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Merge an existing branch. API Path: /api/v2/projects/:project_id/branches/:id/merge
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::BranchMergeParams
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 3987 def branch_merge(project_id, id, params) path = sprintf("/api/v2/projects/%s/branches/%s/merge", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::BranchMergeParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::BranchMergeParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return err end
Get details on a single branch for a given project. API Path: /api/v2/projects/:project_id/branches/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
Returns:¶ ↑
PhraseApp::ResponseObjects::Branch err
# File lib/phraseapp-ruby.rb, line 4023 def branch_show(project_id, id) path = sprintf("/api/v2/projects/%s/branches/%s", project_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Branch.new(JSON.load(rc.body)), err end
Update an existing branch. API Path: /api/v2/projects/:project_id/branches/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::BranchParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Branch err
# File lib/phraseapp-ruby.rb, line 4050 def branch_update(project_id, id, params) path = sprintf("/api/v2/projects/%s/branches/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::BranchParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::BranchParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Branch.new(JSON.load(rc.body)), err end
List all branches the of the current project. API Path: /api/v2/projects/:project_id/branches
Parameters:¶ ↑
- project_id
-
project_id
Returns:¶ ↑
PhraseApp::ResponseObjects::Branch err
# File lib/phraseapp-ruby.rb, line 4084 def branches_list(project_id, page, per_page) path = sprintf("/api/v2/projects/%s/branches", project_id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Branch.new(item) }, err end
Create a new comment for a key. API Path: /api/v2/projects/:project_id/keys/:key_id/comments
Parameters:¶ ↑
- project_id
-
project_id
- key_id
-
key_id
- params
-
Parameters of type
PhraseApp::RequestParams::CommentParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Comment err
# File lib/phraseapp-ruby.rb, line 4111 def comment_create(project_id, key_id, params) path = sprintf("/api/v2/projects/%s/keys/%s/comments", project_id, key_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::CommentParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::CommentParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::Comment.new(JSON.load(rc.body)), err end
Delete an existing comment. API Path: /api/v2/projects/:project_id/keys/:key_id/comments/:id
Parameters:¶ ↑
- project_id
-
project_id
- key_id
-
key_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::CommentDeleteParams
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 4150 def comment_delete(project_id, key_id, id, params) path = sprintf("/api/v2/projects/%s/keys/%s/comments/%s", project_id, key_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::CommentDeleteParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::CommentDeleteParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Check if comment was marked as read. Returns 204 if read, 404 if unread. API Path: /api/v2/projects/:project_id/keys/:key_id/comments/:id/read
Parameters:¶ ↑
- project_id
-
project_id
- key_id
-
key_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::CommentMarkCheckParams
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 4189 def comment_mark_check(project_id, key_id, id, params) path = sprintf("/api/v2/projects/%s/keys/%s/comments/%s/read", project_id, key_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::CommentMarkCheckParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::CommentMarkCheckParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Mark a comment as read. API Path: /api/v2/projects/:project_id/keys/:key_id/comments/:id/read
Parameters:¶ ↑
- project_id
-
project_id
- key_id
-
key_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::CommentMarkReadParams
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 4228 def comment_mark_read(project_id, key_id, id, params) path = sprintf("/api/v2/projects/%s/keys/%s/comments/%s/read", project_id, key_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::CommentMarkReadParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::CommentMarkReadParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Mark a comment as unread. API Path: /api/v2/projects/:project_id/keys/:key_id/comments/:id/read
Parameters:¶ ↑
- project_id
-
project_id
- key_id
-
key_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::CommentMarkUnreadParams
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 4267 def comment_mark_unread(project_id, key_id, id, params) path = sprintf("/api/v2/projects/%s/keys/%s/comments/%s/read", project_id, key_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::CommentMarkUnreadParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::CommentMarkUnreadParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Get details on a single comment. API Path: /api/v2/projects/:project_id/keys/:key_id/comments/:id
Parameters:¶ ↑
- project_id
-
project_id
- key_id
-
key_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::CommentShowParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Comment err
# File lib/phraseapp-ruby.rb, line 4307 def comment_show(project_id, key_id, id, params) path = sprintf("/api/v2/projects/%s/keys/%s/comments/%s", project_id, key_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::CommentShowParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::CommentShowParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Comment.new(JSON.load(rc.body)), err end
Update an existing comment. API Path: /api/v2/projects/:project_id/keys/:key_id/comments/:id
Parameters:¶ ↑
- project_id
-
project_id
- key_id
-
key_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::CommentParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Comment err
# File lib/phraseapp-ruby.rb, line 4347 def comment_update(project_id, key_id, id, params) path = sprintf("/api/v2/projects/%s/keys/%s/comments/%s", project_id, key_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::CommentParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::CommentParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Comment.new(JSON.load(rc.body)), err end
List all comments for a key. API Path: /api/v2/projects/:project_id/keys/:key_id/comments
Parameters:¶ ↑
- project_id
-
project_id
- key_id
-
key_id
- params
-
Parameters of type
PhraseApp::RequestParams::CommentsListParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Comment err
# File lib/phraseapp-ruby.rb, line 4385 def comments_list(project_id, key_id, page, per_page, params) path = sprintf("/api/v2/projects/%s/keys/%s/comments", project_id, key_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::CommentsListParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::CommentsListParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Comment.new(item) }, err end
Create a new distribution. API Path: /api/v2/accounts/:account_id/distributions
Parameters:¶ ↑
- account_id
-
account_id
- params
-
Parameters of type
PhraseApp::RequestParams::DistributionsParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Distribution err
# File lib/phraseapp-ruby.rb, line 4421 def distribution_create(account_id, params) path = sprintf("/api/v2/accounts/%s/distributions", account_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::DistributionsParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::DistributionsParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::Distribution.new(JSON.load(rc.body)), err end
Delete an existing distribution. API Path: /api/v2/accounts/:account_id/distributions/:id
Parameters:¶ ↑
- account_id
-
account_id
- id
-
id
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 4456 def distribution_delete(account_id, id) path = sprintf("/api/v2/accounts/%s/distributions/%s", account_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Get details on a single distribution. API Path: /api/v2/accounts/:account_id/distributions/:id
Parameters:¶ ↑
- account_id
-
account_id
- id
-
id
Returns:¶ ↑
PhraseApp::ResponseObjects::Distribution err
# File lib/phraseapp-ruby.rb, line 4481 def distribution_show(account_id, id) path = sprintf("/api/v2/accounts/%s/distributions/%s", account_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Distribution.new(JSON.load(rc.body)), err end
Update an existing distribution. API Path: /api/v2/accounts/:account_id/distributions/:id
Parameters:¶ ↑
- account_id
-
account_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::DistributionsParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Distribution err
# File lib/phraseapp-ruby.rb, line 4508 def distribution_update(account_id, id, params) path = sprintf("/api/v2/accounts/%s/distributions/%s", account_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::DistributionsParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::DistributionsParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Distribution.new(JSON.load(rc.body)), err end
List all distributions for the given account. API Path: /api/v2/accounts/:account_id/distributions
Parameters:¶ ↑
- account_id
-
account_id
Returns:¶ ↑
PhraseApp::ResponseObjects::DistributionPreview err
# File lib/phraseapp-ruby.rb, line 4542 def distributions_list(account_id, page, per_page) path = sprintf("/api/v2/accounts/%s/distributions", account_id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::DistributionPreview.new(item) }, err end
Get a handy list of all localization file formats supported in PhraseApp
. API Path: /api/v2/formats
Parameters:¶ ↑
Returns:¶ ↑
PhraseApp::ResponseObjects::Format err
# File lib/phraseapp-ruby.rb, line 4563 def formats_list(page, per_page) path = sprintf("/api/v2/formats") data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Format.new(item) }, err end
List all glossaries the current user has access to. API Path: /api/v2/accounts/:account_id/glossaries
Parameters:¶ ↑
- account_id
-
account_id
Returns:¶ ↑
PhraseApp::ResponseObjects::Glossary err
# File lib/phraseapp-ruby.rb, line 4586 def glossaries_list(account_id, page, per_page) path = sprintf("/api/v2/accounts/%s/glossaries", account_id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Glossary.new(item) }, err end
Create a new glossary. API Path: /api/v2/accounts/:account_id/glossaries
Parameters:¶ ↑
- account_id
-
account_id
- params
-
Parameters of type
PhraseApp::RequestParams::GlossaryParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Glossary err
# File lib/phraseapp-ruby.rb, line 4611 def glossary_create(account_id, params) path = sprintf("/api/v2/accounts/%s/glossaries", account_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::GlossaryParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::GlossaryParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::Glossary.new(JSON.load(rc.body)), err end
Delete an existing glossary. API Path: /api/v2/accounts/:account_id/glossaries/:id
Parameters:¶ ↑
- account_id
-
account_id
- id
-
id
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 4646 def glossary_delete(account_id, id) path = sprintf("/api/v2/accounts/%s/glossaries/%s", account_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Get details on a single glossary. API Path: /api/v2/accounts/:account_id/glossaries/:id
Parameters:¶ ↑
- account_id
-
account_id
- id
-
id
Returns:¶ ↑
PhraseApp::ResponseObjects::Glossary err
# File lib/phraseapp-ruby.rb, line 4671 def glossary_show(account_id, id) path = sprintf("/api/v2/accounts/%s/glossaries/%s", account_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Glossary.new(JSON.load(rc.body)), err end
Create a new glossary term. API Path: /api/v2/accounts/:account_id/glossaries/:glossary_id/terms
Parameters:¶ ↑
- account_id
-
account_id
- glossary_id
-
glossary_id
- params
-
Parameters of type
PhraseApp::RequestParams::GlossaryTermParams
Returns:¶ ↑
PhraseApp::ResponseObjects::GlossaryTerm err
# File lib/phraseapp-ruby.rb, line 4736 def glossary_term_create(account_id, glossary_id, params) path = sprintf("/api/v2/accounts/%s/glossaries/%s/terms", account_id, glossary_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::GlossaryTermParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::GlossaryTermParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::GlossaryTerm.new(JSON.load(rc.body)), err end
Delete an existing glossary term. API Path: /api/v2/accounts/:account_id/glossaries/:glossary_id/terms/:id
Parameters:¶ ↑
- account_id
-
account_id
- glossary_id
-
glossary_id
- id
-
id
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 4773 def glossary_term_delete(account_id, glossary_id, id) path = sprintf("/api/v2/accounts/%s/glossaries/%s/terms/%s", account_id, glossary_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Get details on a single glossary term. API Path: /api/v2/accounts/:account_id/glossaries/:glossary_id/terms/:id
Parameters:¶ ↑
- account_id
-
account_id
- glossary_id
-
glossary_id
- id
-
id
Returns:¶ ↑
PhraseApp::ResponseObjects::GlossaryTerm err
# File lib/phraseapp-ruby.rb, line 4800 def glossary_term_show(account_id, glossary_id, id) path = sprintf("/api/v2/accounts/%s/glossaries/%s/terms/%s", account_id, glossary_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::GlossaryTerm.new(JSON.load(rc.body)), err end
Create a new glossary term translation. API Path: /api/v2/accounts/:account_id/glossaries/:glossary_id/terms/:term_id/translations
Parameters:¶ ↑
- account_id
-
account_id
- glossary_id
-
glossary_id
- term_id
-
term_id
- params
-
Parameters of type
PhraseApp::RequestParams::GlossaryTermTranslationParams
Returns:¶ ↑
PhraseApp::ResponseObjects::GlossaryTermTranslation err
# File lib/phraseapp-ruby.rb, line 4869 def glossary_term_translation_create(account_id, glossary_id, term_id, params) path = sprintf("/api/v2/accounts/%s/glossaries/%s/terms/%s/translations", account_id, glossary_id, term_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::GlossaryTermTranslationParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::GlossaryTermTranslationParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::GlossaryTermTranslation.new(JSON.load(rc.body)), err end
Delete an existing glossary term translation. API Path: /api/v2/accounts/:account_id/glossaries/:glossary_id/terms/:term_id/translations/:id
Parameters:¶ ↑
- account_id
-
account_id
- glossary_id
-
glossary_id
- term_id
-
term_id
- id
-
id
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 4908 def glossary_term_translation_delete(account_id, glossary_id, term_id, id) path = sprintf("/api/v2/accounts/%s/glossaries/%s/terms/%s/translations/%s", account_id, glossary_id, term_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Update an existing glossary term translation. API Path: /api/v2/accounts/:account_id/glossaries/:glossary_id/terms/:term_id/translations/:id
Parameters:¶ ↑
- account_id
-
account_id
- glossary_id
-
glossary_id
- term_id
-
term_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::GlossaryTermTranslationParams
Returns:¶ ↑
PhraseApp::ResponseObjects::GlossaryTermTranslation err
# File lib/phraseapp-ruby.rb, line 4939 def glossary_term_translation_update(account_id, glossary_id, term_id, id, params) path = sprintf("/api/v2/accounts/%s/glossaries/%s/terms/%s/translations/%s", account_id, glossary_id, term_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::GlossaryTermTranslationParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::GlossaryTermTranslationParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::GlossaryTermTranslation.new(JSON.load(rc.body)), err end
Update an existing glossary term. API Path: /api/v2/accounts/:account_id/glossaries/:glossary_id/terms/:id
Parameters:¶ ↑
- account_id
-
account_id
- glossary_id
-
glossary_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::GlossaryTermParams
Returns:¶ ↑
PhraseApp::ResponseObjects::GlossaryTerm err
# File lib/phraseapp-ruby.rb, line 4829 def glossary_term_update(account_id, glossary_id, id, params) path = sprintf("/api/v2/accounts/%s/glossaries/%s/terms/%s", account_id, glossary_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::GlossaryTermParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::GlossaryTermParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::GlossaryTerm.new(JSON.load(rc.body)), err end
List all glossary terms the current user has access to. API Path: /api/v2/accounts/:account_id/glossaries/:glossary_id/terms
Parameters:¶ ↑
- account_id
-
account_id
- glossary_id
-
glossary_id
Returns:¶ ↑
PhraseApp::ResponseObjects::GlossaryTerm err
# File lib/phraseapp-ruby.rb, line 4975 def glossary_terms_list(account_id, glossary_id, page, per_page) path = sprintf("/api/v2/accounts/%s/glossaries/%s/terms", account_id, glossary_id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::GlossaryTerm.new(item) }, err end
Update an existing glossary. API Path: /api/v2/accounts/:account_id/glossaries/:id
Parameters:¶ ↑
- account_id
-
account_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::GlossaryParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Glossary err
# File lib/phraseapp-ruby.rb, line 4698 def glossary_update(account_id, id, params) path = sprintf("/api/v2/accounts/%s/glossaries/%s", account_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::GlossaryParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::GlossaryParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Glossary.new(JSON.load(rc.body)), err end
Invite a person to an account. Developers and translators need project_ids
and locale_ids
assigned to access them. Access token scope must include team.manage
. API Path: /api/v2/accounts/:account_id/invitations
Parameters:¶ ↑
- account_id
-
account_id
- params
-
Parameters of type
PhraseApp::RequestParams::InvitationCreateParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Invitation err
# File lib/phraseapp-ruby.rb, line 5000 def invitation_create(account_id, params) path = sprintf("/api/v2/accounts/%s/invitations", account_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::InvitationCreateParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::InvitationCreateParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::Invitation.new(JSON.load(rc.body)), err end
Delete an existing invitation (must not be accepted yet). Access token scope must include team.manage
. API Path: /api/v2/accounts/:account_id/invitations/:id
Parameters:¶ ↑
- account_id
-
account_id
- id
-
id
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 5035 def invitation_delete(account_id, id) path = sprintf("/api/v2/accounts/%s/invitations/%s", account_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Resend the invitation email (must not be accepted yet). Access token scope must include team.manage
. API Path: /api/v2/accounts/:account_id/invitations/:id/resend
Parameters:¶ ↑
- account_id
-
account_id
- id
-
id
Returns:¶ ↑
PhraseApp::ResponseObjects::Invitation err
# File lib/phraseapp-ruby.rb, line 5060 def invitation_resend(account_id, id) path = sprintf("/api/v2/accounts/%s/invitations/%s/resend", account_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Invitation.new(JSON.load(rc.body)), err end
Get details on a single invitation. Access token scope must include team.manage
. API Path: /api/v2/accounts/:account_id/invitations/:id
Parameters:¶ ↑
- account_id
-
account_id
- id
-
id
Returns:¶ ↑
PhraseApp::ResponseObjects::Invitation err
# File lib/phraseapp-ruby.rb, line 5085 def invitation_show(account_id, id) path = sprintf("/api/v2/accounts/%s/invitations/%s", account_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Invitation.new(JSON.load(rc.body)), err end
Update an existing invitation (must not be accepted yet). The email
cannot be updated. Developers and translators need project_ids
and locale_ids
assigned to access them. Access token scope must include team.manage
. API Path: /api/v2/accounts/:account_id/invitations/:id
Parameters:¶ ↑
- account_id
-
account_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::InvitationUpdateParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Invitation err
# File lib/phraseapp-ruby.rb, line 5112 def invitation_update(account_id, id, params) path = sprintf("/api/v2/accounts/%s/invitations/%s", account_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::InvitationUpdateParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::InvitationUpdateParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Invitation.new(JSON.load(rc.body)), err end
List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include team.manage
. API Path: /api/v2/accounts/:account_id/invitations
Parameters:¶ ↑
- account_id
-
account_id
Returns:¶ ↑
PhraseApp::ResponseObjects::Invitation err
# File lib/phraseapp-ruby.rb, line 5146 def invitations_list(account_id, page, per_page) path = sprintf("/api/v2/accounts/%s/invitations", account_id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Invitation.new(item) }, err end
Mark a job as completed. API Path: /api/v2/projects/:project_id/jobs/:id/complete
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::JobCompleteParams
Returns:¶ ↑
PhraseApp::ResponseObjects::JobDetails err
# File lib/phraseapp-ruby.rb, line 5173 def job_complete(project_id, id, params) path = sprintf("/api/v2/projects/%s/jobs/%s/complete", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::JobCompleteParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::JobCompleteParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::JobDetails.new(JSON.load(rc.body)), err end
Create a new job. API Path: /api/v2/projects/:project_id/jobs
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::JobParams
Returns:¶ ↑
PhraseApp::ResponseObjects::JobDetails err
# File lib/phraseapp-ruby.rb, line 5209 def job_create(project_id, params) path = sprintf("/api/v2/projects/%s/jobs", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::JobParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::JobParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::JobDetails.new(JSON.load(rc.body)), err end
Delete an existing job. API Path: /api/v2/projects/:project_id/jobs/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::JobDeleteParams
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 5246 def job_delete(project_id, id, params) path = sprintf("/api/v2/projects/%s/jobs/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::JobDeleteParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::JobDeleteParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Add multiple keys to a existing job. API Path: /api/v2/projects/:project_id/jobs/:id/keys
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::JobKeysCreateParams
Returns:¶ ↑
PhraseApp::ResponseObjects::JobDetails err
# File lib/phraseapp-ruby.rb, line 5284 def job_keys_create(project_id, id, params) path = sprintf("/api/v2/projects/%s/jobs/%s/keys", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::JobKeysCreateParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::JobKeysCreateParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::JobDetails.new(JSON.load(rc.body)), err end
Remove multiple keys from existing job. API Path: /api/v2/projects/:project_id/jobs/:id/keys
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::JobKeysDeleteParams
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 5321 def job_keys_delete(project_id, id, params) path = sprintf("/api/v2/projects/%s/jobs/%s/keys", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::JobKeysDeleteParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::JobKeysDeleteParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Mark a job locale as completed. API Path: /api/v2/projects/:project_id/jobs/:job_id/locales/:id/complete
Parameters:¶ ↑
- project_id
-
project_id
- job_id
-
job_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::JobLocaleCompleteParams
Returns:¶ ↑
PhraseApp::ResponseObjects::JobLocale err
# File lib/phraseapp-ruby.rb, line 5513 def job_locale_complete(project_id, job_id, id, params) path = sprintf("/api/v2/projects/%s/jobs/%s/locales/%s/complete", project_id, job_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::JobLocaleCompleteParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::JobLocaleCompleteParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::JobLocale.new(JSON.load(rc.body)), err end
Delete an existing job locale. API Path: /api/v2/projects/:project_id/jobs/:job_id/locales/:id
Parameters:¶ ↑
- project_id
-
project_id
- job_id
-
job_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::JobLocaleDeleteParams
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 5552 def job_locale_delete(project_id, job_id, id, params) path = sprintf("/api/v2/projects/%s/jobs/%s/locales/%s", project_id, job_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::JobLocaleDeleteParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::JobLocaleDeleteParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Mark a job locale as uncompleted. API Path: /api/v2/projects/:project_id/jobs/:job_id/locales/:id/reopen
Parameters:¶ ↑
- project_id
-
project_id
- job_id
-
job_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::JobLocaleReopenParams
Returns:¶ ↑
PhraseApp::ResponseObjects::JobLocale err
# File lib/phraseapp-ruby.rb, line 5592 def job_locale_reopen(project_id, job_id, id, params) path = sprintf("/api/v2/projects/%s/jobs/%s/locales/%s/reopen", project_id, job_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::JobLocaleReopenParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::JobLocaleReopenParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::JobLocale.new(JSON.load(rc.body)), err end
Get a single job locale for a given job. API Path: /api/v2/projects/:project_id/jobs/:job_id/locale/:id
Parameters:¶ ↑
- project_id
-
project_id
- job_id
-
job_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::JobLocaleShowParams
Returns:¶ ↑
PhraseApp::ResponseObjects::JobLocale err
# File lib/phraseapp-ruby.rb, line 5632 def job_locale_show(project_id, job_id, id, params) path = sprintf("/api/v2/projects/%s/jobs/%s/locale/%s", project_id, job_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::JobLocaleShowParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::JobLocaleShowParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::JobLocale.new(JSON.load(rc.body)), err end
Update an existing job locale. API Path: /api/v2/projects/:project_id/jobs/:job_id/locales/:id
Parameters:¶ ↑
- project_id
-
project_id
- job_id
-
job_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::JobLocaleParams
Returns:¶ ↑
PhraseApp::ResponseObjects::JobLocale err
# File lib/phraseapp-ruby.rb, line 5672 def job_locale_update(project_id, job_id, id, params) path = sprintf("/api/v2/projects/%s/jobs/%s/locales/%s", project_id, job_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::JobLocaleParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::JobLocaleParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::JobLocale.new(JSON.load(rc.body)), err end
Create a new job locale. API Path: /api/v2/projects/:project_id/jobs/:job_id/locales
Parameters:¶ ↑
- project_id
-
project_id
- job_id
-
job_id
- params
-
Parameters of type
PhraseApp::RequestParams::JobLocaleParams
Returns:¶ ↑
PhraseApp::ResponseObjects::JobLocale err
# File lib/phraseapp-ruby.rb, line 5710 def job_locales_create(project_id, job_id, params) path = sprintf("/api/v2/projects/%s/jobs/%s/locales", project_id, job_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::JobLocaleParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::JobLocaleParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::JobLocale.new(JSON.load(rc.body)), err end
List all job locales for a given job. API Path: /api/v2/projects/:project_id/jobs/:job_id/locales
Parameters:¶ ↑
- project_id
-
project_id
- job_id
-
job_id
- params
-
Parameters of type
PhraseApp::RequestParams::JobLocalesListParams
Returns:¶ ↑
PhraseApp::ResponseObjects::JobLocale err
# File lib/phraseapp-ruby.rb, line 5748 def job_locales_list(project_id, job_id, page, per_page, params) path = sprintf("/api/v2/projects/%s/jobs/%s/locales", project_id, job_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::JobLocalesListParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::JobLocalesListParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::JobLocale.new(item) }, err end
Mark a job as uncompleted. API Path: /api/v2/projects/:project_id/jobs/:id/reopen
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::JobReopenParams
Returns:¶ ↑
PhraseApp::ResponseObjects::JobDetails err
# File lib/phraseapp-ruby.rb, line 5359 def job_reopen(project_id, id, params) path = sprintf("/api/v2/projects/%s/jobs/%s/reopen", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::JobReopenParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::JobReopenParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::JobDetails.new(JSON.load(rc.body)), err end
Get details on a single job for a given project. API Path: /api/v2/projects/:project_id/jobs/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::JobShowParams
Returns:¶ ↑
PhraseApp::ResponseObjects::JobDetails err
# File lib/phraseapp-ruby.rb, line 5397 def job_show(project_id, id, params) path = sprintf("/api/v2/projects/%s/jobs/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::JobShowParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::JobShowParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::JobDetails.new(JSON.load(rc.body)), err end
Starts an existing job in state draft. API Path: /api/v2/projects/:project_id/jobs/:id/start
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::JobStartParams
Returns:¶ ↑
PhraseApp::ResponseObjects::JobDetails err
# File lib/phraseapp-ruby.rb, line 5435 def job_start(project_id, id, params) path = sprintf("/api/v2/projects/%s/jobs/%s/start", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::JobStartParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::JobStartParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::JobDetails.new(JSON.load(rc.body)), err end
Update an existing job. API Path: /api/v2/projects/:project_id/jobs/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::JobUpdateParams
Returns:¶ ↑
PhraseApp::ResponseObjects::JobDetails err
# File lib/phraseapp-ruby.rb, line 5473 def job_update(project_id, id, params) path = sprintf("/api/v2/projects/%s/jobs/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::JobUpdateParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::JobUpdateParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::JobDetails.new(JSON.load(rc.body)), err end
List all jobs for the given project. API Path: /api/v2/projects/:project_id/jobs
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::JobsListParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Job err
# File lib/phraseapp-ruby.rb, line 5784 def jobs_list(project_id, page, per_page, params) path = sprintf("/api/v2/projects/%s/jobs", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::JobsListParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::JobsListParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Job.new(item) }, err end
Create a new key. API Path: /api/v2/projects/:project_id/keys
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::TranslationKeyParams
Returns:¶ ↑
PhraseApp::ResponseObjects::TranslationKeyDetails err
# File lib/phraseapp-ruby.rb, line 5820 def key_create(project_id, params) path = sprintf("/api/v2/projects/%s/keys", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::TranslationKeyParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::TranslationKeyParams") end end if params.branch != nil data_hash["branch"] = params.branch end if params.data_type != nil data_hash["data_type"] = params.data_type end if params.description != nil data_hash["description"] = params.description end if params.localized_format_key != nil data_hash["localized_format_key"] = params.localized_format_key end if params.localized_format_string != nil data_hash["localized_format_string"] = params.localized_format_string end if params.max_characters_allowed != nil data_hash["max_characters_allowed"] = params.max_characters_allowed.to_i end if params.name != nil data_hash["name"] = params.name end if params.name_plural != nil data_hash["name_plural"] = params.name_plural end if params.original_file != nil data_hash["original_file"] = params.original_file end if params.plural != nil data_hash["plural"] = (params.plural == true) end if params.remove_screenshot != nil data_hash["remove_screenshot"] = (params.remove_screenshot == true) end if params.screenshot != nil post_body = [] post_body << "--#{PhraseApp::MULTIPART_BOUNDARY}\r\n" post_body << "Content-Disposition: form-data; name=\"screenshot\"; filename=\"#{File.basename(params.screenshot )}\"\r\n" post_body << "Content-Type: text/plain\r\n" post_body << "\r\n" post_body << File.read(params.screenshot) post_body << "\r\n" end if params.tags != nil data_hash["tags"] = params.tags end if params.unformatted != nil data_hash["unformatted"] = (params.unformatted == true) end if params.xml_space_preserve != nil data_hash["xml_space_preserve"] = (params.xml_space_preserve == true) end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::TranslationKeyDetails.new(JSON.load(rc.body)), err end
Delete an existing key. API Path: /api/v2/projects/:project_id/keys/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::KeyDeleteParams
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 5919 def key_delete(project_id, id, params) path = sprintf("/api/v2/projects/%s/keys/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::KeyDeleteParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::KeyDeleteParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Get details on a single key for a given project. API Path: /api/v2/projects/:project_id/keys/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::KeyShowParams
Returns:¶ ↑
PhraseApp::ResponseObjects::TranslationKeyDetails err
# File lib/phraseapp-ruby.rb, line 5957 def key_show(project_id, id, params) path = sprintf("/api/v2/projects/%s/keys/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::KeyShowParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::KeyShowParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::TranslationKeyDetails.new(JSON.load(rc.body)), err end
Update an existing key. API Path: /api/v2/projects/:project_id/keys/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::TranslationKeyParams
Returns:¶ ↑
PhraseApp::ResponseObjects::TranslationKeyDetails err
# File lib/phraseapp-ruby.rb, line 5995 def key_update(project_id, id, params) path = sprintf("/api/v2/projects/%s/keys/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::TranslationKeyParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::TranslationKeyParams") end end if params.branch != nil data_hash["branch"] = params.branch end if params.data_type != nil data_hash["data_type"] = params.data_type end if params.description != nil data_hash["description"] = params.description end if params.localized_format_key != nil data_hash["localized_format_key"] = params.localized_format_key end if params.localized_format_string != nil data_hash["localized_format_string"] = params.localized_format_string end if params.max_characters_allowed != nil data_hash["max_characters_allowed"] = params.max_characters_allowed.to_i end if params.name != nil data_hash["name"] = params.name end if params.name_plural != nil data_hash["name_plural"] = params.name_plural end if params.original_file != nil data_hash["original_file"] = params.original_file end if params.plural != nil data_hash["plural"] = (params.plural == true) end if params.remove_screenshot != nil data_hash["remove_screenshot"] = (params.remove_screenshot == true) end if params.screenshot != nil post_body = [] post_body << "--#{PhraseApp::MULTIPART_BOUNDARY}\r\n" post_body << "Content-Disposition: form-data; name=\"screenshot\"; filename=\"#{File.basename(params.screenshot )}\"\r\n" post_body << "Content-Type: text/plain\r\n" post_body << "\r\n" post_body << File.read(params.screenshot) post_body << "\r\n" end if params.tags != nil data_hash["tags"] = params.tags end if params.unformatted != nil data_hash["unformatted"] = (params.unformatted == true) end if params.xml_space_preserve != nil data_hash["xml_space_preserve"] = (params.xml_space_preserve == true) end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::TranslationKeyDetails.new(JSON.load(rc.body)), err end
Delete all keys matching query. Same constraints as list. Please limit the number of affected keys to about 1,000 as you might experience timeouts otherwise. API Path: /api/v2/projects/:project_id/keys
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::KeysDeleteParams
Returns:¶ ↑
PhraseApp::ResponseObjects::AffectedResources err
# File lib/phraseapp-ruby.rb, line 6093 def keys_delete(project_id, params) path = sprintf("/api/v2/projects/%s/keys", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::KeysDeleteParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::KeysDeleteParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::AffectedResources.new(JSON.load(rc.body)), err end
List all keys for the given project. Alternatively you can POST requests to /search. API Path: /api/v2/projects/:project_id/keys
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::KeysListParams
Returns:¶ ↑
PhraseApp::ResponseObjects::TranslationKey err
# File lib/phraseapp-ruby.rb, line 6129 def keys_list(project_id, page, per_page, params) path = sprintf("/api/v2/projects/%s/keys", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::KeysListParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::KeysListParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::TranslationKey.new(item) }, err end
Search keys for the given project matching query. API Path: /api/v2/projects/:project_id/keys/search
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::KeysSearchParams
Returns:¶ ↑
PhraseApp::ResponseObjects::TranslationKey err
# File lib/phraseapp-ruby.rb, line 6165 def keys_search(project_id, page, per_page, params) path = sprintf("/api/v2/projects/%s/keys/search", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::KeysSearchParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::KeysSearchParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::TranslationKey.new(item) }, err end
Tags all keys matching query. Same constraints as list. API Path: /api/v2/projects/:project_id/keys/tag
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::KeysTagParams
Returns:¶ ↑
PhraseApp::ResponseObjects::AffectedResources err
# File lib/phraseapp-ruby.rb, line 6201 def keys_tag(project_id, params) path = sprintf("/api/v2/projects/%s/keys/tag", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::KeysTagParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::KeysTagParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::AffectedResources.new(JSON.load(rc.body)), err end
Removes specified tags from keys matching query. API Path: /api/v2/projects/:project_id/keys/untag
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::KeysUntagParams
Returns:¶ ↑
PhraseApp::ResponseObjects::AffectedResources err
# File lib/phraseapp-ruby.rb, line 6237 def keys_untag(project_id, params) path = sprintf("/api/v2/projects/%s/keys/untag", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::KeysUntagParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::KeysUntagParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::AffectedResources.new(JSON.load(rc.body)), err end
Create a new locale. API Path: /api/v2/projects/:project_id/locales
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::LocaleParams
Returns:¶ ↑
PhraseApp::ResponseObjects::LocaleDetails err
# File lib/phraseapp-ruby.rb, line 6273 def locale_create(project_id, params) path = sprintf("/api/v2/projects/%s/locales", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::LocaleParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::LocaleParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::LocaleDetails.new(JSON.load(rc.body)), err end
Delete an existing locale. API Path: /api/v2/projects/:project_id/locales/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::LocaleDeleteParams
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 6310 def locale_delete(project_id, id, params) path = sprintf("/api/v2/projects/%s/locales/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::LocaleDeleteParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::LocaleDeleteParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Download a locale in a specific file format. API Path: /api/v2/projects/:project_id/locales/:id/download
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::LocaleDownloadParams
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 6347 def locale_download(project_id, id, params) path = sprintf("/api/v2/projects/%s/locales/%s/download", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::LocaleDownloadParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::LocaleDownloadParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return rc.body return err end
Get details on a single locale for a given project. API Path: /api/v2/projects/:project_id/locales/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::LocaleShowParams
Returns:¶ ↑
PhraseApp::ResponseObjects::LocaleDetails err
# File lib/phraseapp-ruby.rb, line 6385 def locale_show(project_id, id, params) path = sprintf("/api/v2/projects/%s/locales/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::LocaleShowParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::LocaleShowParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::LocaleDetails.new(JSON.load(rc.body)), err end
Update an existing locale. API Path: /api/v2/projects/:project_id/locales/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::LocaleParams
Returns:¶ ↑
PhraseApp::ResponseObjects::LocaleDetails err
# File lib/phraseapp-ruby.rb, line 6423 def locale_update(project_id, id, params) path = sprintf("/api/v2/projects/%s/locales/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::LocaleParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::LocaleParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::LocaleDetails.new(JSON.load(rc.body)), err end
List all locales for the given project. API Path: /api/v2/projects/:project_id/locales
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::LocalesListParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Locale err
# File lib/phraseapp-ruby.rb, line 6459 def locales_list(project_id, page, per_page, params) path = sprintf("/api/v2/projects/%s/locales", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::LocalesListParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::LocalesListParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Locale.new(item) }, err end
Remove a user from the account. The user will be removed from the account but not deleted from PhraseApp
. Access token scope must include team.manage
. API Path: /api/v2/accounts/:account_id/members/:id
Parameters:¶ ↑
- account_id
-
account_id
- id
-
id
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 6494 def member_delete(account_id, id) path = sprintf("/api/v2/accounts/%s/members/%s", account_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Get details on a single user in the account. Access token scope must include team.manage
. API Path: /api/v2/accounts/:account_id/members/:id
Parameters:¶ ↑
- account_id
-
account_id
- id
-
id
Returns:¶ ↑
PhraseApp::ResponseObjects::Member err
# File lib/phraseapp-ruby.rb, line 6519 def member_show(account_id, id) path = sprintf("/api/v2/accounts/%s/members/%s", account_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Member.new(JSON.load(rc.body)), err end
Update user permissions in the account. Developers and translators need project_ids
and locale_ids
assigned to access them. Access token scope must include team.manage
. API Path: /api/v2/accounts/:account_id/members/:id
Parameters:¶ ↑
- account_id
-
account_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::MemberUpdateParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Member err
# File lib/phraseapp-ruby.rb, line 6546 def member_update(account_id, id, params) path = sprintf("/api/v2/accounts/%s/members/%s", account_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::MemberUpdateParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::MemberUpdateParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Member.new(JSON.load(rc.body)), err end
Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include team.manage
. API Path: /api/v2/accounts/:account_id/members
Parameters:¶ ↑
- account_id
-
account_id
Returns:¶ ↑
PhraseApp::ResponseObjects::Member err
# File lib/phraseapp-ruby.rb, line 6580 def members_list(account_id, page, per_page) path = sprintf("/api/v2/accounts/%s/members", account_id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Member.new(item) }, err end
Confirm an existing order and send it to the provider for translation. Same constraints as for create. API Path: /api/v2/projects/:project_id/orders/:id/confirm
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::OrderConfirmParams
Returns:¶ ↑
PhraseApp::ResponseObjects::TranslationOrder err
# File lib/phraseapp-ruby.rb, line 6607 def order_confirm(project_id, id, params) path = sprintf("/api/v2/projects/%s/orders/%s/confirm", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::OrderConfirmParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::OrderConfirmParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::TranslationOrder.new(JSON.load(rc.body)), err end
Create a new order. Access token scope must include orders.create
. API Path: /api/v2/projects/:project_id/orders
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::TranslationOrderParams
Returns:¶ ↑
PhraseApp::ResponseObjects::TranslationOrder err
# File lib/phraseapp-ruby.rb, line 6643 def order_create(project_id, params) path = sprintf("/api/v2/projects/%s/orders", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::TranslationOrderParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::TranslationOrderParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::TranslationOrder.new(JSON.load(rc.body)), err end
Cancel an existing order. Must not yet be confirmed. API Path: /api/v2/projects/:project_id/orders/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::OrderDeleteParams
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 6680 def order_delete(project_id, id, params) path = sprintf("/api/v2/projects/%s/orders/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::OrderDeleteParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::OrderDeleteParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Get details on a single order. API Path: /api/v2/projects/:project_id/orders/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::OrderShowParams
Returns:¶ ↑
PhraseApp::ResponseObjects::TranslationOrder err
# File lib/phraseapp-ruby.rb, line 6718 def order_show(project_id, id, params) path = sprintf("/api/v2/projects/%s/orders/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::OrderShowParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::OrderShowParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::TranslationOrder.new(JSON.load(rc.body)), err end
List all orders for the given project. API Path: /api/v2/projects/:project_id/orders
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::OrdersListParams
Returns:¶ ↑
PhraseApp::ResponseObjects::TranslationOrder err
# File lib/phraseapp-ruby.rb, line 6754 def orders_list(project_id, page, per_page, params) path = sprintf("/api/v2/projects/%s/orders", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::OrdersListParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::OrdersListParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::TranslationOrder.new(item) }, err end
Create a new project. API Path: /api/v2/projects
Parameters:¶ ↑
- params
-
Parameters of type
PhraseApp::RequestParams::ProjectParams
Returns:¶ ↑
PhraseApp::ResponseObjects::ProjectDetails err
# File lib/phraseapp-ruby.rb, line 6788 def project_create(params) path = sprintf("/api/v2/projects") data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::ProjectParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::ProjectParams") end end if params.account_id != nil data_hash["account_id"] = params.account_id end if params.main_format != nil data_hash["main_format"] = params.main_format end if params.name != nil data_hash["name"] = params.name end if params.project_image != nil post_body = [] post_body << "--#{PhraseApp::MULTIPART_BOUNDARY}\r\n" post_body << "Content-Disposition: form-data; name=\"project_image\"; filename=\"#{File.basename(params.project_image )}\"\r\n" post_body << "Content-Type: text/plain\r\n" post_body << "\r\n" post_body << File.read(params.project_image) post_body << "\r\n" end if params.remove_project_image != nil data_hash["remove_project_image"] = (params.remove_project_image == true) end if params.shares_translation_memory != nil data_hash["shares_translation_memory"] = (params.shares_translation_memory == true) end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::ProjectDetails.new(JSON.load(rc.body)), err end
Delete an existing project. API Path: /api/v2/projects/:id
Parameters:¶ ↑
- id
-
id
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 6847 def project_delete(id) path = sprintf("/api/v2/projects/%s", id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Get details on a single project. API Path: /api/v2/projects/:id
Parameters:¶ ↑
- id
-
id
Returns:¶ ↑
PhraseApp::ResponseObjects::ProjectDetails err
# File lib/phraseapp-ruby.rb, line 6870 def project_show(id) path = sprintf("/api/v2/projects/%s", id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::ProjectDetails.new(JSON.load(rc.body)), err end
Update an existing project. API Path: /api/v2/projects/:id
Parameters:¶ ↑
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::ProjectParams
Returns:¶ ↑
PhraseApp::ResponseObjects::ProjectDetails err
# File lib/phraseapp-ruby.rb, line 6895 def project_update(id, params) path = sprintf("/api/v2/projects/%s", id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::ProjectParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::ProjectParams") end end if params.account_id != nil data_hash["account_id"] = params.account_id end if params.main_format != nil data_hash["main_format"] = params.main_format end if params.name != nil data_hash["name"] = params.name end if params.project_image != nil post_body = [] post_body << "--#{PhraseApp::MULTIPART_BOUNDARY}\r\n" post_body << "Content-Disposition: form-data; name=\"project_image\"; filename=\"#{File.basename(params.project_image )}\"\r\n" post_body << "Content-Type: text/plain\r\n" post_body << "\r\n" post_body << File.read(params.project_image) post_body << "\r\n" end if params.remove_project_image != nil data_hash["remove_project_image"] = (params.remove_project_image == true) end if params.shares_translation_memory != nil data_hash["shares_translation_memory"] = (params.shares_translation_memory == true) end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::ProjectDetails.new(JSON.load(rc.body)), err end
List all projects the current user has access to. API Path: /api/v2/projects
Parameters:¶ ↑
Returns:¶ ↑
PhraseApp::ResponseObjects::Project err
# File lib/phraseapp-ruby.rb, line 6953 def projects_list(page, per_page) path = sprintf("/api/v2/projects") data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Project.new(item) }, err end
Create a new release. API Path: /api/v2/accounts/:account_id/distributions/:distribution_id/releases
Parameters:¶ ↑
- account_id
-
account_id
- distribution_id
-
distribution_id
- params
-
Parameters of type
PhraseApp::RequestParams::ReleasesParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Release err
# File lib/phraseapp-ruby.rb, line 6980 def release_create(account_id, distribution_id, params) path = sprintf("/api/v2/accounts/%s/distributions/%s/releases", account_id, distribution_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::ReleasesParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::ReleasesParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::Release.new(JSON.load(rc.body)), err end
Delete an existing release. API Path: /api/v2/accounts/:account_id/distributions/:distribution_id/releases/:id
Parameters:¶ ↑
- account_id
-
account_id
- distribution_id
-
distribution_id
- id
-
id
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 7017 def release_delete(account_id, distribution_id, id) path = sprintf("/api/v2/accounts/%s/distributions/%s/releases/%s", account_id, distribution_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Publish a release for production. API Path: /api/v2/accounts/:account_id/distributions/:distribution_id/releases/:id/publish
Parameters:¶ ↑
- account_id
-
account_id
- distribution_id
-
distribution_id
- id
-
id
Returns:¶ ↑
PhraseApp::ResponseObjects::Release err
# File lib/phraseapp-ruby.rb, line 7044 def release_publish(account_id, distribution_id, id) path = sprintf("/api/v2/accounts/%s/distributions/%s/releases/%s/publish", account_id, distribution_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Release.new(JSON.load(rc.body)), err end
Get details on a single release. API Path: /api/v2/accounts/:account_id/distributions/:distribution_id/releases/:id
Parameters:¶ ↑
- account_id
-
account_id
- distribution_id
-
distribution_id
- id
-
id
Returns:¶ ↑
PhraseApp::ResponseObjects::Release err
# File lib/phraseapp-ruby.rb, line 7071 def release_show(account_id, distribution_id, id) path = sprintf("/api/v2/accounts/%s/distributions/%s/releases/%s", account_id, distribution_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Release.new(JSON.load(rc.body)), err end
Update an existing release. API Path: /api/v2/accounts/:account_id/distributions/:distribution_id/releases/:id
Parameters:¶ ↑
- account_id
-
account_id
- distribution_id
-
distribution_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::ReleasesParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Release err
# File lib/phraseapp-ruby.rb, line 7100 def release_update(account_id, distribution_id, id, params) path = sprintf("/api/v2/accounts/%s/distributions/%s/releases/%s", account_id, distribution_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::ReleasesParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::ReleasesParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Release.new(JSON.load(rc.body)), err end
List all releases for the given distribution. API Path: /api/v2/accounts/:account_id/distributions/:distribution_id/releases
Parameters:¶ ↑
- account_id
-
account_id
- distribution_id
-
distribution_id
Returns:¶ ↑
PhraseApp::ResponseObjects::ReleasePreview err
# File lib/phraseapp-ruby.rb, line 7136 def releases_list(account_id, distribution_id, page, per_page) path = sprintf("/api/v2/accounts/%s/distributions/%s/releases", account_id, distribution_id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::ReleasePreview.new(item) }, err end
Create a new screenshot. API Path: /api/v2/projects/:project_id/screenshots
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::ScreenshotParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Screenshot err
# File lib/phraseapp-ruby.rb, line 7161 def screenshot_create(project_id, params) path = sprintf("/api/v2/projects/%s/screenshots", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::ScreenshotParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::ScreenshotParams") end end if params.description != nil data_hash["description"] = params.description end if params.filename != nil post_body = [] post_body << "--#{PhraseApp::MULTIPART_BOUNDARY}\r\n" post_body << "Content-Disposition: form-data; name=\"filename\"; filename=\"#{File.basename(params.filename )}\"\r\n" post_body << "Content-Type: text/plain\r\n" post_body << "\r\n" post_body << File.read(params.filename) post_body << "\r\n" end if params.name != nil data_hash["name"] = params.name end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::Screenshot.new(JSON.load(rc.body)), err end
Delete an existing screenshot. API Path: /api/v2/projects/:project_id/screenshots/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 7210 def screenshot_delete(project_id, id) path = sprintf("/api/v2/projects/%s/screenshots/%s", project_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Create a new screenshot marker. API Path: /api/v2/projects/:project_id/screenshots/:screenshot_id/markers
Parameters:¶ ↑
- project_id
-
project_id
- screenshot_id
-
screenshot_id
- params
-
Parameters of type
PhraseApp::RequestParams::ScreenshotMarkerParams
Returns:¶ ↑
PhraseApp::ResponseObjects::ScreenshotMarker err
# File lib/phraseapp-ruby.rb, line 7314 def screenshot_marker_create(project_id, screenshot_id, params) path = sprintf("/api/v2/projects/%s/screenshots/%s/markers", project_id, screenshot_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::ScreenshotMarkerParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::ScreenshotMarkerParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::ScreenshotMarker.new(JSON.load(rc.body)), err end
Delete an existing screenshot marker. API Path: /api/v2/projects/:project_id/screenshots/:screenshot_id/markers
Parameters:¶ ↑
- project_id
-
project_id
- screenshot_id
-
screenshot_id
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 7349 def screenshot_marker_delete(project_id, screenshot_id) path = sprintf("/api/v2/projects/%s/screenshots/%s/markers", project_id, screenshot_id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Get details on a single screenshot marker for a given project. API Path: /api/v2/projects/:project_id/screenshots/:screenshot_id/markers/:id
Parameters:¶ ↑
- project_id
-
project_id
- screenshot_id
-
screenshot_id
- id
-
id
Returns:¶ ↑
PhraseApp::ResponseObjects::ScreenshotMarker err
# File lib/phraseapp-ruby.rb, line 7376 def screenshot_marker_show(project_id, screenshot_id, id) path = sprintf("/api/v2/projects/%s/screenshots/%s/markers/%s", project_id, screenshot_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::ScreenshotMarker.new(JSON.load(rc.body)), err end
Update an existing screenshot marker. API Path: /api/v2/projects/:project_id/screenshots/:screenshot_id/markers
Parameters:¶ ↑
- project_id
-
project_id
- screenshot_id
-
screenshot_id
- params
-
Parameters of type
PhraseApp::RequestParams::ScreenshotMarkerParams
Returns:¶ ↑
PhraseApp::ResponseObjects::ScreenshotMarker err
# File lib/phraseapp-ruby.rb, line 7403 def screenshot_marker_update(project_id, screenshot_id, params) path = sprintf("/api/v2/projects/%s/screenshots/%s/markers", project_id, screenshot_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::ScreenshotMarkerParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::ScreenshotMarkerParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::ScreenshotMarker.new(JSON.load(rc.body)), err end
List all screenshot markers for the given project. API Path: /api/v2/projects/:project_id/screenshots/:id/markers
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
Returns:¶ ↑
PhraseApp::ResponseObjects::ScreenshotMarker err
# File lib/phraseapp-ruby.rb, line 7439 def screenshot_markers_list(project_id, id, page, per_page) path = sprintf("/api/v2/projects/%s/screenshots/%s/markers", project_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::ScreenshotMarker.new(item) }, err end
Get details on a single screenshot for a given project. API Path: /api/v2/projects/:project_id/screenshots/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
Returns:¶ ↑
PhraseApp::ResponseObjects::Screenshot err
# File lib/phraseapp-ruby.rb, line 7235 def screenshot_show(project_id, id) path = sprintf("/api/v2/projects/%s/screenshots/%s", project_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Screenshot.new(JSON.load(rc.body)), err end
Update an existing screenshot. API Path: /api/v2/projects/:project_id/screenshots/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::ScreenshotParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Screenshot err
# File lib/phraseapp-ruby.rb, line 7262 def screenshot_update(project_id, id, params) path = sprintf("/api/v2/projects/%s/screenshots/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::ScreenshotParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::ScreenshotParams") end end if params.description != nil data_hash["description"] = params.description end if params.filename != nil post_body = [] post_body << "--#{PhraseApp::MULTIPART_BOUNDARY}\r\n" post_body << "Content-Disposition: form-data; name=\"filename\"; filename=\"#{File.basename(params.filename )}\"\r\n" post_body << "Content-Type: text/plain\r\n" post_body << "\r\n" post_body << File.read(params.filename) post_body << "\r\n" end if params.name != nil data_hash["name"] = params.name end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Screenshot.new(JSON.load(rc.body)), err end
List all screenshots for the given project. API Path: /api/v2/projects/:project_id/screenshots
Parameters:¶ ↑
- project_id
-
project_id
Returns:¶ ↑
PhraseApp::ResponseObjects::Screenshot err
# File lib/phraseapp-ruby.rb, line 7462 def screenshots_list(project_id, page, per_page) path = sprintf("/api/v2/projects/%s/screenshots", project_id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Screenshot.new(item) }, err end
Show details for current User. API Path: /api/v2/user
Parameters:¶ ↑
Returns:¶ ↑
PhraseApp::ResponseObjects::User err
# File lib/phraseapp-ruby.rb, line 7483 def show_user() path = sprintf("/api/v2/user") data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::User.new(JSON.load(rc.body)), err end
Create a new style guide. API Path: /api/v2/projects/:project_id/styleguides
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::StyleguideParams
Returns:¶ ↑
PhraseApp::ResponseObjects::StyleguideDetails err
# File lib/phraseapp-ruby.rb, line 7508 def styleguide_create(project_id, params) path = sprintf("/api/v2/projects/%s/styleguides", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::StyleguideParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::StyleguideParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::StyleguideDetails.new(JSON.load(rc.body)), err end
Delete an existing style guide. API Path: /api/v2/projects/:project_id/styleguides/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 7543 def styleguide_delete(project_id, id) path = sprintf("/api/v2/projects/%s/styleguides/%s", project_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Get details on a single style guide. API Path: /api/v2/projects/:project_id/styleguides/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
Returns:¶ ↑
PhraseApp::ResponseObjects::StyleguideDetails err
# File lib/phraseapp-ruby.rb, line 7568 def styleguide_show(project_id, id) path = sprintf("/api/v2/projects/%s/styleguides/%s", project_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::StyleguideDetails.new(JSON.load(rc.body)), err end
Update an existing style guide. API Path: /api/v2/projects/:project_id/styleguides/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::StyleguideParams
Returns:¶ ↑
PhraseApp::ResponseObjects::StyleguideDetails err
# File lib/phraseapp-ruby.rb, line 7595 def styleguide_update(project_id, id, params) path = sprintf("/api/v2/projects/%s/styleguides/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::StyleguideParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::StyleguideParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::StyleguideDetails.new(JSON.load(rc.body)), err end
List all styleguides for the given project. API Path: /api/v2/projects/:project_id/styleguides
Parameters:¶ ↑
- project_id
-
project_id
Returns:¶ ↑
PhraseApp::ResponseObjects::Styleguide err
# File lib/phraseapp-ruby.rb, line 7629 def styleguides_list(project_id, page, per_page) path = sprintf("/api/v2/projects/%s/styleguides", project_id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Styleguide.new(item) }, err end
Create a new tag. API Path: /api/v2/projects/:project_id/tags
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::TagParams
Returns:¶ ↑
PhraseApp::ResponseObjects::TagWithStats err
# File lib/phraseapp-ruby.rb, line 7654 def tag_create(project_id, params) path = sprintf("/api/v2/projects/%s/tags", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::TagParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::TagParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::TagWithStats.new(JSON.load(rc.body)), err end
Delete an existing tag. API Path: /api/v2/projects/:project_id/tags/:name
Parameters:¶ ↑
- project_id
-
project_id
- name
-
name
- params
-
Parameters of type
PhraseApp::RequestParams::TagDeleteParams
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 7691 def tag_delete(project_id, name, params) path = sprintf("/api/v2/projects/%s/tags/%s", project_id, name) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::TagDeleteParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::TagDeleteParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Get details and progress information on a single tag for a given project. API Path: /api/v2/projects/:project_id/tags/:name
Parameters:¶ ↑
- project_id
-
project_id
- name
-
name
- params
-
Parameters of type
PhraseApp::RequestParams::TagShowParams
Returns:¶ ↑
PhraseApp::ResponseObjects::TagWithStats err
# File lib/phraseapp-ruby.rb, line 7729 def tag_show(project_id, name, params) path = sprintf("/api/v2/projects/%s/tags/%s", project_id, name) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::TagShowParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::TagShowParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::TagWithStats.new(JSON.load(rc.body)), err end
Create a translation. API Path: /api/v2/projects/:project_id/translations
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::TranslationParams
Returns:¶ ↑
PhraseApp::ResponseObjects::TranslationDetails err
# File lib/phraseapp-ruby.rb, line 7801 def translation_create(project_id, params) path = sprintf("/api/v2/projects/%s/translations", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::TranslationParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::TranslationParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::TranslationDetails.new(JSON.load(rc.body)), err end
Get details on a single translation. API Path: /api/v2/projects/:project_id/translations/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::TranslationShowParams
Returns:¶ ↑
PhraseApp::ResponseObjects::TranslationDetails err
# File lib/phraseapp-ruby.rb, line 7839 def translation_show(project_id, id, params) path = sprintf("/api/v2/projects/%s/translations/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::TranslationShowParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::TranslationShowParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::TranslationDetails.new(JSON.load(rc.body)), err end
Update an existing translation. API Path: /api/v2/projects/:project_id/translations/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::TranslationUpdateParams
Returns:¶ ↑
PhraseApp::ResponseObjects::TranslationDetails err
# File lib/phraseapp-ruby.rb, line 7877 def translation_update(project_id, id, params) path = sprintf("/api/v2/projects/%s/translations/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::TranslationUpdateParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::TranslationUpdateParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::TranslationDetails.new(JSON.load(rc.body)), err end
List translations for a specific key. API Path: /api/v2/projects/:project_id/keys/:key_id/translations
Parameters:¶ ↑
- project_id
-
project_id
- key_id
-
key_id
- params
-
Parameters of type
PhraseApp::RequestParams::TranslationsByKeyParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Translation err
# File lib/phraseapp-ruby.rb, line 7915 def translations_by_key(project_id, key_id, page, per_page, params) path = sprintf("/api/v2/projects/%s/keys/%s/translations", project_id, key_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::TranslationsByKeyParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::TranslationsByKeyParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Translation.new(item) }, err end
List translations for a specific locale. If you want to download all translations for one locale we recommend to use the locales#download
endpoint. API Path: /api/v2/projects/:project_id/locales/:locale_id/translations
Parameters:¶ ↑
- project_id
-
project_id
- locale_id
-
locale_id
- params
-
Parameters of type
PhraseApp::RequestParams::TranslationsByLocaleParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Translation err
# File lib/phraseapp-ruby.rb, line 7953 def translations_by_locale(project_id, locale_id, page, per_page, params) path = sprintf("/api/v2/projects/%s/locales/%s/translations", project_id, locale_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::TranslationsByLocaleParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::TranslationsByLocaleParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Translation.new(item) }, err end
Exclude translations matching query from locale export. API Path: /api/v2/projects/:project_id/translations/exclude
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::TranslationsExcludeParams
Returns:¶ ↑
PhraseApp::ResponseObjects::AffectedCount err
# File lib/phraseapp-ruby.rb, line 7989 def translations_exclude(project_id, params) path = sprintf("/api/v2/projects/%s/translations/exclude", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::TranslationsExcludeParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::TranslationsExcludeParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::AffectedCount.new(JSON.load(rc.body)), err end
Include translations matching query in locale export. API Path: /api/v2/projects/:project_id/translations/include
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::TranslationsIncludeParams
Returns:¶ ↑
PhraseApp::ResponseObjects::AffectedCount err
# File lib/phraseapp-ruby.rb, line 8025 def translations_include(project_id, params) path = sprintf("/api/v2/projects/%s/translations/include", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::TranslationsIncludeParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::TranslationsIncludeParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::AffectedCount.new(JSON.load(rc.body)), err end
List translations for the given project. If you want to download all translations for one locale we recommend to use the locales#download
endpoint. API Path: /api/v2/projects/:project_id/translations
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::TranslationsListParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Translation err
# File lib/phraseapp-ruby.rb, line 8061 def translations_list(project_id, page, per_page, params) path = sprintf("/api/v2/projects/%s/translations", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::TranslationsListParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::TranslationsListParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Translation.new(item) }, err end
Search translations for the given project. Provides the same search interface as translations#index
but allows POST requests to avoid limitations imposed by GET requests. If you want to download all translations for one locale we recommend to use the locales#download
endpoint. API Path: /api/v2/projects/:project_id/translations/search
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::TranslationsSearchParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Translation err
# File lib/phraseapp-ruby.rb, line 8097 def translations_search(project_id, page, per_page, params) path = sprintf("/api/v2/projects/%s/translations/search", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::TranslationsSearchParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::TranslationsSearchParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Translation.new(item) }, err end
Mark translations matching query as unverified. API Path: /api/v2/projects/:project_id/translations/unverify
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::TranslationsUnverifyParams
Returns:¶ ↑
PhraseApp::ResponseObjects::AffectedCount err
# File lib/phraseapp-ruby.rb, line 8133 def translations_unverify(project_id, params) path = sprintf("/api/v2/projects/%s/translations/unverify", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::TranslationsUnverifyParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::TranslationsUnverifyParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::AffectedCount.new(JSON.load(rc.body)), err end
Verify translations matching query. API Path: /api/v2/projects/:project_id/translations/verify
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::TranslationsVerifyParams
Returns:¶ ↑
PhraseApp::ResponseObjects::AffectedCount err
# File lib/phraseapp-ruby.rb, line 8169 def translations_verify(project_id, params) path = sprintf("/api/v2/projects/%s/translations/verify", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::TranslationsVerifyParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::TranslationsVerifyParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::AffectedCount.new(JSON.load(rc.body)), err end
Upload a new language file. Creates necessary resources in your project. API Path: /api/v2/projects/:project_id/uploads
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::UploadParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Upload err
# File lib/phraseapp-ruby.rb, line 8205 def upload_create(project_id, params) path = sprintf("/api/v2/projects/%s/uploads", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::UploadParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::UploadParams") end end if params.autotranslate != nil data_hash["autotranslate"] = (params.autotranslate == true) end if params.branch != nil data_hash["branch"] = params.branch end if params.convert_emoji != nil data_hash["convert_emoji"] = (params.convert_emoji == true) end if params.file != nil post_body = [] post_body << "--#{PhraseApp::MULTIPART_BOUNDARY}\r\n" post_body << "Content-Disposition: form-data; name=\"file\"; filename=\"#{File.basename(params.file )}\"\r\n" post_body << "Content-Type: text/plain\r\n" post_body << "\r\n" post_body << File.read(params.file) post_body << "\r\n" end if params.file_encoding != nil data_hash["file_encoding"] = params.file_encoding end if params.file_format != nil data_hash["file_format"] = params.file_format end if params.format_options != nil params.format_options.each do |key, value| data_hash["format_options"][key] = value end end if params.locale_id != nil data_hash["locale_id"] = params.locale_id end if params.locale_mapping != nil params.locale_mapping.each do |key, value| data_hash["locale_mapping"][key] = value end end if params.mark_reviewed != nil data_hash["mark_reviewed"] = (params.mark_reviewed == true) end if params.skip_unverification != nil data_hash["skip_unverification"] = (params.skip_unverification == true) end if params.skip_upload_tags != nil data_hash["skip_upload_tags"] = (params.skip_upload_tags == true) end if params.tags != nil data_hash["tags"] = params.tags end if params.update_descriptions != nil data_hash["update_descriptions"] = (params.update_descriptions == true) end if params.update_translations != nil data_hash["update_translations"] = (params.update_translations == true) end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::Upload.new(JSON.load(rc.body)), err end
View details and summary for a single upload. API Path: /api/v2/projects/:project_id/uploads/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::UploadShowParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Upload err
# File lib/phraseapp-ruby.rb, line 8309 def upload_show(project_id, id, params) path = sprintf("/api/v2/projects/%s/uploads/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::UploadShowParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::UploadShowParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Upload.new(JSON.load(rc.body)), err end
List all uploads for the given project. API Path: /api/v2/projects/:project_id/uploads
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::UploadsListParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Upload err
# File lib/phraseapp-ruby.rb, line 8345 def uploads_list(project_id, page, per_page, params) path = sprintf("/api/v2/projects/%s/uploads", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::UploadsListParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::UploadsListParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Upload.new(item) }, err end
Get details on a single version. API Path: /api/v2/projects/:project_id/translations/:translation_id/versions/:id
Parameters:¶ ↑
- project_id
-
project_id
- translation_id
-
translation_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::VersionShowParams
Returns:¶ ↑
PhraseApp::ResponseObjects::TranslationVersionWithUser err
# File lib/phraseapp-ruby.rb, line 8385 def version_show(project_id, translation_id, id, params) path = sprintf("/api/v2/projects/%s/translations/%s/versions/%s", project_id, translation_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::VersionShowParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::VersionShowParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::TranslationVersionWithUser.new(JSON.load(rc.body)), err end
List all versions for the given translation. API Path: /api/v2/projects/:project_id/translations/:translation_id/versions
Parameters:¶ ↑
- project_id
-
project_id
- translation_id
-
translation_id
- params
-
Parameters of type
PhraseApp::RequestParams::VersionsListParams
Returns:¶ ↑
PhraseApp::ResponseObjects::TranslationVersion err
# File lib/phraseapp-ruby.rb, line 8423 def versions_list(project_id, translation_id, page, per_page, params) path = sprintf("/api/v2/projects/%s/translations/%s/versions", project_id, translation_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::VersionsListParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::VersionsListParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::TranslationVersion.new(item) }, err end
Create a new webhook. API Path: /api/v2/projects/:project_id/webhooks
Parameters:¶ ↑
- project_id
-
project_id
- params
-
Parameters of type
PhraseApp::RequestParams::WebhookParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Webhook err
# File lib/phraseapp-ruby.rb, line 8459 def webhook_create(project_id, params) path = sprintf("/api/v2/projects/%s/webhooks", project_id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::WebhookParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::WebhookParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 201) if err != nil return nil, err end return PhraseApp::ResponseObjects::Webhook.new(JSON.load(rc.body)), err end
Delete an existing webhook. API Path: /api/v2/projects/:project_id/webhooks/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 8494 def webhook_delete(project_id, id) path = sprintf("/api/v2/projects/%s/webhooks/%s", project_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "DELETE", path, reqHelper.ctype, reqHelper.body, 204) if err != nil return nil, err end return err end
Get details on a single webhook. API Path: /api/v2/projects/:project_id/webhooks/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
Returns:¶ ↑
PhraseApp::ResponseObjects::Webhook err
# File lib/phraseapp-ruby.rb, line 8519 def webhook_show(project_id, id) path = sprintf("/api/v2/projects/%s/webhooks/%s", project_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Webhook.new(JSON.load(rc.body)), err end
Perform a test request for a webhook. API Path: /api/v2/projects/:project_id/webhooks/:id/test
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
Returns:¶ ↑
err
# File lib/phraseapp-ruby.rb, line 8543 def webhook_test(project_id, id) path = sprintf("/api/v2/projects/%s/webhooks/%s/test", project_id, id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "POST", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return err end
Update an existing webhook. API Path: /api/v2/projects/:project_id/webhooks/:id
Parameters:¶ ↑
- project_id
-
project_id
- id
-
id
- params
-
Parameters of type
PhraseApp::RequestParams::WebhookParams
Returns:¶ ↑
PhraseApp::ResponseObjects::Webhook err
# File lib/phraseapp-ruby.rb, line 8570 def webhook_update(project_id, id, params) path = sprintf("/api/v2/projects/%s/webhooks/%s", project_id, id) data_hash = {} post_body = nil if params.present? unless params.kind_of?(PhraseApp::RequestParams::WebhookParams) raise PhraseApp::ParamsHelpers::ParamsError.new("Expects params to be kind_of PhraseApp::RequestParams::WebhookParams") end end data_hash = params.to_h err = params.validate if err != nil return nil, err end reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request(@credentials, "PATCH", path, reqHelper.ctype, reqHelper.body, 200) if err != nil return nil, err end return PhraseApp::ResponseObjects::Webhook.new(JSON.load(rc.body)), err end
List all webhooks for the given project. API Path: /api/v2/projects/:project_id/webhooks
Parameters:¶ ↑
- project_id
-
project_id
Returns:¶ ↑
PhraseApp::ResponseObjects::Webhook err
# File lib/phraseapp-ruby.rb, line 8604 def webhooks_list(project_id, page, per_page) path = sprintf("/api/v2/projects/%s/webhooks", project_id) data_hash = {} post_body = nil reqHelper = PhraseApp::ParamsHelpers::BodyTypeHelper.new(data_hash, post_body) rc, err = PhraseApp.send_request_paginated(@credentials, "GET", path, reqHelper.ctype, reqHelper.body, 200, page, per_page) if err != nil return nil, err end return JSON.load(rc.body).map { |item| PhraseApp::ResponseObjects::Webhook.new(item) }, err end