Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 1.98 KB

NotificationApi.md

File metadata and controls

67 lines (46 loc) · 1.98 KB

SwaggerClient::NotificationApi

All URIs are relative to https://localhost/api/v1

Method HTTP request Description
notification_get GET /notification Get your current notifications.

notification_get

Array<Notification> notification_get

Get your current notifications.

This is an upcoming feature and currently does not return data.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: apiKey
  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 API key authorization: apiNonce
  config.api_key['api-nonce'] = '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-nonce'] = 'Bearer'

  # Configure API key authorization: apiSignature
  config.api_key['api-signature'] = '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-signature'] = 'Bearer'
end

api_instance = SwaggerClient::NotificationApi.new

begin
  #Get your current notifications.
  result = api_instance.notification_get
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling NotificationApi->notification_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Array<Notification>

Authorization

apiKey, apiNonce, apiSignature

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript