playit-cloud/playit-api-java
1
0
Fork 0
mirror of https://github.com/playit-cloud/playit-api-java synced 2024-11-24 02:06:12 +00:00
Code
master
playit-api-java/docs/DefaultPlayitAPI.md
Patrick Lorio 3e0a1c260b Initial commit
2024-02-08 12:15:33 -08:00

26 KiB
Raw Permalink Blame History

DefaultPlayitAPI

All URIs are relative to https://api.playit.gg

Method HTTP request Description
agentsRoutingGetPost POST /agents/routing/get
agentsRundataPost POST /agents/rundata
claimAcceptPost POST /claim/accept
claimDetailsPost POST /claim/details
claimExchangePost POST /claim/exchange
claimRejectPost POST /claim/reject
claimSetupPost POST /claim/setup
loginGuestPost POST /login/guest
protoRegisterPost POST /proto/register
tunnelsCreatePost POST /tunnels/create
tunnelsDeletePost POST /tunnels/delete
tunnelsListPost POST /tunnels/list

agentsRoutingGetPost

AgentsRoutingGetPost200Response agentsRoutingGetPost(reqAgentsRoutingGet)

Example

// Import classes:
import gg.playit.ApiClient;
import gg.playit.ApiException;
import gg.playit.Configuration;
import gg.playit.auth.*;
import gg.playit.models.*;
import gg.playit.api.DefaultPlayitAPI;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.playit.gg");
    
    // Configure API key authorization: AgentKey
    ApiKeyAuth AgentKey = (ApiKeyAuth) defaultClient.getAuthentication("AgentKey");
    AgentKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //AgentKey.setApiKeyPrefix("Token");

    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    DefaultPlayitAPI apiInstance = new DefaultPlayitAPI(defaultClient);
    ReqAgentsRoutingGet reqAgentsRoutingGet = new ReqAgentsRoutingGet(); // ReqAgentsRoutingGet | 
    try {
      AgentsRoutingGetPost200Response result = apiInstance.agentsRoutingGetPost(reqAgentsRoutingGet);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultPlayitAPI#agentsRoutingGetPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
reqAgentsRoutingGet ReqAgentsRoutingGet

Return type

AgentsRoutingGetPost200Response

Authorization

AgentKey, ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -
400 -
401 -
500 -

agentsRundataPost

AgentsRundataPost200Response agentsRundataPost()

Example

// Import classes:
import gg.playit.ApiClient;
import gg.playit.ApiException;
import gg.playit.Configuration;
import gg.playit.auth.*;
import gg.playit.models.*;
import gg.playit.api.DefaultPlayitAPI;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.playit.gg");
    
    // Configure API key authorization: AgentKey
    ApiKeyAuth AgentKey = (ApiKeyAuth) defaultClient.getAuthentication("AgentKey");
    AgentKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //AgentKey.setApiKeyPrefix("Token");

    DefaultPlayitAPI apiInstance = new DefaultPlayitAPI(defaultClient);
    try {
      AgentsRundataPost200Response result = apiInstance.agentsRundataPost();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultPlayitAPI#agentsRundataPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

AgentsRundataPost200Response

Authorization

AgentKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -
400 -
401 -
500 -

claimAcceptPost

ClaimAcceptPost200Response claimAcceptPost(reqClaimAccept)

Example

// Import classes:
import gg.playit.ApiClient;
import gg.playit.ApiException;
import gg.playit.Configuration;
import gg.playit.auth.*;
import gg.playit.models.*;
import gg.playit.api.DefaultPlayitAPI;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.playit.gg");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    DefaultPlayitAPI apiInstance = new DefaultPlayitAPI(defaultClient);
    ReqClaimAccept reqClaimAccept = new ReqClaimAccept(); // ReqClaimAccept | 
    try {
      ClaimAcceptPost200Response result = apiInstance.claimAcceptPost(reqClaimAccept);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultPlayitAPI#claimAcceptPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
reqClaimAccept ReqClaimAccept

Return type

ClaimAcceptPost200Response

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -
400 -
401 -
500 -

claimDetailsPost

ClaimDetailsPost200Response claimDetailsPost(reqClaimDetails)

Example

// Import classes:
import gg.playit.ApiClient;
import gg.playit.ApiException;
import gg.playit.Configuration;
import gg.playit.auth.*;
import gg.playit.models.*;
import gg.playit.api.DefaultPlayitAPI;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.playit.gg");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    DefaultPlayitAPI apiInstance = new DefaultPlayitAPI(defaultClient);
    ReqClaimDetails reqClaimDetails = new ReqClaimDetails(); // ReqClaimDetails | 
    try {
      ClaimDetailsPost200Response result = apiInstance.claimDetailsPost(reqClaimDetails);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultPlayitAPI#claimDetailsPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
reqClaimDetails ReqClaimDetails

Return type

ClaimDetailsPost200Response

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -
400 -
401 -
500 -

claimExchangePost

ClaimExchangePost200Response claimExchangePost(reqClaimExchange)

Example

// Import classes:
import gg.playit.ApiClient;
import gg.playit.ApiException;
import gg.playit.Configuration;
import gg.playit.models.*;
import gg.playit.api.DefaultPlayitAPI;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.playit.gg");

    DefaultPlayitAPI apiInstance = new DefaultPlayitAPI(defaultClient);
    ReqClaimExchange reqClaimExchange = new ReqClaimExchange(); // ReqClaimExchange | 
    try {
      ClaimExchangePost200Response result = apiInstance.claimExchangePost(reqClaimExchange);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultPlayitAPI#claimExchangePost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
reqClaimExchange ReqClaimExchange

Return type

ClaimExchangePost200Response

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -
400 -
401 -
500 -

claimRejectPost

TunnelsDeletePost200Response claimRejectPost(reqClaimReject)

Example

// Import classes:
import gg.playit.ApiClient;
import gg.playit.ApiException;
import gg.playit.Configuration;
import gg.playit.auth.*;
import gg.playit.models.*;
import gg.playit.api.DefaultPlayitAPI;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.playit.gg");
    
    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    DefaultPlayitAPI apiInstance = new DefaultPlayitAPI(defaultClient);
    ReqClaimReject reqClaimReject = new ReqClaimReject(); // ReqClaimReject | 
    try {
      TunnelsDeletePost200Response result = apiInstance.claimRejectPost(reqClaimReject);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultPlayitAPI#claimRejectPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
reqClaimReject ReqClaimReject

Return type

TunnelsDeletePost200Response

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -
400 -
401 -
500 -

claimSetupPost

ClaimSetupPost200Response claimSetupPost(reqClaimSetup)

Example

// Import classes:
import gg.playit.ApiClient;
import gg.playit.ApiException;
import gg.playit.Configuration;
import gg.playit.models.*;
import gg.playit.api.DefaultPlayitAPI;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.playit.gg");

    DefaultPlayitAPI apiInstance = new DefaultPlayitAPI(defaultClient);
    ReqClaimSetup reqClaimSetup = new ReqClaimSetup(); // ReqClaimSetup | 
    try {
      ClaimSetupPost200Response result = apiInstance.claimSetupPost(reqClaimSetup);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultPlayitAPI#claimSetupPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
reqClaimSetup ReqClaimSetup

Return type

ClaimSetupPost200Response

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -
400 -
401 -
500 -

loginGuestPost

LoginGuestPost200Response loginGuestPost()

Example

// Import classes:
import gg.playit.ApiClient;
import gg.playit.ApiException;
import gg.playit.Configuration;
import gg.playit.auth.*;
import gg.playit.models.*;
import gg.playit.api.DefaultPlayitAPI;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.playit.gg");
    
    // Configure API key authorization: AgentKey
    ApiKeyAuth AgentKey = (ApiKeyAuth) defaultClient.getAuthentication("AgentKey");
    AgentKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //AgentKey.setApiKeyPrefix("Token");

    DefaultPlayitAPI apiInstance = new DefaultPlayitAPI(defaultClient);
    try {
      LoginGuestPost200Response result = apiInstance.loginGuestPost();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultPlayitAPI#loginGuestPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

LoginGuestPost200Response

Authorization

AgentKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -
400 -
401 -
500 -

protoRegisterPost

ProtoRegisterPost200Response protoRegisterPost(reqProtoRegister)

Example

// Import classes:
import gg.playit.ApiClient;
import gg.playit.ApiException;
import gg.playit.Configuration;
import gg.playit.auth.*;
import gg.playit.models.*;
import gg.playit.api.DefaultPlayitAPI;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.playit.gg");
    
    // Configure API key authorization: AgentKey
    ApiKeyAuth AgentKey = (ApiKeyAuth) defaultClient.getAuthentication("AgentKey");
    AgentKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //AgentKey.setApiKeyPrefix("Token");

    DefaultPlayitAPI apiInstance = new DefaultPlayitAPI(defaultClient);
    ReqProtoRegister reqProtoRegister = new ReqProtoRegister(); // ReqProtoRegister | 
    try {
      ProtoRegisterPost200Response result = apiInstance.protoRegisterPost(reqProtoRegister);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultPlayitAPI#protoRegisterPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
reqProtoRegister ReqProtoRegister

Return type

ProtoRegisterPost200Response

Authorization

AgentKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -
400 -
401 -
500 -

tunnelsCreatePost

TunnelsCreatePost200Response tunnelsCreatePost(reqTunnelsCreate)

Example

// Import classes:
import gg.playit.ApiClient;
import gg.playit.ApiException;
import gg.playit.Configuration;
import gg.playit.auth.*;
import gg.playit.models.*;
import gg.playit.api.DefaultPlayitAPI;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.playit.gg");
    
    // Configure API key authorization: AgentKey
    ApiKeyAuth AgentKey = (ApiKeyAuth) defaultClient.getAuthentication("AgentKey");
    AgentKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //AgentKey.setApiKeyPrefix("Token");

    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    DefaultPlayitAPI apiInstance = new DefaultPlayitAPI(defaultClient);
    ReqTunnelsCreate reqTunnelsCreate = new ReqTunnelsCreate(); // ReqTunnelsCreate | 
    try {
      TunnelsCreatePost200Response result = apiInstance.tunnelsCreatePost(reqTunnelsCreate);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultPlayitAPI#tunnelsCreatePost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
reqTunnelsCreate ReqTunnelsCreate

Return type

TunnelsCreatePost200Response

Authorization

AgentKey, ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -
400 -
401 -
500 -

tunnelsDeletePost

TunnelsDeletePost200Response tunnelsDeletePost(reqTunnelsDelete)

Example

// Import classes:
import gg.playit.ApiClient;
import gg.playit.ApiException;
import gg.playit.Configuration;
import gg.playit.auth.*;
import gg.playit.models.*;
import gg.playit.api.DefaultPlayitAPI;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.playit.gg");
    
    // Configure API key authorization: AgentKey
    ApiKeyAuth AgentKey = (ApiKeyAuth) defaultClient.getAuthentication("AgentKey");
    AgentKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //AgentKey.setApiKeyPrefix("Token");

    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    DefaultPlayitAPI apiInstance = new DefaultPlayitAPI(defaultClient);
    ReqTunnelsDelete reqTunnelsDelete = new ReqTunnelsDelete(); // ReqTunnelsDelete | 
    try {
      TunnelsDeletePost200Response result = apiInstance.tunnelsDeletePost(reqTunnelsDelete);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultPlayitAPI#tunnelsDeletePost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
reqTunnelsDelete ReqTunnelsDelete

Return type

TunnelsDeletePost200Response

Authorization

AgentKey, ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -
400 -
401 -
500 -

tunnelsListPost

TunnelsListPost200Response tunnelsListPost(reqTunnelsList)

Example

// Import classes:
import gg.playit.ApiClient;
import gg.playit.ApiException;
import gg.playit.Configuration;
import gg.playit.auth.*;
import gg.playit.models.*;
import gg.playit.api.DefaultPlayitAPI;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.playit.gg");
    
    // Configure API key authorization: AgentKey
    ApiKeyAuth AgentKey = (ApiKeyAuth) defaultClient.getAuthentication("AgentKey");
    AgentKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //AgentKey.setApiKeyPrefix("Token");

    // Configure API key authorization: ApiKey
    ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKey.setApiKeyPrefix("Token");

    DefaultPlayitAPI apiInstance = new DefaultPlayitAPI(defaultClient);
    ReqTunnelsList reqTunnelsList = new ReqTunnelsList(); // ReqTunnelsList | 
    try {
      TunnelsListPost200Response result = apiInstance.tunnelsListPost(reqTunnelsList);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultPlayitAPI#tunnelsListPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
reqTunnelsList ReqTunnelsList

Return type

TunnelsListPost200Response

Authorization

AgentKey, ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -
400 -
401 -
500 -