org.springframework.social.partnercenter.api.audit.AuditOperations Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-social-microsoft-partnercenter Show documentation
There is a newer version: 10.11.0
Show newest version
package org.springframework.social.partnercenter.api.audit;

import java.time.Instant;

import org.springframework.http.ResponseEntity;
import org.springframework.social.partnercenter.api.PartnerCenterResponse;

public interface AuditOperations {

	/**
	 * Retrieves audit records for a date range specified by the start date.
	 * Note, however, that for performance reasons activity log data availability is limited to the previous 90 days.
	 * Requests with a start date greater than 90 days prior to the current date will receive a bad request exception (error code: 400)
	 * and an appropriate message.
	 *
	 * @param startDate Beginning of audit period
	 * @return list of activity
	 * @see MSDN: Get a record of Partner Center activity
	 */
	ResponseEntity> getPartnerCenterActivity(Instant startDate);

	/**
	 * Retrieves audit records for a date range specified by including the start date and the end date.
	 * Note, however, that for performance reasons activity log data availability is limited to the previous 90 days.
	 * Requests with a start date greater than 90 days prior to the current date will receive a bad request exception (error code: 400)
	 * and an appropriate message.
	 *
	 * @param startDate Beginning of audit period
	 * @param endDate End of audit Period
	 * @return list of activity
	 * @see MSDN: Get a record of Partner Center activity
	 */
	ResponseEntity> getPartnerCenterActivity(Instant startDate, Instant endDate);

	/**
	 * Retrieves audit records for a date range specified by including the start date and the end date for the Company passed in the 'companyName' parameter.
	 * Note, however, that for performance reasons activity log data availability is limited to the previous 90 days.
	 * Requests with a start date greater than 90 days prior to the current date will receive a bad request exception (error code: 400)
	 * and an appropriate message.
	 *
	 * @param startDate Beginning of audit period
	 * @param endDate End of audit Period
	 * @param companyName records can be filtered by 'CompanyName', 'CustomerId' or 'ResourceType
	 * @return list of activity
	 * @see MSDN: Get a record of Partner Center activity
	 */
	ResponseEntity> getPartnerCenterActivityByCompanyName(Instant startDate, Instant endDate, String companyName);

	/**
	 * Retrieves audit records for a date range specified by including the start date and the end date for the Customer passed in the 'customerId' parameter.
	 * Note, however, that for performance reasons activity log data availability is limited to the previous 90 days.
	 * Requests with a start date greater than 90 days prior to the current date will receive a bad request exception (error code: 400)
	 * and an appropriate message.
	 *
	 * @param startDate Beginning of audit period
	 * @param endDate End of audit Period
	 * @param customerId records are filtered by 'customerId'
	 * @return list of activity
	 * @see MSDN: Get a record of Partner Center activity
	 */
	ResponseEntity> getPartnerCenterActivityByCustomerId(Instant startDate, Instant endDate, String customerId);

	/**
	 * Retrieves audit records for a date range specified by including the start date and the end date for the ResourceType passed in the 'resourceType' parameter.
	 * Note, however, that for performance reasons activity log data availability is limited to the previous 90 days.
	 * Requests with a start date greater than 90 days prior to the current date will receive a bad request exception (error code: 400)
	 * and an appropriate message.
	 *
	 * @param startDate Beginning of audit period
	 * @param endDate End of audit Period
	 * @param resourceType records are filtered by 'resourceType'
	 * @return list of activity
	 * @see MSDN: Get a record of Partner Center activity
	 */
	ResponseEntity> getPartnerCenterActivityByResourceType(Instant startDate, Instant endDate, ResourceType resourceType);
}