auction.fish

Add a place where an auction's lots are collected. Auction admins only. An auction cannot be listed publicly until it has one, so this is often the missing piece when promoting an auction is refused. Examples: “add a pickup location at the club on Saturday”; “we're mailing lots this year”.

add_pickup_location

Add one option to an auction's custom random field — a value each lot is given at random when it is added (A/B test groups, or which table a lot goes on), shown on the lot and its label. Nobody picks or edits it. Auction admins only. The field stays switched off until it has a name and at least two options; switching it on deals every lot already there. Examples: “add 'Table 3' to the random tables”; “add a B group to the random field”.

add_random_option

Add a species to the list that genuinely isn't on it. For anyone who runs an auction. Try set_lot_species first and name_a_species second — the list is imported and has 36,000 fish in it. Three shapes: an ordinary species is a scientific name; a strain like 'Blue Dream' is a variety plus the species it is a strain of; a hybrid like 'Tibee' has no scientific name at all, so send hybrid=true and put the trade's name in variety. What somebody who isn't a site admin adds is suggested on their own lots and their club's until a site admin approves it for everyone. Examples: “add Ancistrus sp. L046 to the species list”; “add a hybrid called tibee”.

add_species

Reply to a question somebody has asked on one of the user's own lots. The reply is public on the lot's page, the same as typing it into the chat box there. Use my_messages first to see what was asked and on which lot. Only works on lots the user is selling. Examples: “tell them yes, they're captive bred”; “reply to the question on lot 42”.

answer_question

Get the running totals for an auction: how many lots there are, how many have sold, how many are still unsold, how many people have signed up and checked in, how long is left before it closes, and — for its admins — the gross, the median price and how many invoices are still unpaid. This is what answers 'how's it going?', 'how many have sold?', 'what's the gross?', 'how long is left?' and 'how many people are here?'.

auction_numbers

List every auction the user is in — their clubs' own auctions included, at any distance and whether or not it is publicly listed — plus upcoming ones near them that they have not joined. This is the ONLY way to reach an auction they aren't already part of, so it is the right answer for 'is there an auction near me?', 'what's coming up?', 'what have I got on?', 'when's the next in-person one?'.

auctions_near_me

Give a club member breeder award points (BAP, and HAP or CAP where the club runs them separately). Club BAP admins only. 'give bob 10 points for the corydoras', '5 hap points for jane'. To explain how points are earned, use describe_club instead. Examples: “give bob 10 points for the corydoras”; “5 hap points for jane”.

award_points

Cancel a request for help and withdraw the notification that went out with it. Auction admins only. Examples: “we don't need the table carriers any more”.

cancel_volunteer_request

Change this user's own email address. It does NOT take effect straight away: a confirmation link is sent to the new address and the change happens when they open it, so tell them to go and click it. Their mail keeps going to the old address until then. This is not their username, which is update_username. Examples: “change my email to [email protected]”; “I've got a new email address”.

change_email

Check a participant in to an in-person auction so they can bid. For auction admins and club staff only. Examples: “check in bob”; “check in bidder 22”.

check_in

This club's own REST API, for writing an integration against it: which API keys exist, what each one is allowed to do, and the endpoint documentation with worked examples. Pass topic=members, points, species or auctions for the endpoints of that half — the whole thing does not fit in one answer. Read-only, and it cannot read a key's secret, which is shown once when the key is made and stored only as a hash. Nor can it create a key: it names the tick boxes and links to the page where a person makes one. Call it before writing any code against this site. If what the club wants is its events, its auction or its leaderboard on its own website, look at club_website_snippets first — those are embeds and need no key at all. Examples: “what API keys do we have?”; “write me something that posts our lots to our website”; “how do I add BAP points from our Google form?”; “can our WordPress plugin read the member list?”.

club_api

Read and search a club's change log — who did what to the club and when, newest first, and searchable back through the whole of it. Club staff only. This is the club-side half of recent_changes, and it holds what outlives any one auction: renewals and dues, members added, edited and merged, settings changed, breeder award points, announcements sent and retracted. It answers 'when did Bob last pay for his membership?', 'who changed the meeting night?' and 'did that announcement actually go out?'.

