Interface ITemplateClient

Namespace: System.Dynamic.ExpandoObject

Syntax

[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public interface ITemplateClient

Methods

CreateAsync(TemplateCreateRequest, CancellationToken)

Create template

Declaration

Task<Template> CreateAsync(TemplateCreateRequest request, CancellationToken cancellationToken = default)

Parameters

TemplateCreateRequest request TemplateCreateRequest

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<Template> Template

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

DeleteAsync(string, CancellationToken)

Delete template

Declaration

Task DeleteAsync(string id, CancellationToken cancellationToken = default)

Parameters

string id ID of template

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

GetAllAsync(CancellationToken)

Get all templates

Declaration

Task<ICollection<Template>> GetAllAsync(CancellationToken cancellationToken = default)

Parameters

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ICollection<Template>> All templates

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

GetAsync(string, CancellationToken)

Get template

Declaration

Task<Template> GetAsync(string id, CancellationToken cancellationToken = default)

Parameters

string id ID of template.

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<Template> Template

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

SearchAsync(TemplateSearchRequest, CancellationToken)

Search templates

Declaration

Task<TemplateSearchResult> SearchAsync(TemplateSearchRequest searchRequest, CancellationToken cancellationToken = default)

Parameters

TemplateSearchRequest searchRequest The template search request.

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<TemplateSearchResult> Template search result

Remarks

All matching templates are returned. No pagination is implemented.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

UpdateAsync(string, TemplateUpdateRequest, CancellationToken)

Update template

Declaration

Task<Template> UpdateAsync(string id, TemplateUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

string id ID of template.

TemplateUpdateRequest request Template

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<Template> Template

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error