ArchiPro

Change who can open one of the signed-in user's ArchiPro boards, besides the people it is shared with: restricted (no one else), project (everyone on its project) or link (anyone with its link, signed in or not), with the role they get. Only someone who may change who the board is shared with can (canChangeSharing in list_my_board_collaborators). Before opening a board to anyone with its link, tell the user that anyone with the link can open it in that role, and ask them to confirm. Call it only after they confirm, with the board's title as confirmTitle. Link access takes Viewer or Commenter: no tool lets anyone with the link edit the board, and the link never lets anyone change who it is shared with. A board whose inheritsAccess is true in list_my_board_collaborators takes its access from a folder above it, and stops doing so: the people the folder is shared with lose the access it gave them, unless the board is shared with them itself. Tell the user that and ask them to confirm before changing such a board's access, then call with stopInheriting true. A board in the user's personal workspace (inPersonalWorkspace in list_my_boards) can't be opened to a project. Take the board's id and urlSegment from list_my_boards.

set_my_board_access

Clear the cover chosen for one of the signed-in user's ArchiPro boards, so the board shows the pictures of the first items on it again. Take the board's id from list_my_boards.

clear_my_board_cover

Post a comment from the signed-in user on one of their ArchiPro boards, or on an item saved to one, such as a board shared with them on a project. ArchiPro emails it, in the user's name, to the others on the project who can see the board. Before calling, show the user the comment and ask them to confirm. Call it only after they confirm. Take the id of a board or saved item from list_my_boards. ArchiPro may refuse a comment past the user's limit; say so in its words.

comment_on_board

Copy saved items from one ArchiPro board the signed-in user sees to another they can change, leaving them on the first board too. Take fromBoardId, its projectUrlSegment and each item's id from list_my_boards, and toBoardId from list_my_boards or create_my_board. The board they go to needs canEdit true; the board they come from may be any board list_my_boards lists. A copy starts with no comments or reactions. An item the board they go to already holds is copied again, so leave those out. An id that isn't one of the first board's items, or that the user can't see, is left alone, and the answer is the same whether every item was copied or none: note the itemCount of the board they go to in list_my_boards before the call, and compare it after. Returns the board the items came from.

copy_to_my_board

Create a project for the signed-in user on ArchiPro, under My Projects: a build or renovation project of their own, where they plan, save inspiration and work with professionals, not a business's case study. From what the user says they're planning, fill in the fields they've given: a title, a description in their words, the project type and scope, the stage they're at, where it is, when, and the budget. Leave out anything they haven't said rather than guess it. Confirm the details with the user before calling it. Returns the new project with its urlSegment, its projectId for create_my_board, and its page on ArchiPro. Its location is the first place ArchiPro's place finder offered for the one given: check it with the user.

create_my_project

Create a board for the signed-in user on ArchiPro, to save products, projects, professionals and articles to. Without projectId, the board goes in the user's personal workspace, under My Design Boards on ArchiPro. With the projectId of one of the user's projects, it goes in that project. The user must be able to edit the project: canEdit true in list_my_projects, or one they made with create_my_project. A board is not a project and doesn't create one. Only the user and the people it's shared with on ArchiPro can open the board, and in a project the project's owner too: the project's other members can't until it's shared with them. No tool moves a board into a project. To bring a board's items into one, create a board there, then copy them to it with copy_to_my_board, or move them with move_to_my_board to take them off the first board. Returns the board with the id that save_to_my_board takes.

create_my_board

Delete a message the signed-in user sent in one of their enquiry conversations on ArchiPro. The conversation then shows the message was deleted, without its words or files, but the professional may already have read it or had it by email. Only the user's replies can be deleted, not their original enquiry. Take the message's id from get_my_enquiry_conversation, where canDelete is true. Before calling it, quote the message to the user and ask them to confirm. It can't be undone.

delete_my_message

