Class CreditNoticeService

Implements

ICreditNoticeService

Index

Methods

getAllCreditNoticesFromProcessForPeriod getAllCreditNoticesReceivedById getCreditNoticesBetween getCreditNoticesFromProcess autoConfiguration

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
Implementation of ICreditNoticeService.getAllCreditNoticesFromProcessForPeriod
- Defined in services/credit-notices/CreditNoticeService.ts:86

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
Implementation of ICreditNoticeService.getAllCreditNoticesReceivedById
- Defined in services/credit-notices/CreditNoticeService.ts:37

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
Implementation of ICreditNoticeService.getCreditNoticesBetween
- Defined in services/credit-notices/CreditNoticeService.ts:30

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
Implementation of ICreditNoticeService.getCreditNoticesFromProcess
- Defined in services/credit-notices/CreditNoticeService.ts:58

`Static`autoConfiguration

autoConfiguration(): CreditNoticeService
Returns CreditNoticeService
- Defined in services/credit-notices/CreditNoticeService.ts:23