Skip to content

Latest commit

 

History

History
165 lines (118 loc) · 4.84 KB

AccountsApi.md

File metadata and controls

165 lines (118 loc) · 4.84 KB
Raw

OpenapiClient::AccountsApi

All URIs are relative to https://api.stateset.com/v1

Method HTTP request Description
get_account_by_name GET /accounts Get account by account name
get_account_by_name_0 GET /accounts/{id} Get account by account name

get_account_by_name

get_account_by_name(limit, offset, order_direction)

Get account by account name

Some description of the operation. You can use Markdown here.

Examples

require 'time'
require 'openapi_client'
# setup authorization
OpenapiClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['api_key'] = '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['api_key'] = 'Bearer'

  # Configure OAuth2 access token for authorization: main_auth
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = OpenapiClient::AccountsApi.new
limit = 8.14 # Float | The number of items to return
offset = 8.14 # Float | Filter users without email
order_direction = 'order_direction_example' # String | Direction to return accounts

begin
  # Get account by account name
  result = api_instance.get_account_by_name(limit, offset, order_direction)
  p result
rescue OpenapiClient::ApiError => e
  puts "Error when calling AccountsApi->get_account_by_name: #{e}"
end

Using the get_account_by_name_with_http_info variant

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

<Array(, Integer, Hash)> get_account_by_name_with_http_info(limit, offset, order_direction)

begin
  # Get account by account name
  data, status_code, headers = api_instance.get_account_by_name_with_http_info(limit, offset, order_direction)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Accounts>
rescue OpenapiClient::ApiError => e
  puts "Error when calling AccountsApi->get_account_by_name_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
limit Float The number of items to return
offset Float Filter users without email
order_direction String Direction to return accounts

Return type

Accounts

Authorization

api_key, main_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

get_account_by_name_0

get_account_by_name_0(limit, offset, order_direction)

Get account by account name

Some description of the operation. You can use Markdown here.

Examples

require 'time'
require 'openapi_client'
# setup authorization
OpenapiClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['api_key'] = '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['api_key'] = 'Bearer'

  # Configure OAuth2 access token for authorization: main_auth
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = OpenapiClient::AccountsApi.new
limit = 8.14 # Float | The number of items to return
offset = 8.14 # Float | Filter users without email
order_direction = 'order_direction_example' # String | Direction to return accounts

begin
  # Get account by account name
  result = api_instance.get_account_by_name_0(limit, offset, order_direction)
  p result
rescue OpenapiClient::ApiError => e
  puts "Error when calling AccountsApi->get_account_by_name_0: #{e}"
end

Using the get_account_by_name_0_with_http_info variant

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

<Array(, Integer, Hash)> get_account_by_name_0_with_http_info(limit, offset, order_direction)

begin
  # Get account by account name
  data, status_code, headers = api_instance.get_account_by_name_0_with_http_info(limit, offset, order_direction)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Accounts>
rescue OpenapiClient::ApiError => e
  puts "Error when calling AccountsApi->get_account_by_name_0_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
limit Float The number of items to return
offset Float Filter users without email
order_direction String Direction to return accounts

Return type

Accounts

Authorization

api_key, main_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json