Delete one of the signed-in user's own projects on ArchiPro, under My Projects, not a business's case study. It disappears for them and everyone they shared it with, and the user can't restore it themselves. Only the project's owner can delete it. First read the project with get_my_project, tell the user which project it is, and ask them to confirm they want it deleted. Call it only after they confirm, with the project's title as confirmTitle.

delete_my_project

Delete one of the signed-in user's ArchiPro boards, with everything saved on it. No one can get it back. The user may delete any board list_my_boards gives canDelete true, including one someone else shared with them, which it gives owned false: deleting that deletes it for its owner and everyone it's shared with. A board the user owns can be shared with other people too. Before calling it, name the board to the user, say whose it is, and ask them to confirm. Take its id and projectId from list_my_boards.

delete_my_board

Email the signed-in user a link to ArchiPro's email preferences page, where they choose which ArchiPro marketing emails they get, such as the newsletter and the digital publications, or unsubscribe from them all. It goes to the email address they sign in to ArchiPro with. Use this when the user wants to stop or change ArchiPro's marketing emails: no tool unsubscribes them directly. Each call sends another email, so confirm with the user before calling it.

send_marketing_preferences_email

Follow a board another ArchiPro member shared by link. Following emails the board's owner that the signed-in user follows it. Take the board's link from the user, as they gave it. Only a board shared by link can be followed, and not the user's own. unfollow_board takes the board id it returns, or the same link.

follow_board

Use this only when the user asks where a professional is, such as where their showroom or office is, or for their address. When the user names a professional no earlier result gives, find them with search first, then pass the last part of their result's Link, its urlSegment. Each call that returns addresses records that the addresses were shown, in the professional's ArchiPro statistics, so don't call it just to recommend, describe or compare professionals: for that, use the location a professional's search result gives, a place they're based in or work in, when it has one. Returns the locations on the professional's ArchiPro page, for the one professional named: each location's title, type, address, suburb, city, region, country and map coordinates, with url, their page on ArchiPro, and enquiryUrl, the page with its enquiry form open. With place, returns only their locations there: placeMatched says whether any was, and otherLocations how many others they have, which a call without place lists. When none was, it returns every location. Not for finding professionals near a place: use search for that.

get_professional_locations

Read what a professional's enquiry form on ArchiPro asks, for the professional, product or project page the user wants to enquire from. Call it before send_enquiry. Returns takesEnquiries, false when the page takes none, and the form's questions: enquiryTypes to pick from, whether it asks who the user is (a homeowner, an architect or designer, or supplier or trade) or whether the project is residential or commercial, the branch to pick, the message and any other questions. form is null when the professional takes enquiries with no form: send_enquiry then needs only the message. Ask the user only what the form asks.

get_enquiry_form

Read the times a professional is free to meet the signed-in user, for the meeting the professional, product or project page books on ArchiPro, or the meetingSessionId send_enquiry returned, passed with its enquiryId. Returns the meeting's name, where it is held and a note from the professional, then each meeting length on offer, in minutes, with the dates and the times on each (24-hour, in timeZone) it can start. Book one with book_meeting, passing the same timeZone. Refused when the professional takes no bookings on ArchiPro.

get_meeting_times

Use this only when the user asks for a professional's phone number. When the user names a professional no earlier result gives, find them with search first, then pass the last part of their result's Link, its urlSegment. Each call that returns a number records that it was shown, in the professional's ArchiPro statistics, so don't call it just to recommend, describe or compare professionals. Returns the phone number on the professional's ArchiPro page, for the one professional named, with url, their page on ArchiPro, and enquiryUrl, the page with its enquiry form open. Not for finding professionals: use search for that.

get_professional_phone

