Sha256: 993938b8af7cb9c8d89ffd34b41ac7a97b9382562424fbd627d6734ad309250c
Contents?: true
Size: 1.5 KB
Versions: 57
Compression:
Stored size: 1.5 KB
Contents
# Phrase::FormatsApi
All URIs are relative to *https://api.phrase.com/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**formats_list**](FormatsApi.md#formats_list) | **GET** /formats | List formats
## formats_list
> Array<Format> formats_list(opts)
List formats
Get a handy list of all localization file formats supported in Phrase.
### Example
```ruby
# 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::FormatsApi.new
opts = {
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}
begin
#List formats
result = api_instance.formats_list(opts)
pp result
rescue Phrase::ApiError => e
puts "Exception when calling FormatsApi->formats_list: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
### Return type
Response<([**Array<Format>**](Format.md))>
### Authorization
[Basic](../README.md#Basic), [Token](../README.md#Token)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
Version data entries
57 entries across 57 versions & 1 rubygems