Class AuthApi.APIlistGroupsRequest

  • Enclosing class:
    AuthApi

    public class AuthApi.APIlistGroupsRequest
    extends Object
    • Method Detail

      • prefix

        public AuthApi.APIlistGroupsRequest prefix​(String prefix)
        Set prefix
        Parameters:
        prefix - return items prefixed with this value (optional)
        Returns:
        APIlistGroupsRequest
      • after

        public AuthApi.APIlistGroupsRequest after​(String after)
        Set after
        Parameters:
        after - return items after this value (optional)
        Returns:
        APIlistGroupsRequest
      • amount

        public AuthApi.APIlistGroupsRequest amount​(Integer amount)
        Set amount
        Parameters:
        amount - how many items to return (optional, default to 100)
        Returns:
        APIlistGroupsRequest
      • buildCall

        public okhttp3.Call buildCall​(ApiCallback _callback)
                               throws ApiException
        Build call for listGroups
        Parameters:
        _callback - ApiCallback API callback
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 group list -
        401 Unauthorized -
        420 too many requests -
        0 Internal Server Error -
      • execute

        public GroupList execute()
                          throws ApiException
        Execute listGroups request
        Returns:
        GroupList
        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 group list -
        401 Unauthorized -
        420 too many requests -
        0 Internal Server Error -
      • executeWithHttpInfo

        public ApiResponse<GroupList> executeWithHttpInfo()
                                                   throws ApiException
        Execute listGroups request with HTTP info returned
        Returns:
        ApiResponse<GroupList>
        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 group list -
        401 Unauthorized -
        420 too many requests -
        0 Internal Server Error -
      • executeAsync

        public okhttp3.Call executeAsync​(ApiCallback<GroupList> _callback)
                                  throws ApiException
        Execute listGroups request (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 group list -
        401 Unauthorized -
        420 too many requests -
        0 Internal Server Error -