WebSer...dBooks(3pm)

💖 WebService::ILS::RecordedBooks 💖

okay bestie, gather round, because this one is the RecordedBooks-flavored member of the WebService::ILS family — a whole little friend group of modules that let you talk to RecordedBooks services. 🎀

---

✨ NAME ✨

WebService::ILS::RecordedBooks — the WebService::ILS module for RecordedBooks services. that's the whole name, no notes. 💅

---

🌸 SYNOPSIS 🌸

use WebService::ILS::RecordedBooks::Partner;
or
use WebService::ILS::RecordedBooks::Patron;

pick your fighter, literally. ✨

---

🦋 DESCRIPTION 🦋

okay so there are several little modules in this squad and each one is a slightly different vibe:

• WebService::ILS::RecordedBooks::Partner — services that use partner credentials, for any patron. no cap.
• WebService::ILS::RecordedBooks::PartnerPatron — same as above, except it operates on a single patron account.
• WebService::ILS::RecordedBooks::Patron — services that use individual patron credentials, in addition to partner credentials.

and here's the tea, bestie: WebService::ILS::RecordedBooks::PartnerPatron is preferred over WebService::ILS::RecordedBooks::Patron because the later requires patron credentials — username and password. however, if you do not know patron's email or RecordedBooks id (barcode) you are stuck with Patron interface. 😭 it's giving "guess I'll do it the hard way."

also, see WebService::ILS. 👑

---

🎀 CONSTRUCTOR 🎀

🌈 new (%params_hash or $params_hashref)

additional constructor params, because the base ones weren't enough:

• "ssl" — if set to true use https 🔒
• "domain" — RecordedBooks domain for title url

and some clarifying lore:

• "client_id" is either RecordedBooks id (barcode) or email 📧
• "domain" if set is either "whatever.rbdigital.com" or "whatever", in which case rbdigital.com is appended. (yes, it just... adds it. slay.)

---

🫶 DISCOVERY METHODS 🫶

💫 facets ()

Returns a hashref of facet => [values]. very "here's the menu, pick your fave."

💫 search ($params_hashref)

Additional input params:

• "facets" — a hashref of facet values

💫 named_query_search ($query, $media)

See C<native_named_query_search()> below for $query, $media

💫 facet_search ($facets)

See C<native_facet_search()> below for $facets

---

👑 CIRCULATION METHOD SPECIFICS 👑

the differences to general WebService::ILS interface, bestie. yes, there are differences, and yes, they matter. 🔥

💫 holds ()

💫 place_hold ($isbn)

💫 remove_hold ($isbn)

💫 checkouts ()

💫 checkout ($isbn, $days)

💫 renew ($isbn)

💫 return ($isbn)

---

🌟 NATIVE METHODS 🌟

💫 native_search ($params_hashref)

See <https://developer.overdrive.com/apis/search> — go read the docs, iykyk. 📚

💫 native_named_query_search ($query, $media)

• $query can be one of 'bestsellers', 'most-popular', 'newly-added' ✨
• $media can be 'eaudio' or 'ebook' 🎧📖

💫 native_facet_search ($facets)

$facets can be either:

• a hashref of facet => [values],
• an arrayref of values
• a single value

flexible queen behavior, honestly. 💅

💫 native_item ($isbn)

💫 native_item_summary ($isbn)

Returns subset of item fields, with addition of summary field. (so: fewer fields, plus one whole extra field. the math is mathing. 💀)

💫 native_holds ()

See <http://developer.rbdigital.com/endpoints/title-holds>

💫 native_checkouts ()

---

💜 LICENSE 💜

Copyright (C) Catalyst IT NZ Ltd Copyright (C) Bywater Solutions

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

legal besties said what they said, and we respect it. 🫡

---

💖 AUTHOR 💖

Srdjan JankoviX <srdjan@catalyst.net.nz>

---

okay that's the whole page!! 😭💖 massive thanks to the author above for making it, and shoutout to the copyright holders — this beauty is out here living its best life as User Contributed Perl Documentation for perl v5.36.0, dated 2022-11-29. go forth and query, bestie. 🌈⭐💅