SudoSOS Back-end API / payout-requests / PayoutRequestService

Class: PayoutRequestService

Constructors

Constructor

new PayoutRequestService(): PayoutRequestService;

Returns

PayoutRequestService

Methods

asBasePayoutRequestResponse()

static asBasePayoutRequestResponse(req): BasePayoutRequestResponse;

Parameters

Parameter	Type
req	PayoutRequest

Returns

BasePayoutRequestResponse

---

asPayoutRequestResponse()

static asPayoutRequestResponse(req): PayoutRequestResponse;

Parameters

Parameter	Type
req	PayoutRequest

Returns

PayoutRequestResponse

---

canUpdateStatus()

static canUpdateStatus(id, state): Promise<void>;

Verify that the status of the payout request with given id can be changed to the given state

Parameters

Parameter	Type	Description
id	number	-
state	PayoutRequestState	-

Returns

Promise<void>

Throws

Error with message what precondition has failed

---

createPayoutRequest()

static createPayoutRequest(payoutRequestRequest, requestedBy): Promise<PayoutRequest>;

Create a new payout request

Parameters

Parameter	Type	Description
payoutRequestRequest	PayoutRequestRequest	-
requestedBy	User	-

Returns

Promise<PayoutRequest>

the created payout request entity

---

getOptions()

static getOptions(params): Promise<FindManyOptions<PayoutRequest>>;

Parameters

Parameter	Type
params	PayoutRequestFilters

Returns

Promise<FindManyOptions<PayoutRequest>>

---

getPayoutRequests()

static getPayoutRequests(filters, pagination?): Promise<[PayoutRequest[], number]>;

Get all payout requests with the given filters

Parameters

Parameter	Type	Description
filters	PayoutRequestFilters	-
pagination	PaginationParameters	-

Returns

Promise<[PayoutRequest[], number]>

payout requests and total count

---

getSinglePayoutRequest()

static getSinglePayoutRequest(id): Promise<PayoutRequest>;

Get single payout request

Parameters

Parameter	Type	Description
id	number	-

Returns

Promise<PayoutRequest>

the payout request entity or undefined if not found

---

stateSubQuery()

static stateSubQuery(): string;

Returns

string

---

updateStatus()

static updateStatus(
   id, 
   state, 
user): Promise<PayoutRequest>;

Change the status of the payout request.

Parameters

Parameter	Type	Description
id	number	ID of payout request
state	PayoutRequestState	State to change payout request to
user	User	User who performs the update

Returns

Promise<PayoutRequest>

the updated payout request entity, or undefined if not found