Use this when the user wants more detail about one professional, project, product or article from ArchiPro's search results, such as a professional's services or a product's description. Returns its public details, with url, its page on ArchiPro, and enquiryUrl, the page with its enquiry form open. An article's enquiryUrl opens an enquiry form only when the professional behind the article takes enquiries on it, and get_details gives an article an enquiryUrl only then. The listing's website, the one its ArchiPro page links to, comes as websiteUrl when it has one: a link through ArchiPro that records the click for its professional, then opens that website. For a project with no website of its own, that is its professional's website. Without websiteUrl, Website is the same with ArchiPro's tags, except that a project's own website is in WebsiteUntracked. With photos true, it also lists up to 30 of the listing's photos, and morePhotos says whether the listing has more. Not for finding professionals, projects, products or articles: use search for that.

get_details

Read the signed-in user's own ArchiPro account: their name, email address, company, job title, website, whether they are a homeowner or a professional, and their professional category. A website saved in a form that can't be linked, such as a javascript: address, comes back as null and is named in invalidLinks, for the user to fix. Use this when the user asks about their own ArchiPro account or profile.

get_my_account

Read the signed-in user's ArchiPro email and privacy settings: whether ArchiPro emails them reminders to follow up on replies to their enquiries, whether they're signed up for the ArchiPro newsletter, and whether they've opted out of the sale or sharing of their personal information. Use this when the user asks which emails ArchiPro sends them or about their privacy settings, and before changing either. The newsletter status can take up to an hour to show a change made through the preferences email, and reads as not signed up while ArchiPro can't check it.

get_my_preferences

Read one of the signed-in user's own projects on ArchiPro, under My Projects, not a business's case study: its projectId, description, type, scope, location, stages and the current one, dates, brief, budget, inspiration boards and whether it has a photo. create_my_board takes its projectId. A budget max of null means no maximum. Take its urlSegment from list_my_projects.

get_my_project

Use this when you need the values an ArchiPro search filter accepts, such as brands, colours, materials, categories or professions, and how many results have each, before calling search with that filter. Not for finding professionals, projects, products or articles: use search for that.

get_search_filters

Give a guest the signed-in user registered for a Home Design Event under the user's own email a ticket of their own, under the guest's own email address. ArchiPro emails it to them. Use it for a guest list_my_event_tickets gives needsClaim true, with that guest's guestRegistrationId, on a registration whose guestsCanChange is true; each such guest is claimed once. Ask the user for the guest's own email address. Before calling it, tell the user the guest's name and email address and the event, and ask them to confirm.

claim_guest_ticket

Invite a guest to a Home Design Event the signed-in user registered for: ArchiPro issues the guest a ticket of their own and emails it to them. Take the registration's registrationId from list_my_event_tickets, for a registration whose guestsCanChange is true. Before calling it, tell the user the guest's name and email address and the event, and ask them to confirm. ArchiPro refuses the user's own email, a guest who already has a ticket for the event, and more guests than the event allows, and limits how many guests a user can invite in an hour and in a day.

issue_guest_ticket

Invite people by email to one of the signed-in user's ArchiPro boards, as a Viewer, Commenter or Editor. ArchiPro emails each of them an invitation from the user's account; it carries no note. Before calling, show the user the addresses and the role, and ask them to confirm. Call it only after they confirm. Someone already on the board's project joins straight away, without an invitation, in the role given, which replaces the role the board's project access gave them: a lower role takes access away, so say so to the user. When the role is not in rolesYouCanChange in list_my_board_collaborators, also tell them they can't change or remove them afterwards. Don't invite the user themselves: it can lower their own role on the board. Only someone who may change who the board is shared with can invite: canChangeSharing in list_my_board_collaborators. An address already on the board is refused: use update_my_board_collaborator to change its role. ArchiPro may refuse invitations past the user's limit; say so in its words. Take the board's id and urlSegment from list_my_boards.

invite_to_my_board

Invite people by email to one of the signed-in user's projects on ArchiPro. ArchiPro emails each of them an invitation from the user's account, with the note when there is one. Before calling, show the user the addresses, the role and the note, and ask them to confirm. Call it only after they confirm. Someone who works at a business already on the project joins straight away, without an invitation. Only the project's owner, an Admin or an Editor may invite, and only with a role below their own unless they own it: list_my_project_collaborators gives rolesYouCanGive. No tool invites anyone as an Admin: the project's owner does that on ArchiPro. An address already on the project is refused: use resend_my_project_invitation or update_my_project_collaborator for it. ArchiPro may hold an invitation for review, or refuse one past the user's limit; say so in its words.

