Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PayoutsController

label

PAYOUT

description

The payouts controller of the app. Handles requests about payouts that are available in the database.

This controller defines the following routes:

URI HTTP method Class method Description
/payouts GET PayoutsController.find Responds with a pageable PaginatedResultDTO that contains PayoutDTO objects.
/payouts/:address GET PayoutsController.findByUser Uses the AuthGuard to validate the required access token (Server cookie or Bearer authorization header). Responds with a pageable PaginatedResultDTO that contains PayoutDTO objects.


since

v0.3.2

Hierarchy

  • PayoutsController

Index

Constructors

Methods

Constructors

constructor

Methods

Protected find

  • Handler of the /payouts endpoint. Returns all payouts that match the request query. If the query is null or not specified, returns all documents in DTO format using PayoutDTO.

    The result of this endpoint can be paginated using query parameters: pageSize, pageNumber. Also, it can be sorted with query parameters: sort, order.

    method

    GET

    access

    protected

    async

    Parameters

    Returns Promise<PaginatedResultDTO<PayoutDTO>>

Protected findByUser

  • Requests a user's payouts entries. This endpoint is protected and a valid access token must be attached in the Authorization request header, in signed cookies or in browser cookies.

    The request is secured using the AuthGuard guard which attaches a payload to the request object.

    method

    GET

    access

    protected

    async

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

      An express request used to extract the authenticated user payload.

    • query: PayoutQuery

    Returns Promise<PaginatedResultDTO<PayoutDTO>>

    An authenticated user's received payouts.

Generated using TypeDoc