/// <summary>
/// Gets a collection of queue items.
/// </summary>
/// <remarks>
/// Client Credentials Flow required permissions: Queues or Queues.Read.
///
/// Required permissions: Queues.View and Transactions.View.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='mandatoryPermissions'>
/// If in a cross-folder scenario, these represent the additional permissions
/// required in the folders the data is retrieved from; all permissions in this
/// set must be met
/// </param>
/// <param name='atLeastOnePermissions'>
/// If in a cross-folder scenario, these represent the additional permissions
/// required in the folders the data is retrieved from; at least one permission
/// in this set must be met
/// </param>
/// <param name='expand'>
/// Indicates the related entities to be represented inline. The maximum depth
/// is 2.
/// </param>
/// <param name='filter'>
/// Restricts the set of items returned. The maximum number of expressions is
/// 100.
/// </param>
/// <param name='select'>
/// Limits the properties returned in the result.
/// </param>
/// <param name='orderby'>
/// Specifies the order in which items are returned. The maximum number of
/// expressions is 5.
/// </param>
/// <param name='top'>
/// Limits the number of items returned from a collection. The maximum value is
/// 1000.
/// </param>
/// <param name='skip'>
/// Excludes the specified number of items of the queried collection from the
/// result.
/// </param>
/// <param name='count'>
/// Indicates whether the total count of items within a collection are returned
/// in the result.
/// </param>
/// <param name='xUIPATHOrganizationUnitId'>
/// Folder/OrganizationUnit Id
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task <ODataValueOfIEnumerableOfQueueItemDto> GetAsync(this IQueueItems operations, IList <string> mandatoryPermissions = default(IList <string>), IList <string> atLeastOnePermissions = default(IList <string>), string expand = default(string), string filter = default(string), string select = default(string), string orderby = default(string), int?top = default(int?), int?skip = default(int?), bool?count = default(bool?), long?xUIPATHOrganizationUnitId = default(long?), CancellationToken cancellationToken = default(CancellationToken))
{
using (var _result = await operations.GetWithHttpMessagesAsync(mandatoryPermissions, atLeastOnePermissions, expand, filter, select, orderby, top, skip, count, xUIPATHOrganizationUnitId, null, cancellationToken).ConfigureAwait(false))
{
return(_result.Body);
}
}
/// <summary>
/// Gets a collection of queue items.
/// </summary>
/// <remarks>
/// Client Credentials Flow required permissions: Queues or Queues.Read.
///
/// Required permissions: Queues.View and Transactions.View.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='expand'>
/// Expands related entities inline.
/// </param>
/// <param name='filter'>
/// Filters the results, based on a Boolean condition.
/// </param>
/// <param name='select'>
/// Selects which properties to include in the response.
/// </param>
/// <param name='orderby'>
/// Sorts the results.
/// </param>
/// <param name='top'>
/// Returns only the first n results.
/// </param>
/// <param name='skip'>
/// Skips the first n results.
/// </param>
/// <param name='count'>
/// Includes a count of the matching results in the response.
/// </param>
/// <param name='xUIPATHOrganizationUnitId'>
/// Folder/OrganizationUnit Id
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task <ODataValueIEnumerableQueueItemDto> GetAsync(this IQueueItems operations, string expand = default(string), string filter = default(string), string select = default(string), string orderby = default(string), int?top = default(int?), int?skip = default(int?), bool?count = default(bool?), long?xUIPATHOrganizationUnitId = default(long?), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
using (var _result = await operations.GetWithHttpMessagesAsync(expand, filter, select, orderby, top, skip, count, xUIPATHOrganizationUnitId, null, cancellationToken).ConfigureAwait(false))
{
return(_result.Body);
}
}
/// <summary>
/// Gets a collection of queue items.
/// </summary>
/// <remarks>
/// Required permissions: Queues.View and Transactions.View.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='expand'>
/// Expands related entities inline.
/// </param>
/// <param name='filter'>
/// Filters the results, based on a Boolean condition.
/// </param>
/// <param name='select'>
/// Selects which properties to include in the response.
/// </param>
/// <param name='orderby'>
/// Sorts the results.
/// </param>
/// <param name='top'>
/// Returns only the first n results.
/// </param>
/// <param name='skip'>
/// Skips the first n results.
/// </param>
/// <param name='count'>
/// Includes a count of the matching results in the response.
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task <ODataResponseListQueueItemDto> GetQueueItemsAsync(this IQueueItems operations, string expand = default(string), string filter = default(string), string select = default(string), string orderby = default(string), int?top = default(int?), int?skip = default(int?), bool?count = default(bool?), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
using (var _result = await operations.GetQueueItemsWithHttpMessagesAsync(expand, filter, select, orderby, top, skip, count, null, cancellationToken).ConfigureAwait(false))
{
return(_result.Body);
}
}
/// <summary>
/// Gets a queue item by Id.
/// </summary>
/// <remarks>
/// Required permissions: Queues.View and Transactions.View.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='id'>
/// key: Id
/// </param>
/// <param name='expand'>
/// Expands related entities inline.
/// </param>
/// <param name='select'>
/// Selects which properties to include in the response.
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task <QueueItemDto> GetByIdAsync(this IQueueItems operations, long id, string expand = default(string), string select = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
using (var _result = await operations.GetByIdWithHttpMessagesAsync(id, expand, select, null, cancellationToken).ConfigureAwait(false))
{
return(_result.Body);
}
}
/// <summary>
/// Gets a queue item by Id.
/// </summary>
/// <remarks>
/// Client Credentials Flow required permissions: Queues or Queues.Read.
///
/// Required permissions: Queues.View and Transactions.View.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='key'>
/// </param>
/// <param name='expand'>
/// Indicates the related entities to be represented inline. The maximum depth
/// is 2.
/// </param>
/// <param name='select'>
/// Limits the properties returned in the result.
/// </param>
/// <param name='xUIPATHOrganizationUnitId'>
/// Folder/OrganizationUnit Id
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task <QueueItemDto> GetByIdAsync(this IQueueItems operations, long key, string expand = default(string), string select = default(string), long?xUIPATHOrganizationUnitId = default(long?), CancellationToken cancellationToken = default(CancellationToken))
{
using (var _result = await operations.GetByIdWithHttpMessagesAsync(key, expand, select, xUIPATHOrganizationUnitId, null, cancellationToken).ConfigureAwait(false))
{
return(_result.Body);
}
}
/// <summary>
/// Sets the given queue items' status to Deleted.
/// </summary>
/// <remarks>
/// Client Credentials Flow required permissions: Queues or Queues.Write.
///
/// Required permissions: Queues.View and Transactions.Delete.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='body'>
/// QueueItems - The collection of ids of queue items to delete.
/// </param>
/// <param name='expand'>
/// Indicates the related entities to be represented inline. The maximum depth
/// is 2.
/// </param>
/// <param name='select'>
/// Limits the properties returned in the result.
/// </param>
/// <param name='xUIPATHOrganizationUnitId'>
/// Folder/OrganizationUnit Id
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task <BulkOperationResponseDtoOfInt64> DeleteBulkAsync(this IQueueItems operations, QueueItemDeleteBulkRequest body = default(QueueItemDeleteBulkRequest), string expand = default(string), string select = default(string), long?xUIPATHOrganizationUnitId = default(long?), CancellationToken cancellationToken = default(CancellationToken))
{
using (var _result = await operations.DeleteBulkWithHttpMessagesAsync(body, expand, select, xUIPATHOrganizationUnitId, null, cancellationToken).ConfigureAwait(false))
{
return(_result.Body);
}
}
/// <summary>
/// Updates the QueueItem properties with the new values provided.
/// </summary>
/// <remarks>
/// Required permissions: Queues.Edit and Transactions.Edit.
///
/// Only {UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.Progress},
/// {UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.Priority},
/// {UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.DueDate},
/// {UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.DeferDate} and
/// {UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.SpecificContent}
/// will be updated from given queueItemDto object.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='id'>
/// key: Id
/// </param>
/// <param name='queueItemDto'>
/// The entity to put
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task <object> PutByIdAsync(this IQueueItems operations, long id, QueueItemDataDto queueItemDto, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
using (var _result = await operations.PutByIdWithHttpMessagesAsync(id, queueItemDto, null, cancellationToken).ConfigureAwait(false))
{
return(_result.Body);
}
}
/// <summary>
/// Sets the given queue items' status to Deleted.
/// </summary>
/// <remarks>
/// Required permissions: Queues.View and Transactions.Delete.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='deleteBulkParameters'>
/// QueueItems - The collection of ids of queue items to delete.
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task <BulkOperationResponseDtoInt64> DeleteBulkAsync(this IQueueItems operations, DeleteBulkParameters deleteBulkParameters = default(DeleteBulkParameters), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
using (var _result = await operations.DeleteBulkWithHttpMessagesAsync(deleteBulkParameters, null, cancellationToken).ConfigureAwait(false))
{
return(_result.Body);
}
}
/// <summary>
/// Returns a collection of users having the permission for Queue Items review.
/// Allows odata query options.
/// </summary>
/// <remarks>
/// Required permissions: Queues.View and Transactions.Edit.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task <ODataResponseListUserDto> GetReviewersAsync(this IQueueItems operations, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
using (var _result = await operations.GetReviewersWithHttpMessagesAsync(null, cancellationToken).ConfigureAwait(false))
{
return(_result.Body);
}
}
/// <summary>
/// Returns the last retry of a queue item.
/// </summary>
/// <remarks>
/// Client Credentials Flow required permissions: Queues or Queues.Read.
///
/// Required permissions: Queues.View and Transactions.View.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='key'>
/// </param>
/// <param name='expand'>
/// Indicates the related entities to be represented inline. The maximum depth
/// is 2.
/// </param>
/// <param name='filter'>
/// Restricts the set of items returned. The maximum number of expressions is
/// 100.
/// </param>
/// <param name='select'>
/// Limits the properties returned in the result.
/// </param>
/// <param name='orderby'>
/// Specifies the order in which items are returned. The maximum number of
/// expressions is 5.
/// </param>
/// <param name='top'>
/// Limits the number of items returned from a collection. The maximum value is
/// 1000.
/// </param>
/// <param name='skip'>
/// Excludes the specified number of items of the queried collection from the
/// result.
/// </param>
/// <param name='count'>
/// Indicates whether the total count of items within a collection are returned
/// in the result.
/// </param>
/// <param name='xUIPATHOrganizationUnitId'>
/// Folder/OrganizationUnit Id
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task <QueueItemDto> GetItemLastRetryByIdAsync(this IQueueItems operations, long key, string expand = default(string), string filter = default(string), string select = default(string), string orderby = default(string), int?top = default(int?), int?skip = default(int?), bool?count = default(bool?), long?xUIPATHOrganizationUnitId = default(long?), CancellationToken cancellationToken = default(CancellationToken))
{
using (var _result = await operations.GetItemLastRetryByIdWithHttpMessagesAsync(key, expand, filter, select, orderby, top, skip, count, xUIPATHOrganizationUnitId, null, cancellationToken).ConfigureAwait(false))
{
return(_result.Body);
}
}
/// <summary>
/// Updates the QueueItem properties with the new values provided.
/// </summary>
/// <remarks>
/// Client Credentials Flow required permissions: Queues or Queues.Write.
///
/// Required permissions: Queues.Edit and Transactions.Edit.
///
/// Only UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.Progress,
/// UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.Priority,
/// UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.DueDate,
/// UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.DeferDate and
/// UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.SpecificContent
/// will be updated from given queueItemDto object.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='key'>
/// </param>
/// <param name='body'>
/// </param>
/// <param name='xUIPATHOrganizationUnitId'>
/// Folder/OrganizationUnit Id
/// </param>
public static void PutById(this IQueueItems operations, long key, QueueItemDataDto body = default(QueueItemDataDto), long?xUIPATHOrganizationUnitId = default(long?))
{
operations.PutByIdAsync(key, body, xUIPATHOrganizationUnitId).GetAwaiter().GetResult();
}
/// <summary>
/// Deletes a queue item by Id.
/// </summary>
/// <remarks>
/// Client Credentials Flow required permissions: Queues or Queues.Write.
///
/// Required permissions: Queues.View and Transactions.Delete.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='key'>
/// </param>
/// <param name='xUIPATHOrganizationUnitId'>
/// Folder/OrganizationUnit Id
/// </param>
public static void DeleteById(this IQueueItems operations, long key, long?xUIPATHOrganizationUnitId = default(long?))
{
operations.DeleteByIdAsync(key, xUIPATHOrganizationUnitId).GetAwaiter().GetResult();
}
/// <summary>
/// Gets a collection of queue items.
/// </summary>
/// <remarks>
/// Required permissions: Queues.View and Transactions.View.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='expand'>
/// Expands related entities inline.
/// </param>
/// <param name='filter'>
/// Filters the results, based on a Boolean condition.
/// </param>
/// <param name='select'>
/// Selects which properties to include in the response.
/// </param>
/// <param name='orderby'>
/// Sorts the results.
/// </param>
/// <param name='top'>
/// Returns only the first n results.
/// </param>
/// <param name='skip'>
/// Skips the first n results.
/// </param>
/// <param name='count'>
/// Includes a count of the matching results in the response.
/// </param>
public static ODataResponseListQueueItemDto GetQueueItems(this IQueueItems operations, string expand = default(string), string filter = default(string), string select = default(string), string orderby = default(string), int?top = default(int?), int?skip = default(int?), bool?count = default(bool?))
{
return(operations.GetQueueItemsAsync(expand, filter, select, orderby, top, skip, count).GetAwaiter().GetResult());
}
/// <summary>
/// Unsets the reviewer for multiple queue items
/// </summary>
/// <remarks>
/// Required permissions: Queues.View and Transactions.Edit.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='unsetReviewerBulkParameters'>
/// <para />QueueItems - The collection of ids of queue items for which
/// the reviewer is unset.
/// </param>
public static BulkOperationResponseDtoInt64 UnsetItemReviewer(this IQueueItems operations, UnsetReviewerBulkParameters unsetReviewerBulkParameters = default(UnsetReviewerBulkParameters))
{
return(operations.UnsetItemReviewerAsync(unsetReviewerBulkParameters).GetAwaiter().GetResult());
}
/// <summary>
/// Returns data about the processing history of the given queue item. Allows
/// odata query options.
/// </summary>
/// <remarks>
/// Client Credentials Flow required permissions: Queues or Queues.Read.
///
/// Required permissions: Queues.View and Transactions.View.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='key'>
/// </param>
/// <param name='expand'>
/// Indicates the related entities to be represented inline. The maximum depth
/// is 2.
/// </param>
/// <param name='filter'>
/// Restricts the set of items returned. The maximum number of expressions is
/// 100.
/// </param>
/// <param name='select'>
/// Limits the properties returned in the result.
/// </param>
/// <param name='orderby'>
/// Specifies the order in which items are returned. The maximum number of
/// expressions is 5.
/// </param>
/// <param name='top'>
/// Limits the number of items returned from a collection. The maximum value is
/// 1000.
/// </param>
/// <param name='skip'>
/// Excludes the specified number of items of the queried collection from the
/// result.
/// </param>
/// <param name='count'>
/// Indicates whether the total count of items within a collection are returned
/// in the result.
/// </param>
/// <param name='xUIPATHOrganizationUnitId'>
/// Folder/OrganizationUnit Id
/// </param>
public static ODataValueOfIEnumerableOfQueueItemDto GetItemProcessingHistoryById(this IQueueItems operations, long key, string expand = default(string), string filter = default(string), string select = default(string), string orderby = default(string), int?top = default(int?), int?skip = default(int?), bool?count = default(bool?), long?xUIPATHOrganizationUnitId = default(long?))
{
return(operations.GetItemProcessingHistoryByIdAsync(key, expand, filter, select, orderby, top, skip, count, xUIPATHOrganizationUnitId).GetAwaiter().GetResult());
}
/// <summary>
/// Unsets the reviewer for multiple queue items
/// </summary>
/// <remarks>
/// Required permissions: Queues.View and Transactions.Edit.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='unsetReviewerBulkParameters'>
/// <para />QueueItems - The collection of ids of queue items for which
/// the reviewer is unset.
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task <BulkOperationResponseDtoInt64> UnsetItemReviewerAsync(this IQueueItems operations, UnsetReviewerBulkParameters unsetReviewerBulkParameters = default(UnsetReviewerBulkParameters), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
using (var _result = await operations.UnsetItemReviewerWithHttpMessagesAsync(unsetReviewerBulkParameters, null, cancellationToken).ConfigureAwait(false))
{
return(_result.Body);
}
}
/// <summary>
/// Updates the progress field of a queue item with the status 'In Progress'.
/// </summary>
/// <remarks>
/// Required permissions: Queues.View and Transactions.Edit.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='id'>
/// key: Id
/// </param>
/// <param name='transactionProgressParameters'>
/// <para />QueueItemId - The item's id.
/// <para />Progress - The value for the Progress field.
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task SetTransactionProgressByIdAsync(this IQueueItems operations, long id, TransactionProgressParameters transactionProgressParameters = default(TransactionProgressParameters), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
(await operations.SetTransactionProgressByIdWithHttpMessagesAsync(id, transactionProgressParameters, null, cancellationToken).ConfigureAwait(false)).Dispose();
}
/// <summary>
/// Deletes a queue item by Id.
/// </summary>
/// <remarks>
/// Required permissions: Queues.View and Transactions.Delete.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='id'>
/// key: Id
/// </param>
/// <param name='ifMatch'>
/// If-Match header
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task DeleteByIdAsync(this IQueueItems operations, long id, string ifMatch = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
(await operations.DeleteByIdWithHttpMessagesAsync(id, ifMatch, null, cancellationToken).ConfigureAwait(false)).Dispose();
}
/// <summary>
/// Returns a collection of users having the permission for Queue Items review.
/// Allows odata query options.
/// </summary>
/// <remarks>
/// Required permissions: Queues.View and Transactions.Edit.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
public static ODataResponseListUserDto GetReviewers(this IQueueItems operations)
{
return(operations.GetReviewersAsync().GetAwaiter().GetResult());
}
/// <summary>
/// Updates the QueueItem properties with the new values provided.
/// </summary>
/// <remarks>
/// Client Credentials Flow required permissions: Queues or Queues.Write.
///
/// Required permissions: Queues.Edit and Transactions.Edit.
///
/// Only UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.Progress,
/// UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.Priority,
/// UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.DueDate,
/// UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.DeferDate and
/// UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.SpecificContent
/// will be updated from given queueItemDto object.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='key'>
/// </param>
/// <param name='body'>
/// </param>
/// <param name='xUIPATHOrganizationUnitId'>
/// Folder/OrganizationUnit Id
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task PutByIdAsync(this IQueueItems operations, long key, QueueItemDataDto body = default(QueueItemDataDto), long?xUIPATHOrganizationUnitId = default(long?), CancellationToken cancellationToken = default(CancellationToken))
{
(await operations.PutByIdWithHttpMessagesAsync(key, body, xUIPATHOrganizationUnitId, null, cancellationToken).ConfigureAwait(false)).Dispose();
}
/// <summary>
/// Updates the progress field of a queue item with the status 'In Progress'.
/// </summary>
/// <remarks>
/// Client Credentials Flow required permissions: Queues or Queues.Write.
///
/// Required permissions: Queues.View and Transactions.Edit.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='key'>
/// </param>
/// <param name='body'>
/// <para />QueueItemId - The item's id.
/// <para />Progress - The value for the Progress field.
/// </param>
/// <param name='xUIPATHOrganizationUnitId'>
/// Folder/OrganizationUnit Id
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task SetTransactionProgressByIdAsync(this IQueueItems operations, long key, QueueItemsSetTransactionProgressParameters body = default(QueueItemsSetTransactionProgressParameters), long?xUIPATHOrganizationUnitId = default(long?), CancellationToken cancellationToken = default(CancellationToken))
{
(await operations.SetTransactionProgressByIdWithHttpMessagesAsync(key, body, xUIPATHOrganizationUnitId, null, cancellationToken).ConfigureAwait(false)).Dispose();
}
/// <summary>
/// Sets the given queue items' status to Deleted.
/// </summary>
/// <remarks>
/// Client Credentials Flow required permissions: Queues or Queues.Write.
///
/// Required permissions: Queues.View and Transactions.Delete.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='body'>
/// QueueItems - The collection of ids of queue items to delete.
/// </param>
/// <param name='expand'>
/// Indicates the related entities to be represented inline. The maximum depth
/// is 2.
/// </param>
/// <param name='select'>
/// Limits the properties returned in the result.
/// </param>
/// <param name='xUIPATHOrganizationUnitId'>
/// Folder/OrganizationUnit Id
/// </param>
public static BulkOperationResponseDtoOfInt64 DeleteBulk(this IQueueItems operations, QueueItemDeleteBulkRequest body = default(QueueItemDeleteBulkRequest), string expand = default(string), string select = default(string), long?xUIPATHOrganizationUnitId = default(long?))
{
return(operations.DeleteBulkAsync(body, expand, select, xUIPATHOrganizationUnitId).GetAwaiter().GetResult());
}
/// <summary>
/// Updates the progress field of a queue item with the status 'In Progress'.
/// </summary>
/// <remarks>
/// Client Credentials Flow required permissions: Queues or Queues.Write.
///
/// Required permissions: Queues.View and Transactions.Edit.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='key'>
/// </param>
/// <param name='body'>
/// <para />QueueItemId - The item's id.
/// <para />Progress - The value for the Progress field.
/// </param>
/// <param name='xUIPATHOrganizationUnitId'>
/// Folder/OrganizationUnit Id
/// </param>
public static void SetTransactionProgressById(this IQueueItems operations, long key, QueueItemsSetTransactionProgressParameters body = default(QueueItemsSetTransactionProgressParameters), long?xUIPATHOrganizationUnitId = default(long?))
{
operations.SetTransactionProgressByIdAsync(key, body, xUIPATHOrganizationUnitId).GetAwaiter().GetResult();
}
/// <summary>
/// Sets the reviewer for multiple queue items
/// </summary>
/// <remarks>
/// Required permissions: Queues.View and Transactions.Edit.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='setReviewerBulkParameters'>
/// <para />UserId - The ID of the user to be set as the reviewer. If not
/// set, the reviewer is cleared.
/// <para />QueueItems - The collection of ids of queue items for which
/// the reviewer is set.
/// </param>
public static BulkOperationResponseDtoInt64 SetItemReviewer(this IQueueItems operations, SetReviewerBulkParameters setReviewerBulkParameters)
{
return(operations.SetItemReviewerAsync(setReviewerBulkParameters).GetAwaiter().GetResult());
}
/// <summary>
/// Returns a collection of users having the permission for Queue Items review.
/// Allows odata query options.
/// </summary>
/// <remarks>
/// Client Credentials Flow required permissions: Queues or Queues.Read.
///
/// Required permissions: Queues.View and Transactions.Edit.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='expand'>
/// Indicates the related entities to be represented inline. The maximum depth
/// is 2.
/// </param>
/// <param name='filter'>
/// Restricts the set of items returned. The maximum number of expressions is
/// 100.
/// </param>
/// <param name='select'>
/// Limits the properties returned in the result.
/// </param>
/// <param name='orderby'>
/// Specifies the order in which items are returned. The maximum number of
/// expressions is 5.
/// </param>
/// <param name='top'>
/// Limits the number of items returned from a collection. The maximum value is
/// 1000.
/// </param>
/// <param name='skip'>
/// Excludes the specified number of items of the queried collection from the
/// result.
/// </param>
/// <param name='count'>
/// Indicates whether the total count of items within a collection are returned
/// in the result.
/// </param>
/// <param name='xUIPATHOrganizationUnitId'>
/// Folder/OrganizationUnit Id
/// </param>
public static ODataValueOfIEnumerableOfSimpleUserDto GetReviewers(this IQueueItems operations, string expand = default(string), string filter = default(string), string select = default(string), string orderby = default(string), int?top = default(int?), int?skip = default(int?), bool?count = default(bool?), long?xUIPATHOrganizationUnitId = default(long?))
{
return(operations.GetReviewersAsync(expand, filter, select, orderby, top, skip, count, xUIPATHOrganizationUnitId).GetAwaiter().GetResult());
}
/// <summary>
/// Sets the given queue items' status to Deleted.
/// </summary>
/// <remarks>
/// Required permissions: Queues.View and Transactions.Delete.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='deleteBulkParameters'>
/// QueueItems - The collection of ids of queue items to delete.
/// </param>
public static BulkOperationResponseDtoInt64 DeleteBulk(this IQueueItems operations, DeleteBulkParameters deleteBulkParameters = default(DeleteBulkParameters))
{
return(operations.DeleteBulkAsync(deleteBulkParameters).GetAwaiter().GetResult());
}
/// <summary>
/// Gets a collection of queue items.
/// </summary>
/// <remarks>
/// Client Credentials Flow required permissions: Queues or Queues.Read.
///
/// Required permissions: Queues.View and Transactions.View.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='mandatoryPermissions'>
/// If in a cross-folder scenario, these represent the additional permissions
/// required in the folders the data is retrieved from; all permissions in this
/// set must be met
/// </param>
/// <param name='atLeastOnePermissions'>
/// If in a cross-folder scenario, these represent the additional permissions
/// required in the folders the data is retrieved from; at least one permission
/// in this set must be met
/// </param>
/// <param name='expand'>
/// Indicates the related entities to be represented inline. The maximum depth
/// is 2.
/// </param>
/// <param name='filter'>
/// Restricts the set of items returned. The maximum number of expressions is
/// 100.
/// </param>
/// <param name='select'>
/// Limits the properties returned in the result.
/// </param>
/// <param name='orderby'>
/// Specifies the order in which items are returned. The maximum number of
/// expressions is 5.
/// </param>
/// <param name='top'>
/// Limits the number of items returned from a collection. The maximum value is
/// 1000.
/// </param>
/// <param name='skip'>
/// Excludes the specified number of items of the queried collection from the
/// result.
/// </param>
/// <param name='count'>
/// Indicates whether the total count of items within a collection are returned
/// in the result.
/// </param>
/// <param name='xUIPATHOrganizationUnitId'>
/// Folder/OrganizationUnit Id
/// </param>
public static ODataValueOfIEnumerableOfQueueItemDto Get(this IQueueItems operations, IList <string> mandatoryPermissions = default(IList <string>), IList <string> atLeastOnePermissions = default(IList <string>), string expand = default(string), string filter = default(string), string select = default(string), string orderby = default(string), int?top = default(int?), int?skip = default(int?), bool?count = default(bool?), long?xUIPATHOrganizationUnitId = default(long?))
{
return(operations.GetAsync(mandatoryPermissions, atLeastOnePermissions, expand, filter, select, orderby, top, skip, count, xUIPATHOrganizationUnitId).GetAwaiter().GetResult());
}
/// <summary>
/// Gets a queue item by Id.
/// </summary>
/// <remarks>
/// Client Credentials Flow required permissions: Queues or Queues.Read.
///
/// Required permissions: Queues.View and Transactions.View.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='key'>
/// </param>
/// <param name='expand'>
/// Indicates the related entities to be represented inline. The maximum depth
/// is 2.
/// </param>
/// <param name='select'>
/// Limits the properties returned in the result.
/// </param>
/// <param name='xUIPATHOrganizationUnitId'>
/// Folder/OrganizationUnit Id
/// </param>
public static QueueItemDto GetById(this IQueueItems operations, long key, string expand = default(string), string select = default(string), long?xUIPATHOrganizationUnitId = default(long?))
{
return(operations.GetByIdAsync(key, expand, select, xUIPATHOrganizationUnitId).GetAwaiter().GetResult());
}
/// <summary>
/// Unsets the reviewer for multiple queue items
/// </summary>
/// <remarks>
/// Client Credentials Flow required permissions: Queues or Queues.Write.
///
/// Required permissions: Queues.View and Transactions.Edit.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='body'>
/// <para />QueueItems - The collection of ids of queue items for which
/// the reviewer is unset.
/// </param>
/// <param name='expand'>
/// Indicates the related entities to be represented inline. The maximum depth
/// is 2.
/// </param>
/// <param name='select'>
/// Limits the properties returned in the result.
/// </param>
/// <param name='xUIPATHOrganizationUnitId'>
/// Folder/OrganizationUnit Id
/// </param>
public static BulkOperationResponseDtoOfInt64 UnsetItemReviewer(this IQueueItems operations, QueueItemsUnsetItemReviewerParameters body = default(QueueItemsUnsetItemReviewerParameters), string expand = default(string), string select = default(string), long?xUIPATHOrganizationUnitId = default(long?))
{
return(operations.UnsetItemReviewerAsync(body, expand, select, xUIPATHOrganizationUnitId).GetAwaiter().GetResult());
}
/// <summary>
/// Updates the progress field of a queue item with the status 'In Progress'.
/// </summary>
/// <remarks>
/// Required permissions: Queues.View and Transactions.Edit.
/// </remarks>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='id'>
/// key: Id
/// </param>
/// <param name='transactionProgressParameters'>
/// <para />QueueItemId - The item's id.
/// <para />Progress - The value for the Progress field.
/// </param>
public static void SetTransactionProgressById(this IQueueItems operations, long id, TransactionProgressParameters transactionProgressParameters = default(TransactionProgressParameters))
{
operations.SetTransactionProgressByIdAsync(id, transactionProgressParameters).GetAwaiter().GetResult();
}
