io.gate.gateapi.api

Class AccountApi

java.lang.Object

io.gate.gateapi.api.AccountApi

public class AccountApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AccountApi.APIlistSTPGroupsRequest

Constructor Summary

Constructors

Constructor and Description
AccountApi()
AccountApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
List<StpGroupUser>	addSTPGroupUsers(Long stpId, List<Long> requestBody) Add users to the STP group - Only the master account that created the STP user group is allowed to add users to the STP user group.- Only accounts under the main account are allowed to be added.
okhttp3.Call	addSTPGroupUsersAsync(Long stpId, List<Long> requestBody, ApiCallback<List<StpGroupUser>> _callback) Add users to the STP group (asynchronously) - Only the master account that created the STP user group is allowed to add users to the STP user group.- Only accounts under the main account are allowed to be added.
okhttp3.Call	addSTPGroupUsersCall(Long stpId, List<Long> requestBody, ApiCallback _callback) Build call for addSTPGroupUsers
ApiResponse<List<StpGroupUser>>	addSTPGroupUsersWithHttpInfo(Long stpId, List<Long> requestBody) Add users to the STP group - Only the master account that created the STP user group is allowed to add users to the STP user group.- Only accounts under the main account are allowed to be added.
StpGroup	createSTPGroup(StpGroup stpGroup) Create STP Group Only the main account is allowed to create a new STP user group
okhttp3.Call	createSTPGroupAsync(StpGroup stpGroup, ApiCallback<StpGroup> _callback) Create STP Group (asynchronously) Only the main account is allowed to create a new STP user group
okhttp3.Call	createSTPGroupCall(StpGroup stpGroup, ApiCallback _callback) Build call for createSTPGroup
ApiResponse<StpGroup>	createSTPGroupWithHttpInfo(StpGroup stpGroup) Create STP Group Only the main account is allowed to create a new STP user group
List<StpGroupUser>	deleteSTPGroupUsers(Long stpId, List<Long> requestBody) Delete the user in the STP group - Only the main account that created this STP group is allowed to delete users from the STP user group - Deletion is limited to accounts under the current main account; cross-account deletion is not permitted
okhttp3.Call	deleteSTPGroupUsersAsync(Long stpId, List<Long> requestBody, ApiCallback<List<StpGroupUser>> _callback) Delete the user in the STP group (asynchronously) - Only the main account that created this STP group is allowed to delete users from the STP user group - Deletion is limited to accounts under the current main account; cross-account deletion is not permitted
okhttp3.Call	deleteSTPGroupUsersCall(Long stpId, List<Long> requestBody, ApiCallback _callback) Build call for deleteSTPGroupUsers
ApiResponse<List<StpGroupUser>>	deleteSTPGroupUsersWithHttpInfo(Long stpId, List<Long> requestBody) Delete the user in the STP group - Only the main account that created this STP group is allowed to delete users from the STP user group - Deletion is limited to accounts under the current main account; cross-account deletion is not permitted
AccountDetail	getAccountDetail() Get account detail
okhttp3.Call	getAccountDetailAsync(ApiCallback<AccountDetail> _callback) Get account detail (asynchronously)
okhttp3.Call	getAccountDetailCall(ApiCallback _callback) Build call for getAccountDetail
ApiResponse<AccountDetail>	getAccountDetailWithHttpInfo() Get account detail
ApiClient	getApiClient()
AccountApi.APIlistSTPGroupsRequest	listSTPGroups() List STP Groups Retrieve the list of STP groups created by the main account user only
List<StpGroupUser>	listSTPGroupsUsers(Long stpId) List users of the STP group Only the main account that created this STP group is allowed to list the user ID of the STP group
okhttp3.Call	listSTPGroupsUsersAsync(Long stpId, ApiCallback<List<StpGroupUser>> _callback) List users of the STP group (asynchronously) Only the main account that created this STP group is allowed to list the user ID of the STP group
okhttp3.Call	listSTPGroupsUsersCall(Long stpId, ApiCallback _callback) Build call for listSTPGroupsUsers
ApiResponse<List<StpGroupUser>>	listSTPGroupsUsersWithHttpInfo(Long stpId) List users of the STP group Only the main account that created this STP group is allowed to list the user ID of the STP group
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountApi

public AccountApi()

AccountApi

public AccountApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAccountDetailCall

public okhttp3.Call getAccountDetailCall(ApiCallback _callback)
                                  throws ApiException

Build call for getAccountDetail

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Successful	-

getAccountDetail

public AccountDetail getAccountDetail()
                               throws ApiException

Get account detail

Returns:

AccountDetail

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Successful	-

getAccountDetailWithHttpInfo

public ApiResponse<AccountDetail> getAccountDetailWithHttpInfo()
                                                        throws ApiException

Get account detail

Returns:

ApiResponse<AccountDetail>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Successful	-

getAccountDetailAsync

public okhttp3.Call getAccountDetailAsync(ApiCallback<AccountDetail> _callback)
                                   throws ApiException

Get account detail (asynchronously)

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Successful	-

listSTPGroups

public AccountApi.APIlistSTPGroupsRequest listSTPGroups()

List STP Groups Retrieve the list of STP groups created by the main account user only

Returns:

APIlistSTPGroupsRequest

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

createSTPGroupCall

public okhttp3.Call createSTPGroupCall(StpGroup stpGroup,
                                       ApiCallback _callback)
                                throws ApiException

Build call for createSTPGroup

Parameters:

stpGroup - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	User added successfully. Returning the current users within the STP group.	-

createSTPGroup

public StpGroup createSTPGroup(StpGroup stpGroup)
                        throws ApiException

Create STP Group Only the main account is allowed to create a new STP user group

