Class ApiTokenAccessRequest

Namespace

Mailtrap.ApiTokens.Requests

Assembly

Mailtrap.Abstractions.dll

Represents an access entry to grant to an API token for a specific resource.

public sealed record ApiTokenAccessRequest : IValidatable, IEquatable<ApiTokenAccessRequest>

Inheritance

object

ApiTokenAccessRequest

Implements

IValidatable

IEquatable<ApiTokenAccessRequest>

Constructors

ApiTokenAccessRequest(ResourceType, long, AccessLevel)

Primary instance constructor.

public ApiTokenAccessRequest(ResourceType resourceType, long resourceId, AccessLevel accessLevel)

Parameters

resourceType ResourceType

Type of the resource to grant access to.

resourceId long

ID of the resource to grant access to.

accessLevel AccessLevel

Access level for the resource. Allowed values: Viewer or Admin.

Exceptions

ArgumentNullException

When resourceType is null.

ArgumentOutOfRangeException

When resourceId is less than or equal to zero, or accessLevel is not Viewer or Admin.

Properties

AccessLevel

Gets the resource access level.

[JsonPropertyName("access_level")]
[JsonPropertyOrder(3)]
public AccessLevel AccessLevel { get; }

Property Value

AccessLevel

Access level for resource. Allowed values: Viewer or Admin.

ResourceId

Gets the resource identifier.

[JsonPropertyName("resource_id")]
[JsonPropertyOrder(2)]
public long ResourceId { get; }

Property Value

long

Resource identifier.

ResourceType

Gets the resource type.

[JsonPropertyName("resource_type")]
[JsonPropertyOrder(1)]
public ResourceType ResourceType { get; }

Property Value

ResourceType

Resource type.

Methods

Validate()

Validates the current instance.

public ValidationResult Validate()

Returns

ValidationResult

Object containing validation errors, if any.