Skip to content

Latest commit

 

History

History
79 lines (52 loc) · 2.12 KB

AvailableActionsApi.md

File metadata and controls

79 lines (52 loc) · 2.12 KB

MergeATSClient::AvailableActionsApi

All URIs are relative to https://api.merge.dev/api/ats/v1

Method HTTP request Description
available_actions_retrieve GET /available-actions

available_actions_retrieve

available_actions_retrieve(x_account_token)

Returns a list of models and actions available for an account.

Examples

require 'time'
require 'merge_ats_client'
# setup authorization
MergeATSClient.configure do |config|
  # Configure API key authorization: tokenAuth
  config.api_key['tokenAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['tokenAuth'] = 'Bearer'
end

api_instance = MergeATSClient::AvailableActionsApi.new
x_account_token = 'x_account_token_example' # String | Token identifying the end user.

begin
  
  result = api_instance.available_actions_retrieve(x_account_token)
  p result
rescue MergeATSClient::ApiError => e
  puts "Error when calling AvailableActionsApi->available_actions_retrieve: #{e}"
end

Using the available_actions_retrieve_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> available_actions_retrieve_with_http_info(x_account_token)

begin
  
  data, status_code, headers = api_instance.available_actions_retrieve_with_http_info(x_account_token)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AvailableActions>
rescue MergeATSClient::ApiError => e
  puts "Error when calling AvailableActionsApi->available_actions_retrieve_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_account_token String Token identifying the end user.

Return type

AvailableActions

Authorization

tokenAuth

HTTP request headers

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