invite_to_my_project

Take the signed-in user off a project someone else shared with them on ArchiPro. They can no longer open the project unless they're invited again. The project's owner can't leave it. First tell the user which project it is and ask them to confirm they want to leave it. Call it only after they confirm, with the project's title as confirmTitle.

leave_project

List ArchiPro's building guide: free step-by-step guides to building or renovating a home, written for New Zealand, in sections from Before the Build to Completion. Returns each section's guides with their titles and links. Use this when the user asks how to go about a stage of their build, then get_building_guide to read a guide.

list_building_guides

List the ArchiPro Home Design Evenings open for registration in the signed-in user's market, with the user's own registration for each. Use it when the user asks about Home Design Evenings or wants to register for one, and first for the eventId register_for_home_design_evening takes. canRegister is false when the event's page takes no registrations, when invitedAsGuest is true because the user is someone else's guest at the event, or when the user registered as a professional or exhibitor, which they change on the website. registration is null until the user registers. A registration is not a place at the event: ticketIssued is true once the user holds a ticket, which the organiser issues. The user's tickets are at myTicketsUrl.

list_home_design_evenings

List the Get Matched requests filed against one of the signed-in user's ArchiPro projects, newest first: each request's brief, who sent it and when, its status, and the listings ArchiPro recommended in reply. A Get Matched request asks ArchiPro to match the project with professionals. Take the project's urlSegment from list_my_projects.

list_my_project_get_matched_requests

List the signed-in user's ArchiPro boards, where they save products, projects, professionals and articles, and single photos of them (type Photo), with a few of each board's saved items. Use this when the user asks about their boards or what they have saved on ArchiPro, and for the IDs the board tools take: each board's id, urlSegment, projectId and projectUrlSegment, and each saved item's id. A board with urlSegment null can't be shared from here: the board sharing tools need it. inPersonalWorkspace true means a board is in its owner's personal workspace, which is not a project, and its projectId and projectUrlSegment name that workspace. Otherwise the board is in the project that projectTitle names. A board's access is restricted (its owner and the people they shared it with), project (everyone on the project it is in) or link (anyone with its link). A saved item's url is its own page: the listing's page on ArchiPro, or the page saved from another website. Any other item, such as a photo or an upload, has no url of its own, and opens from its board's url. owned says whether the user owns a board: one they don't was shared with them. canEdit says whether they may rename a board and change what's saved on it, and canDelete whether they may delete it: a board shared with them to view allows neither. commentCount counts the comments people left on a board or item, and each item's votes count its up and down votes, with yourVote the user's own. Each item's description is the note shown with it on the board. chosenCover says whether a member chose the board's cover; otherwise it shows its first items' pictures.

list_my_boards

List the signed-in user's ArchiPro Home Design Event tickets, and for each event they registered for, their guests and each guest's ticket. Use it when the user asks about their event tickets or guests, and first for the IDs the guest ticket tools take: issue_guest_ticket takes the registration's registrationId, and claim_guest_ticket and revoke_guest_ticket take the guest's guestRegistrationId, since a user registered for an event more than once has guests on each registration. guestsCanChange is false once the event's registration has closed: guests can't be changed then. A guest with needsClaim true was registered under the user's own email and has no ticket yet; claim_guest_ticket gives them one under their own email. guestLimit is how many guests the user may invite to the event, or null for no limit. The user's own tickets, with their QR codes, are at myTicketsUrl.

list_my_event_tickets

List the signed-in user's enquiry conversations with professionals on ArchiPro, latest first, as their inbox on the website shows them: who each is with, the listings the enquiry was about, whether it is important, archived or done, how many messages are unread, and its latest message. Also returns how many conversations have unread messages. Read one with get_my_enquiry_conversation.