club_history

Get a club's own numbers: how many members it has, how many are paid up, how many lapse soon, and — for its treasurers — the book balance. This answers 'how many members do we have?', 'how many renewed?', 'what's our balance?'. Club staff only.

club_numbers

What this site can do to help run a club, and which of it this club is already using. This is the answer to 'what can this site do for my club' and to 'is there anything we're not using' — pass show='unused' for the second, which is the more useful of the two. Each row says what the feature is for and how to switch it on. Read-only. Examples: “what can this site do to help run my club?”; “is there anything this site does that we're not using?”.

club_setup

What a club can put on its OWN website: embeds for its events, past events, current auction, latest announcement and breeder award leaderboard, plus a calendar members can subscribe to. Each says whether it would show anything right now, and comes with the one-line script tag to paste. Read-only. Examples: “what can we put on our club website?”; “how do I show our events on our own site?”.

club_website_snippets

Find fish clubs near the user. This answers 'is there a fish club near me?', 'what clubs are around here?', 'who should I join?'.

clubs_near_me

Email one donation vendor a message you wrote, and record it against them. The site adds the club's postal address, the unsubscribe link and a reply address that brings their answer back onto their row. A club set up to send its own donation mail gets the message filed to copy out instead of sent. Counts against the club's daily donation-email allowance, which every donation read reports. Club donation staff only. Examples: “ask the corner pet shop for a raffle donation”; “reply to fishy business about the gift card”.

contact_donation_vendor

Create a new auction by copying one this person has already run — next year's version of last year's auction. Every fee, rule, custom field and pickup location comes from the auction it copies; only the name and the start date are new. This is what 'set up the spring auction', 'create next month's auction' and 'make a copy of last year's auction for March 14th' mean. It cannot create a first auction from nothing — the answer says so and links to the page that can. The new auction is NOT listed publicly until it is promoted (update_auction_setting), and its dates are worth checking. Examples: “set up next year's spring auction for April 17th”; “copy last year's auction to March 14 2027”.

create_auction

Get the full details of an auction: its dates, whether lot submission is open, its pickup locations, its fees and settings, and the full text of its rules. Use this to ANSWER questions about how an auction works — what the rules say, when things close, how much the club takes, how many lots there are.

describe_auction

Get the full details of a club: what it is, what membership costs, and exactly how its breeder award (BAP/HAP/CAP) points are awarded, including the per-category overrides. Every point setting comes back with an explanation of what it does, so use this to ANSWER 'how do I earn points', not to guess.

describe_club

Read one donation vendor: their status, their contact, what the club knows about them, and the emails to and from them with the newest first. This is what their last message actually said, which list_donation_vendors only summarizes in a line. It also returns the club's own donation details — its standing description, its postal address, and whether this site sends the mail or the club copies it out. Club donation staff only.

describe_donation_vendor

Get the full details of one lot: its description, category, prices, whether it sold and for how much. Use this to answer questions about a specific lot.

describe_lot

Get everything about one participant in an auction: their bidder number, whether they've checked in, how many lots they brought, won and sold, and their invoice status. Auction admins only.

describe_person

Pick a door prize winner at random from the people who have checked in and haven't already won one. For auction admins and club staff. 'draw a door prize', 'pick a winner', 'who wins the door prize?'. Examples: “draw a door prize”; “pick a door prize winner”.

draw_door_prize

Change a lot that has already been added: its name, quantity, minimum bid, buy now price, whether it's a donation, its description, this auction's own custom fields, or a reference link. The seller or an auction admin only. This is what 'make lot 14 twenty dollars', 'change the shrimp to 3 of them' and 'that one's a donation' mean. Photos are add_lot_image. To find out about a lot instead of changing it, use describe_lot. Examples: “make lot 14 twenty dollars”; “change the quantity on the blue shrimp to 3”.

edit_lot

Look at one person's invoice in an auction: what they owe or are owed, whether it has been settled, the extra lines on it, and a link to it. With no 'person' it is the user's own; auction admins can name anybody in the auction. 'what does bidder 14 owe?', 'show me Jane's invoice', 'what do I owe?'. Examples: “what does bidder 14 owe?”; “show me Jane's invoice”; “what do I owe?”.

