• Home
• com.smartsheet
• smartsheet-sdk-java
• 2.2.1
• source code
• WebhookResources.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

package com.smartsheet.api;
/*
 * #[license]
 * Smartsheet SDK for Java
 * %%
 * Copyright (C) 2014 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.
 * %[license]
 */

import com.smartsheet.api.models.PagedResult;
import com.smartsheet.api.models.PaginationParameters;
import com.smartsheet.api.models.Webhook;
import com.smartsheet.api.models.WebhookSharedSecret;

public interface WebhookResources {
	/**
	 * 
Gets the list of all Webhooks that the user owns (if a user generated token was used to make the request)
	 * or the list of all Webhooks associated with the third-party app (if a third-party app made the request). Items 
	 * in the response are ordered by API Client name, then Webhook name, then creation date.
	 *
	 * 
It mirrors to the following Smartsheet REST API method: GET /webhooks
	 *
 	 * @param paging the object containing the pagination parameters
	 * @return IndexResult object containing an array of Webhook objects.
	 * @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
	 */	
	PagedResult listWebhooks(PaginationParameters paging) throws SmartsheetException;	

	/**
	 * 
Gets the Webhook specified in the URL.
	 *
	 * 
It mirrors to the following Smartsheet REST API method: GET /webhooks/{webhookId}
	 *
 	 * @param webhookId the Id of the webhook
	 * @return the webhook resource.
	 * @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
	 */	
	Webhook getWebhook(long webhookId) throws SmartsheetException;
	
	/**
	 * 
Creates a new Webhook.
	 *
	 * 
It mirrors to the following Smartsheet REST API method: POST /webhooks
	 *
 	 * @param webhook the webhook to be created
	 * @return the webhook resource.
	 * @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
	 */	
	Webhook createWebhook(Webhook webhook) throws SmartsheetException;
	
	/**
	 * 
Updates the webhooks specified in the URL.
	 *
	 * 
It mirrors to the following Smartsheet REST API method: PUT /webhooks/{webhookId}
	 *
 	 * @param webhook the webhook to update
	 * @return the updated webhook resource.
	 * @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
	 */
	Webhook updateWebhook(Webhook webhook) throws SmartsheetException;
	
	/**
	 * 
Delete a webhook.
	 *
	 * 
It mirrors to the following Smartsheet REST API method: DELETE /webhooks/{webhookId}
	 *
 	 * @param webhookId the webhook Id
	 * @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
	 */	
	void deleteWebhook(long webhookId) throws SmartsheetException;
	
	/**
	 * 
Resets the shared secret for the specified Webhook. For more information about how a shared secret is used,
	 *  see Authenticating Callbacks.
	 *
	 * 
It mirrors to the following Smartsheet REST API method: POST /webhooks/{webhookId}/resetsharedsecret
	 *
 	 * @param webhookId the webhook Id
 	 * @return the Webhook shared secret
	 * @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
	 */		
	WebhookSharedSecret resetSharedSecret(long webhookId) throws SmartsheetException;
}