Interface ICreditNoticeService

Interface for credit notice service operations

interface ICreditNoticeService {
    getAllCreditNoticesFromProcessForPeriod(
        params: GetCreditNoticesForPeriodParams,
    ): Promise<CreditNotice[]>;
    getAllCreditNoticesReceivedById(
        params: GetAllCreditNoticesParams,
    ): Promise<CreditNotice[]>;
    getCreditNoticesBetween(
        fromEntityId: string,
        toEntityId: string,
    ): Promise<CreditNotice[]>;
    getCreditNoticesFromProcess(
        recipientId: string,
        tokenId: string,
        amountSent?: string,
    ): Promise<CreditNotice[]>;
}

Implemented by

CreditNoticeService

Index

Methods

getAllCreditNoticesFromProcessForPeriod getAllCreditNoticesReceivedById getCreditNoticesBetween getCreditNoticesFromProcess

Methods

getAllCreditNoticesFromProcessForPeriod

getAllCreditNoticesFromProcessForPeriod(
params: GetCreditNoticesForPeriodParams,
): Promise<CreditNotice[]>
Get all credit notices from a specific process within a date range
Parameters
- params: GetCreditNoticesForPeriodParams
  Parameters containing the token process ID and date range
Returns Promise<CreditNotice[]>
Promise resolving to array of credit notices within the specified period
- Defined in services/credit-notices/abstract/ICreditNoticeService.ts:29

getAllCreditNoticesReceivedById

getAllCreditNoticesReceivedById(
params: GetAllCreditNoticesParams,
): Promise<CreditNotice[]>
Get all credit notices received by a specific ID
Parameters
- params: GetAllCreditNoticesParams
  Parameters for retrieving credit notices
Returns Promise<CreditNotice[]>
Promise resolving to array of credit notices
- Defined in services/credit-notices/abstract/ICreditNoticeService.ts:13

getCreditNoticesBetween

getCreditNoticesBetween(
fromEntityId: string,
toEntityId: string,
): Promise<CreditNotice[]>
Get credit notices from and entity yo an entity
Parameters
- fromEntityId: string
  entity that sent the credit notice
- toEntityId: string
  entity that received the credit notice
Returns Promise<CreditNotice[]>
Promise resolving to array of credit notices
- Defined in services/credit-notices/abstract/ICreditNoticeService.ts:38

getCreditNoticesFromProcess

getCreditNoticesFromProcess(
    recipientId: string,
    tokenId: string,
    amountSent?: string,
): Promise<CreditNotice[]>
Get credit notices received by a recipient from a specific process with optional amount
Parameters
- recipientId: string
  The ID of the recipient
- tokenId: string
  The token ID to use as From-Process tag value
- OptionalamountSent: string
  Optional amount to filter by as Quantity tag
Returns Promise<CreditNotice[]>
Promise resolving to array of credit notices
- Defined in services/credit-notices/abstract/ICreditNoticeService.ts:22