Skip to content

Latest commit

 

History

History
341 lines (242 loc) · 9.69 KB

GlossaryTermsApi.md

File metadata and controls

341 lines (242 loc) · 9.69 KB
Raw

Phrase::GlossaryTermsApi

All URIs are relative to https://api.phrase.com/v2

Method HTTP request Description
glossary_term_create POST /accounts/{account_id}/glossaries/{glossary_id}/terms Create a term
glossary_term_delete DELETE /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} Delete a term
glossary_term_show GET /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} Get a single term
glossary_term_update PATCH /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} Update a term
glossary_terms_list GET /accounts/{account_id}/glossaries/{glossary_id}/terms List terms

glossary_term_create

GlossaryTerm glossary_term_create(account_id, glossary_id, glossary_term_create_parameters, opts)

Create a term

Create a new term in a term base (previously: glossary).

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::GlossaryTermsApi.new
account_id = 'account_id_example' # String | Account ID
glossary_id = 'glossary_id_example' # String | Glossary ID
glossary_term_create_parameters = Phrase::GlossaryTermCreateParameters.new({term: 'MyCompany'}) # GlossaryTermCreateParameters | 
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
  #Create a term
  result = api_instance.glossary_term_create(account_id, glossary_id, glossary_term_create_parameters, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling GlossaryTermsApi->glossary_term_create: #{e}"
end

Parameters

Name Type Description Notes
account_id String Account ID
glossary_id String Glossary ID
glossary_term_create_parameters GlossaryTermCreateParameters
x_phrase_app_otp String Two-Factor-Authentication token (optional) [optional]

Return type

Response<(GlossaryTerm)>

Authorization

Basic, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

glossary_term_delete

glossary_term_delete(account_id, glossary_id, id, opts)

Delete a term

Delete an existing term in a term base (previously: glossary).

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::GlossaryTermsApi.new
account_id = 'account_id_example' # String | Account ID
glossary_id = 'glossary_id_example' # String | Glossary ID
id = 'id_example' # String | ID
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
  #Delete a term
  api_instance.glossary_term_delete(account_id, glossary_id, id, opts)
rescue Phrase::ApiError => e
  puts "Exception when calling GlossaryTermsApi->glossary_term_delete: #{e}"
end

Parameters

Name Type Description Notes
account_id String Account ID
glossary_id String Glossary ID
id String ID
x_phrase_app_otp String Two-Factor-Authentication token (optional) [optional]

Return type

Response<(nil (empty response body))>

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

glossary_term_show

GlossaryTerm glossary_term_show(account_id, glossary_id, id, opts)

Get a single term

Get details for a single term in the term base (previously: glossary).

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::GlossaryTermsApi.new
account_id = 'account_id_example' # String | Account ID
glossary_id = 'glossary_id_example' # String | Glossary ID
id = 'id_example' # String | ID
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
  #Get a single term
  result = api_instance.glossary_term_show(account_id, glossary_id, id, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling GlossaryTermsApi->glossary_term_show: #{e}"
end

Parameters

Name Type Description Notes
account_id String Account ID
glossary_id String Glossary ID
id String ID
x_phrase_app_otp String Two-Factor-Authentication token (optional) [optional]

Return type

Response<(GlossaryTerm)>

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

glossary_term_update

GlossaryTerm glossary_term_update(account_id, glossary_id, id, glossary_term_update_parameters, opts)

Update a term

Update an existing term in a term base (previously: glossary).

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::GlossaryTermsApi.new
account_id = 'account_id_example' # String | Account ID
glossary_id = 'glossary_id_example' # String | Glossary ID
id = 'id_example' # String | ID
glossary_term_update_parameters = Phrase::GlossaryTermUpdateParameters.new # GlossaryTermUpdateParameters | 
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
  #Update a term
  result = api_instance.glossary_term_update(account_id, glossary_id, id, glossary_term_update_parameters, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling GlossaryTermsApi->glossary_term_update: #{e}"
end

Parameters

Name Type Description Notes
account_id String Account ID
glossary_id String Glossary ID
id String ID
glossary_term_update_parameters GlossaryTermUpdateParameters
x_phrase_app_otp String Two-Factor-Authentication token (optional) [optional]

Return type

Response<(GlossaryTerm)>

Authorization

Basic, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

glossary_terms_list

Array<GlossaryTerm> glossary_terms_list(account_id, glossary_id, opts)

List terms

List all terms in term bases (previously: glossary) that the current user has access to.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::GlossaryTermsApi.new
account_id = 'account_id_example' # String | Account ID
glossary_id = 'glossary_id_example' # String | Glossary ID
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
  page: 1, # Integer | Page number
  per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
}

begin
  #List terms
  result = api_instance.glossary_terms_list(account_id, glossary_id, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling GlossaryTermsApi->glossary_terms_list: #{e}"
end

Parameters

Name Type Description Notes
account_id String Account ID
glossary_id String Glossary ID
x_phrase_app_otp String Two-Factor-Authentication token (optional) [optional]
page Integer Page number [optional]
per_page Integer Limit on the number of objects to be returned, between 1 and 100. 25 by default [optional]

Return type

Response<(Array<GlossaryTerm>)>

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json