list_my_enquiry_conversations

List the meeting requests the signed-in user sent to professionals on ArchiPro, newest first. Use it when the user asks about their meeting requests, and first for the meetingRequestId that move_meeting_request and cancel_meeting_request take. status is requested while the professional hasn't answered, confirmed once they accepted, and cancelled or declined once it's over; canChange is true while the user can still move or cancel it. date and time are the requested start in the request's own timeZone, and minutes is its length. timeHasPassed is true once that start has gone. Meetings booked straight into a professional's calendar aren't listed.

list_my_meeting_requests

List the signed-in user's notifications on ArchiPro, latest first: what happened (action), when, who did it, whether the user has read it, and what it is about, such as the enquiry conversation a professional replied in (conversationId, for get_my_enquiry_conversation). One about an enquiry someone else made, such as a new enquiry to a business the user is on or an invitation to help with one, says so (businessEnquiry) and names no one; the user opens those on ArchiPro. Mark them read with mark_my_notifications_read.

list_my_notifications

List the projects the signed-in user owns or has been invited to on ArchiPro, as My Projects shows them: the user's own build or renovation projects, where they plan, save inspiration and work with professionals. These are not the projects (case studies) of a business the user manages, nor the published projects that search finds. Each has a urlSegment for get_my_project, and a projectId: create_my_board takes the projectId of a project with canEdit true to create a board in it. To bring an existing board's items into a project, create a board there and copy them to it with copy_to_my_board.

list_my_projects

List the boards other ArchiPro members shared by link that the signed-in user follows, the most recently created first, with each board's owner and how many items it holds. It lists only boards shared by link in their own settings: one that has stopped being shared, or that is shared only through a folder above it, doesn't show. unfollow_board takes a board's id.

list_my_followed_boards

List the comments people left on one of the signed-in user's ArchiPro boards, or on an item saved to one, the latest 50 at most: each comment's words, who wrote it and when, whether the user wrote it, and the items it attaches. Take the id of a board or saved item from list_my_boards, where commentCount says how many it has.

list_board_comments

List the invitations other people sent the signed-in user to join their projects, boards or saved items on ArchiPro, and that the user hasn't accepted yet: what each is to and its title, who sent it and when, the role it gives and the message sent with it. Only invitations sent to the email the user signs in to ArchiPro with, while their account had it, are listed. The user accepts any other, such as one sent before this tool existed, through the invitation email's link. Accept a listed one with accept_invitation.

list_my_invitations

List the products, projects, professionals and articles the signed-in user viewed on ArchiPro in the last month, most recent first. It covers their own market's website only, such as archipro.co.nz for New Zealand. Use this when the user asks about something they looked at recently; get_details takes each listing's type and urlSegment.

list_my_recently_viewed

List who can open one of the signed-in user's ArchiPro boards: its access, its owner and the people it is shared with, each with their collaborator id and name. access is restricted (only its owner and the people it is shared with), project (everyone on the project it is in too, whom list_my_project_collaborators lists) or link (anyone with its link too), and accessRole is the role everyone on the project or anyone with the link gets. inheritsAccess means the board takes its access from a folder above it: the people who can open it through that folder aren't listed. When the user may change who the board is shared with (canChangeSharing), it also lists invitations still pending, with each person's email, role and whether they have joined. rolesYouCanChange lists the roles of the people the user may change the role of or remove: every role for the board's owner and its project's owner, and Viewer and Commenter for an Editor. Take the board's id and urlSegment from list_my_boards.

list_my_board_collaborators

List the people one of the signed-in user's projects on ArchiPro is shared with: each collaborator's id, name, business, job title and caption, and whether they own the project or are the user. When the user may change who the project is shared with (canChangeTeam), it also lists invitations still pending, with each collaborator's email, role, whether they have joined, and whether the user invited them. Take the project's urlSegment from list_my_projects.

list_my_project_collaborators