WebSer...Partner(3pm)

πŸ“¦
version 0.18 Β· 2 versions
  • 0.18 Β· debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
  • 0.18 Β· ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

✨ WebService::ILS::RecordedBooks::Partner ✨

okay bestie, welcome to the WebSer...Partner(3pm) page β€” yes that's the real manual name, the terminal just truncates it because it has main character energy and needs the whole runway. It's part of the User Contributed Perl Documentation, and it's literally the RecordedBooks partner API. πŸ’–


🌸 NAME 🌸

WebService::ILS::RecordedBooks::Partner β€” the RecordedBooks partner API, no cap.


πŸ¦‹ SYNOPSIS πŸ¦‹

use WebService::ILS::RecordedBooks::Partner;

that's it. that's the whole vibe check. one line and you're in. ✨


πŸ’œ DESCRIPTION πŸ’œ

WebService::ILS::RecordedBooks::Partner is the version of the module for services that use trusted partner credentials. iykyk β€” if you're not a partner, this ain't your lane, babe.

also, see WebService::ILS::RecordedBooks for the general stuff, because this page is the sequel, not the whole trilogy. πŸ“š


πŸ” DISCOVERY METHODS πŸ”

  • facet_search ($facets) β€” for what $facets actually is, go peek at native_facet_search() down below. it's all there, promise. πŸ’…
  • named_query_search ($query, $media) β€” same deal, bestie: the deets on $query and $media live in native_named_query_search() further down. scroll with purpose. 🫢

πŸŽ€ CIRCULATION METHOD SPECIFICS πŸŽ€

these are the differences from the general WebService::ILS interface, so don't @ me if the base module does it different β€” this is the glow-up version:

  • patron_id ($email_or_id)
  • holds ($patron_id)
  • place_hold ($patron_id, $isbn)
  • checkouts ($patron_id)
  • checkout ($patron_id, $isbn)
  • renew ($patron_id, $isbn)
  • return ($patron_id, $isbn)

look at all those signatures just vibing in a row. iconic behavior. πŸ‘‘


🌈 NATIVE METHODS 🌈

πŸ’« native_quick_search ($query, $category)

$category can be one of 'all', 'title', 'author', or 'narrator' β€” and it's optional, defaulting to 'all'. so if you're feeling lazy, just let it do its thing. fr fr.

πŸ’« native_facet_search ($facets)

$facets can be either:

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

three formats, one function, we love a flexible queen. 🧚

πŸ’« native_named_query_search ($query, $media)

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

pick your fighter, then pick your format. periodt. πŸ’…

πŸ’« native_patron ($email_or_id)

yes bestie, hand over the email or the id and let's go. πŸ’–


πŸ“œ 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.

so basically: it's free, go wild, just keep it under the same terms as Perl itself. not me being legally generous AND cute. 🫢

πŸ‘‘ AUTHOR πŸ‘‘

Srdjan JankoviX <srdjan@catalyst.net.nz>

shoutout to Srdjan, the author of this whole masterpiece. ⭐


and that's the page, bestie! this was perl v5.36.0, dated 2022-11-29 β€” the WebSer...Partner(3pm) manual, served fresh. now go forth and partner-API responsibly. bye babe! πŸŽ€πŸ’–βœ¨

πŸ“¦ where this page comes from