foliolib.folio.api.patronBlocks.EventHandlers

class foliolib.folio.api.patronBlocks.EventHandlers(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

Event handlers API

API for consuming events

Parameters
  • tenant (str) – Tenant id

  • okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

set_feeFineBalanceChanged(feeFineBalanceChanged)

POST /automated-patron-blocks/handlers/fee-fine-balance-changed

set_itemAgedToLost(itemAgedToLost)

POST /automated-patron-blocks/handlers/item-aged-to-lost

set_itemCheckedIn(itemCheckedIn)

POST /automated-patron-blocks/handlers/item-checked-in

set_itemCheckedOut(itemCheckedOut)

POST /automated-patron-blocks/handlers/item-checked-out

set_itemClaimedReturned(itemClaimedReturned)

POST /automated-patron-blocks/handlers/item-claimed-returned

set_itemDeclaredLost(itemDeclaredLost)

POST /automated-patron-blocks/handlers/item-declared-lost

set_loanClosed(loanClosed)

POST /automated-patron-blocks/handlers/loan-closed

set_loanDueDateChanged(loanDueDateChanged)

POST /automated-patron-blocks/handlers/loan-due-date-changed

set_feeFineBalanceChanged(feeFineBalanceChanged: dict)

POST /automated-patron-blocks/handlers/fee-fine-balance-changed

Parameters

feeFineBalanceChanged (dict) – See Schema below

Raises
  • OkapiRequestError – Bad Request

  • OkapiFatalError – Server Error

  • OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

feeFineBalanceChangeds-event
set_itemAgedToLost(itemAgedToLost: dict)

POST /automated-patron-blocks/handlers/item-aged-to-lost

Parameters

itemAgedToLost (dict) – See Schema below

Raises
  • OkapiRequestError – Bad Request

  • OkapiFatalError – Server Error

  • OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

itemAgedToLosts-event
set_itemCheckedIn(itemCheckedIn: dict)

POST /automated-patron-blocks/handlers/item-checked-in

Parameters

itemCheckedIn (dict) – See Schema below

Raises
  • OkapiRequestError – Bad Request

  • OkapiFatalError – Server Error

  • OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

itemCheckedIns-event
set_itemCheckedOut(itemCheckedOut: dict)

POST /automated-patron-blocks/handlers/item-checked-out

Parameters

itemCheckedOut (dict) – See Schema below

Raises
  • OkapiRequestError – Bad Request

  • OkapiFatalError – Server Error

  • OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

itemCheckedOuts-event
set_itemClaimedReturned(itemClaimedReturned: dict)

POST /automated-patron-blocks/handlers/item-claimed-returned

Parameters

itemClaimedReturned (dict) – See Schema below

Raises
  • OkapiRequestError – Bad Request

  • OkapiFatalError – Server Error

  • OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

itemClaimedReturneds-event
set_itemDeclaredLost(itemDeclaredLost: dict)

POST /automated-patron-blocks/handlers/item-declared-lost

Parameters

itemDeclaredLost (dict) – See Schema below

Raises
  • OkapiRequestError – Bad Request

  • OkapiFatalError – Server Error

  • OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

itemDeclaredLosts-event
set_loanClosed(loanClosed: dict)

POST /automated-patron-blocks/handlers/loan-closed

Parameters

loanClosed (dict) – See Schema below

Raises
  • OkapiRequestError – Bad Request

  • OkapiFatalError – Server Error

  • OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

loanCloseds-event
set_loanDueDateChanged(loanDueDateChanged: dict)

POST /automated-patron-blocks/handlers/loan-due-date-changed

Parameters

loanDueDateChanged (dict) – See Schema below

Raises
  • OkapiRequestError – Bad Request

  • OkapiFatalError – Server Error

  • OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

loanDueDateChangeds-event