Class WebhooksApi.APIlistRequest

  • Enclosing class:
    WebhooksApi

    public class WebhooksApi.APIlistRequest
    extends Object
    • Method Detail

      • events

        public WebhooksApi.APIlistRequest events​(String events)
        Set events
        Parameters:
        events - The webhook event that you wish to filter on. (optional)
        Returns:
        APIlistRequest
      • currentPage

        public WebhooksApi.APIlistRequest currentPage​(Integer currentPage)
        Set currentPage
        Parameters:
        currentPage - Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
        Returns:
        APIlistRequest
      • pageSize

        public WebhooksApi.APIlistRequest pageSize​(Integer pageSize)
        Set pageSize
        Parameters:
        pageSize - Results per page. Allowed values 1-100, default is 25. (optional, default to 25)
        Returns:
        APIlistRequest
      • buildCall

        public okhttp3.Call buildCall​(ApiCallback _callback)
                               throws ApiException
        Build call for list
        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 Success -
      • execute

        public Page<Webhook> execute()
                              throws ApiException
        Execute list request
        Returns:
        WebhooksListResponse
        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 -
      • executeWithHttpInfo

        public ApiResponse<WebhooksListResponse> executeWithHttpInfo()
                                                              throws ApiException
        Execute list request with HTTP info returned
        Returns:
        ApiResponse<WebhooksListResponse>
        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 -
      • executeAsync

        public okhttp3.Call executeAsync​(ApiCallback<Page<Webhook>> _callback)
                                  throws ApiException
        Execute list 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 Success -