Parameters:

stpGroup - (required)

Returns:

StpGroup

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	User added successfully. Returning the current users within the STP group.	-

createSTPGroupWithHttpInfo

public ApiResponse<StpGroup> createSTPGroupWithHttpInfo(StpGroup stpGroup)
                                                 throws ApiException

Create STP Group Only the main account is allowed to create a new STP user group

Parameters:

stpGroup - (required)

Returns:

ApiResponse<StpGroup>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	User added successfully. Returning the current users within the STP group.	-

createSTPGroupAsync

public okhttp3.Call createSTPGroupAsync(StpGroup stpGroup,
                                        ApiCallback<StpGroup> _callback)
                                 throws ApiException

Create STP Group (asynchronously) Only the main account is allowed to create a new STP user group

Parameters:

stpGroup - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	User added successfully. Returning the current users within the STP group.	-

listSTPGroupsUsersCall

public okhttp3.Call listSTPGroupsUsersCall(Long stpId,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for listSTPGroupsUsers

Parameters:

stpId - STP Group ID (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listSTPGroupsUsers

public List<StpGroupUser> listSTPGroupsUsers(Long stpId)
                                      throws ApiException

List users of the STP group Only the main account that created this STP group is allowed to list the user ID of the STP group

Parameters:

stpId - STP Group ID (required)

Returns:

List<StpGroupUser>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listSTPGroupsUsersWithHttpInfo

public ApiResponse<List<StpGroupUser>> listSTPGroupsUsersWithHttpInfo(Long stpId)
                                                               throws ApiException

List users of the STP group Only the main account that created this STP group is allowed to list the user ID of the STP group

Parameters:

stpId - STP Group ID (required)

Returns:

ApiResponse<List<StpGroupUser>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

listSTPGroupsUsersAsync

public okhttp3.Call listSTPGroupsUsersAsync(Long stpId,
                                            ApiCallback<List<StpGroupUser>> _callback)
                                     throws ApiException

List users of the STP group (asynchronously) Only the main account that created this STP group is allowed to list the user ID of the STP group

Parameters:

stpId - STP Group ID (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	List retrieved	-

addSTPGroupUsersCall

public okhttp3.Call addSTPGroupUsersCall(Long stpId,
                                         List<Long> requestBody,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for addSTPGroupUsers

Parameters:

stpId - STP Group ID (required)

requestBody - User ID (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	User added successfully. Returning the current users within the STP group.	-

addSTPGroupUsers

public List<StpGroupUser> addSTPGroupUsers(Long stpId,
                                           List<Long> requestBody)
                                    throws ApiException

Add users to the STP group - Only the master account that created the STP user group is allowed to add users to the STP user group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted

Parameters:

stpId - STP Group ID (required)

requestBody - User ID (required)

Returns:

List<StpGroupUser>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	User added successfully. Returning the current users within the STP group.	-

addSTPGroupUsersWithHttpInfo

public ApiResponse<List<StpGroupUser>> addSTPGroupUsersWithHttpInfo(Long stpId,
                                                                    List<Long> requestBody)
                                                             throws ApiException

Add users to the STP group - Only the master account that created the STP user group is allowed to add users to the STP user group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted

Parameters:

stpId - STP Group ID (required)

requestBody - User ID (required)

Returns:

ApiResponse<List<StpGroupUser>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	User added successfully. Returning the current users within the STP group.	-

addSTPGroupUsersAsync

public okhttp3.Call addSTPGroupUsersAsync(Long stpId,
                                          List<Long> requestBody,
                                          ApiCallback<List<StpGroupUser>> _callback)
                                   throws ApiException

Add users to the STP group (asynchronously) - Only the master account that created the STP user group is allowed to add users to the STP user group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted

Parameters:

stpId - STP Group ID (required)

requestBody - User ID (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	User added successfully. Returning the current users within the STP group.	-

deleteSTPGroupUsersCall

public okhttp3.Call deleteSTPGroupUsersCall(Long stpId,
                                            List<Long> requestBody,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for deleteSTPGroupUsers

Parameters:

stpId - STP Group ID (required)

requestBody - User ID (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Success	-

deleteSTPGroupUsers

public List<StpGroupUser> deleteSTPGroupUsers(Long stpId,
                                              List<Long> requestBody)
                                       throws ApiException

Delete the user in the STP group - Only the main account that created this STP group is allowed to delete users from the STP user group - Deletion is limited to accounts under the current main account; cross-account deletion is not permitted

Parameters:

stpId - STP Group ID (required)

requestBody - User ID (required)

Returns:

List<StpGroupUser>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-

deleteSTPGroupUsersWithHttpInfo

public ApiResponse<List<StpGroupUser>> deleteSTPGroupUsersWithHttpInfo(Long stpId,
                                                                       List<Long> requestBody)
                                                                throws ApiException

Delete the user in the STP group - Only the main account that created this STP group is allowed to delete users from the STP user group - Deletion is limited to accounts under the current main account; cross-account deletion is not permitted

Parameters:

stpId - STP Group ID (required)

requestBody - User ID (required)

Returns:

ApiResponse<List<StpGroupUser>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-

deleteSTPGroupUsersAsync

public okhttp3.Call deleteSTPGroupUsersAsync(Long stpId,
                                             List<Long> requestBody,
                                             ApiCallback<List<StpGroupUser>> _callback)
                                      throws ApiException

Delete the user in the STP group (asynchronously) - Only the main account that created this STP group is allowed to delete users from the STP user group - Deletion is limited to accounts under the current main account; cross-account deletion is not permitted

Parameters:

stpId - STP Group ID (required)

requestBody - User ID (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Success	-