find_invoice

Look up a lot by its number or name, in auctions this user is part of. Use this to turn 'the blue shrimp' into a lot number before acting on it.

find_lot

Search the list of pages when you aren't sure which destination key to use. Returns keys you can pass straight to go_to_page.

find_page

Look up a person among the club members and auction participants this user administers. Use this to turn a name into a bidder number before another action.

find_person

Open any page on the site, and return its URL. 'page' is a destination key, or the page named in plain words — find_page searches the keys and returns ones that can be passed straight back here. Between them they reach every page this site has. Use 'target' when the page is about a particular thing: an auction name, a bidder, a lot, a club. This is the right answer for anything phrased as 'take me to', 'open', 'show me' or 'where is', and it is also the correct last resort when no other action fits. Examples: “take me to my invoice”; “auction rules”; “open the treasurer report”.

go_to_page

Hide a category's lots from the user's own lot lists, or show them again. Any signed-in user. 'I don't keep saltwater, hide corals', 'show me plants again'. Examples: “hide corals”; “stop hiding plants”.

hide_category

Hide a chat message somebody posted on a lot, or put a hidden one back. Auction admins only. The message is named by a few words out of it; more than one match comes back as a question. Use describe_lot to read what is on a lot. Examples: “hide that message on lot 14”; “put the hidden message on lot 3 back”.

hide_chat_message

Sign the user up for an auction, or say whether they're already in it. This is the ONLY action that can reach an auction the user has not already joined, so use it for 'sign me up for the fall auction', 'join the spring auction', 'am I registered for this one?'. Call it once WITHOUT agree_to_rules to get that auction's rules and its pickup locations, read them to the user, and call it again with agree_to_rules=true. It only ever signs up the person asking. Examples: “sign me up for the fall auction”; “am I registered for this auction?”.

join_auction

Leave feedback on a lot, as the person who bought it or the person who sold it. Anybody, on their own lots. 'the guppies were great', 'leave positive feedback on lot 9'. Which side the caller is on is read off the lot rather than asked; somebody who neither bought nor sold it is refused. Examples: “leave positive feedback on lot 9”; “the fish arrived dead, negative feedback on lot 12”.

leave_feedback

A club's calendar: meetings, swaps, talks, and the events its auctions generate. This answers 'when's the next meeting?', 'what have we got on this autumn?' and 'what did we do in March?'. Examples: “when's the next meeting”; “what's on at the club this autumn”.

list_club_events

List a club's members by name, filtered by whether their dues are current. This is how to answer 'who has lapsed?', 'who is about to expire?', 'who renewed?' — club_numbers only counts them. The names it returns are what renew_member, update_club_member and award_points take. Club staff only.

list_club_members

List the businesses a club is asking to donate something to a raffle or charity auction, and where each conversation has got to. Most overdue first, so status='due' is the club's work queue: who hasn't replied and is owed a nudge. Also answers 'who promised us something?', 'who said no?', 'what did they say?'. Club donation staff only.

list_donation_vendors

List the lots in an auction matching one status: 'unsold' (no winner yet), 'sold', 'mine' (the user's own lots), 'donations', or 'all', optionally narrowed to a search term. This answers 'which lots haven't sold?', 'did my lots sell?', 'what's left?' and — with 'query' — 'show me the unsold daphnia'. If they want to SEE and browse lots matching a search term, use search_lots instead. Examples: “which lots haven't sold?”; “show me the remaining daphnia”; “what's left?”.

list_lots

List the people in an auction matching one status. Auction admins only. This answers 'who hasn't paid?', 'who hasn't checked in?', 'who's here?' and 'did I add anyone twice?'. To look up ONE person use describe_person instead.

list_people

Where an auction's lots are collected, and when. Anyone who can see the auction — 'where do I pick up my lots' is a bidder's question, not an admin's. Examples: “where do I pick up my lots?”; “what are the pickup locations?”.

list_pickup_locations