com.smartsheet.api.EventResources Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smartsheet-sdk-java Show documentation

Library for connecting to Smartsheet Services

There is a newer version: 3.2.1

/*
 * Copyright (C) 2023 Smartsheet
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.smartsheet.api;

import com.smartsheet.api.models.EventResult;

public interface EventResources {

    /**
     * List all events.
     *
     * It mirrors to the following Smartsheet REST API method: GET /events
     *
     * @param since Starting time for events to return. You must pass in a value for either since or
     *              streamPosition and never both.
     * @param streamPosition Indicates next set of events to return. Use value of nextStreamPosition returned
     *                       from the previous call. You must pass in a value for either since or streamPosition
     *                       and never both.
     * @param maxCount Maximum number of events to return as response to this call. Must be between
     *                 1 through 10,000 (inclusive).
     * @param numericDates If true, dates are accepted and returned in Unix epoch time (milliseconds since midnight
     *                     on January 1, 1970 in UTC time). Default is false, which means ISO-8601 format
     * @return A list of all events (note that an empty list will be returned if there are none).
     * @throws IllegalArgumentException if any argument is null or empty string
     * @throws InvalidRequestException if there is any problem with the REST API request
     * @throws AuthorizationException if there is any problem with  the REST API authorization (access token)
     * @throws ResourceNotFoundException if the resource cannot be found
     * @throws ServiceUnavailableException if the REST API service is not available (possibly due to rate limiting)
     * @throws SmartsheetException if there is any other error during the operation
     */
    EventResult listEvents(Object since, String streamPosition, Integer maxCount, Boolean numericDates) throws SmartsheetException;
}