Package pl.gsmservice.gateway

Class Common

java.lang.Object

pl.gsmservice.gateway.Common

All Implemented Interfaces:

SDKMethodInterfaces.MethodCallPing

public class Common
extends java.lang.Object
implements SDKMethodInterfaces.MethodCallPing

This section describes other usefull operations and tools

Method Summary

Modifier and Type	Method	Description
PingRequestBuilder	ping()	Checks API availability and version Check the API connection and the current API availability status.
PingResponse	ping(java.util.Optional<Options> options)	Checks API availability and version Check the API connection and the current API availability status.
PingResponse	pingDirect()	Checks API availability and version Check the API connection and the current API availability status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

ping

public PingRequestBuilder ping()

Checks API availability and version Check the API connection and the current API availability status. Also you will get the current API version number. The request doesn't contain a body or any parameters. As a successful result a `PingResponse` object will be returned. This request doesn't need to be authenticated. In case of an error, the `ErrorResponse` object will be returned with proper HTTP header status code (our error response complies with [RFC 9457](https://www.rfc-editor.org/rfc/rfc7807)).

Returns:

The call builder

pingDirect

public PingResponse pingDirect()
                        throws java.lang.Exception

Checks API availability and version Check the API connection and the current API availability status. Also you will get the current API version number. The request doesn't contain a body or any parameters. As a successful result a `PingResponse` object will be returned. This request doesn't need to be authenticated. In case of an error, the `ErrorResponse` object will be returned with proper HTTP header status code (our error response complies with [RFC 9457](https://www.rfc-editor.org/rfc/rfc7807)).

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

ping

public PingResponse ping(java.util.Optional<Options> options)
                  throws java.lang.Exception

Checks API availability and version Check the API connection and the current API availability status. Also you will get the current API version number. The request doesn't contain a body or any parameters. As a successful result a `PingResponse` object will be returned. This request doesn't need to be authenticated. In case of an error, the `ErrorResponse` object will be returned with proper HTTP header status code (our error response complies with [RFC 9457](https://www.rfc-editor.org/rfc/rfc7807)).

Specified by:

ping in interface SDKMethodInterfaces.MethodCallPing

Parameters:

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails