Class RAiDService

Namespace

RAiD.Net

Assembly

RAiD.Net.dll

public class RAiDService : IRAiDService

Inheritance

object

RAiDService

Implements

IRAiDService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

RAiDService(HttpClient, IOptions<RAiDServiceOptions>, ILogger<RAiDService>)

public RAiDService(HttpClient httpClient, IOptions<RAiDServiceOptions> options, ILogger<RAiDService> logger)

Parameters

httpClient HttpClient

options IOptions<RAiDServiceOptions>

logger ILogger<RAiDService>

Methods

CreateServicePointAsync(RAiDServicePointCreateRequest)

POST /service-point/ Creates a new ServicePoint.

public Task<RAiDServicePoint?> CreateServicePointAsync(RAiDServicePointCreateRequest createRequest)

Parameters

createRequest RAiDServicePointCreateRequest

Returns

Task<RAiDServicePoint>

FindAllPublicRaidsAsync()

GET /raid/all-public List all public RAiDs.

public Task<List<RAiDDto>?> FindAllPublicRaidsAsync()

Returns

Task<List<RAiDDto>>

FindAllRaidsAsync(IEnumerable<string>?, string?, string?)

GET /raid/ List RAiDs (with optional query params).

public Task<List<RAiDDto>?> FindAllRaidsAsync(IEnumerable<string>? includeFields = null, string? contributorId = null, string? organisationId = null)

Parameters

includeFields IEnumerable<string>

contributorId string

organisationId string

Returns

Task<List<RAiDDto>>

FindAllServicePointsAsync()

GET /service-point/ Returns all ServicePoints.

public Task<List<RAiDServicePoint>?> FindAllServicePointsAsync()

Returns

Task<List<RAiDServicePoint>>

FindAllUpgradableAsync()

GET /upgradable/all Returns a list of RAiDs that are upgradable.

public Task<List<RAiDDto>?> FindAllUpgradableAsync()

Returns

Task<List<RAiDDto>>

FindRaidByNameAndVersionAsync(string, string, int)

GET /raid/{prefix}/{suffix}/{version} Read a RAiD at a specific version number.

public Task<object?> FindRaidByNameAndVersionAsync(string prefix, string suffix, int version)

Parameters

prefix string

suffix string

version int

Returns

Task<object>

FindRaidByNameAsync(string, string)

GET /raid/{prefix}/{suffix} Read a specific RAiD by prefix/suffix.

public Task<RAiDDto?> FindRaidByNameAsync(string prefix, string suffix)

Parameters

prefix string

suffix string

Returns

Task<RAiDDto>

FindServicePointByIdAsync(long)

GET /service-point/{id} Retrieve a ServicePoint by ID.

public Task<RAiDServicePoint?> FindServicePointByIdAsync(long id)

Parameters

id long

Returns

Task<RAiDServicePoint>

GetRaidHistoryAsync(string, string)

GET /raid/{prefix}/{suffix}/history Returns JSON patch change history for the RAiD.

public Task<List<RAiDChange>?> GetRaidHistoryAsync(string prefix, string suffix)

Parameters

prefix string

suffix string

Returns

Task<List<RAiDChange>>

GetRaidPermissionsAsync(string, string)

GET /raid/{prefix}/{suffix}/permissions Retrieve RAiD permissions.

public Task<RAiDPermissionsDto?> GetRaidPermissionsAsync(string prefix, string suffix)

Parameters

prefix string

suffix string

Returns

Task<RAiDPermissionsDto>

MintRaidAsync(RAiDCreateRequest)

POST /raid/ Mint (create) a new RAiD.

public Task<RAiDDto?> MintRaidAsync(RAiDCreateRequest createRequest)

Parameters

createRequest RAiDCreateRequest

Returns

Task<RAiDDto>

PatchRaidAsync(string, string, RAiDPatchRequest)

PATCH /raid/{prefix}/{suffix} Patch a RAiD.

public Task<RAiDDto?> PatchRaidAsync(string prefix, string suffix, RAiDPatchRequest patchRequest)

Parameters

prefix string

suffix string

patchRequest RAiDPatchRequest

Returns

Task<RAiDDto>

SetBearerToken(string)

Sets the bearer token for all subsequent requests. Call this before calling other methods if authentication is required.

public void SetBearerToken(string bearerToken)

Parameters

bearerToken string

SetUsernameAndPassword(string, string)

Sets the username and password for authentication. Call this before calling other methods if authentication is required.

public Task SetUsernameAndPassword(string username, string password)

Parameters

username string

The username for authentication.

password string

The password for authentication.

Returns

Task

UpdateRaidAsync(string, string, RAiDUpdateRequest)

PUT /raid/{prefix}/{suffix} Update a RAiD.

public Task<RAiDDto?> UpdateRaidAsync(string prefix, string suffix, RAiDUpdateRequest updateRequest)

Parameters

prefix string

suffix string

updateRequest RAiDUpdateRequest

Returns

Task<RAiDDto>

UpdateServicePointAsync(long, RAiDServicePointUpdateRequest)

PUT /service-point/{id} Update a ServicePoint by ID.

public Task<RAiDServicePoint?> UpdateServicePointAsync(long id, RAiDServicePointUpdateRequest updateRequest)

Parameters

id long

updateRequest RAiDServicePointUpdateRequest

Returns

Task<RAiDServicePoint>

UpgradeRaidAsync(RAiDUpdateRequest)

POST /upgrade Upgrades a RAiD, returning the updated RAiDDto.

public Task<RAiDDto?> UpgradeRaidAsync(RAiDUpdateRequest updateRequest)

Parameters

updateRequest RAiDUpdateRequest

Returns

Task<RAiDDto>