@aglyn/aglyn 1.0.0-beta.256 → 1.0.0-beta.258

package/src/lib/app-utils/docs-index.generated.js

@@ -1766,7 +1766,7 @@ export const DOCS_SECTION_INDEX = [
         title: 'Element catalog',
         heading: 'Forms',
         anchor: '#forms',
-        text: 'Forms and their fields, covered in full with the feature they belong to — see Forms.\nA Form holds the fields and sends them. Each field is built from separate elements, so every piece can be selected and styled with the Styles panel on its own:\n| Element | What it\'s for |\n| Form Control | One field\'s frame: holds its Form Label, input and Helper Text. |\n| Form Label | The words naming a field, above its input. |\n| Input | A box to type in — Text, Email, Phone, Link or Number, one line or several. |\n| Helper Text | A line of guidance under a field. |\n| Select / Select Option | A dropdown and its choices. |\n| Checkbox | A tick box. Several sharing one Field name are one multi-choice question. |\n| Radio Group / Radio | A set of choices of which one may be picked. |\n| Choice Label | The words beside a Checkbox or Radio placed inside it. |\n| Rating | Stars a visitor picks. |\nThe group\'s presets put these together: Text field, Email field, Message field, Dropdown field, Radio choice field, Checkbox, Rating field and Helper Text, plus Contact Form, Contact Section and Marketing consent. Every setting is described under Field types; to design the button yourself, see Style a field.'
+        text: 'Forms and their fields, covered in full with the feature they belong to — see Forms.\nA Form holds the fields and sends them. Each field is built from separate elements, so every piece can be selected and styled with the Styles panel on its own:\n| Element | What it\'s for |\n| Form Control | One field\'s frame: holds its Form Label, input and Helper Text. |\n| Form Label | The words naming a field, above its input. |\n| Input | A box to type in — Text, Email, Phone, Link or Number, one line or several. |\n| Helper Text | A line of guidance under a field. |\n| Select / Select Option | A dropdown and its choices. |\n| Checkbox | A tick box. Several sharing one Field name are one multi-choice question. |\n| Radio Group / Radio | A set of choices of which one may be picked. |\n| Choice Label | The words beside a Checkbox or Radio placed inside it. |\n| Rating | Stars a visitor picks. |\n| Date Picker / Time Picker | A date picked from a calendar, or a time picked from a clock. |\nThe group\'s presets put these together: Text field, Email field, Message field, Dropdown field, Radio choice field, Checkbox, Rating field, Date field, Time field and Helper Text, plus Contact Form, Contact Section and Marketing consent. Every setting is described under Field types; to design the button yourself, see Style a field.'
     },
     {
         path: '/building-sites/besigner/element-catalog',
@@ -4575,6 +4575,69 @@ export const DOCS_SECTION_INDEX = [
         anchor: '#activity',
         text: 'Each connected network has an activity list on the card: orders sent, parcels shipped, cancellations, stock syncs and errors, newest first.\nIf a network stops accepting the connection, for example after you remove Aglyn\'s access there, the card asks you to Connect again. Orders paid in the meantime wait and are sent once you reconnect.\nDisconnect stops sending orders and removes the stored access. Orders the network already holds are left with it: check them in the network\'s own account, and ship anything it has not shipped another way.'
     },
+    {
+        path: '/commerce-and-bookings/commerce/help-desks',
+        title: 'Help desks (Gorgias, Re:amaze, Kustomer, Gladly and Richpanel)',
+        heading: '',
+        anchor: '',
+        text: 'Help desks: Gorgias, Re:amaze, Kustomer, Gladly and Richpanel\nRolling out Help desks appear in your console only once they are available on the platform you use. Until then, the site\'s Integrations page has no Help desks card, and contact form messages arrive in your Inbox as usual.\nConnect the help desk your support team already works in, and Aglyn keeps it up to date with your store. Each customer who has ordered from the site is added to the help desk with their recent orders, so an agent answering a ticket sees what that person bought, when, for how much and where the order stands, with a link to the order in your console.\nIf you choose, messages sent through the site\'s forms can also open as new tickets in the help desk, from the person who sent them.\nEach help desk uses your own account, connected with your own API credentials; Aglyn does not sell one and never asks for your password.'
+    },
+    {
+        path: '/commerce-and-bookings/commerce/help-desks',
+        title: 'Help desks (Gorgias, Re:amaze, Kustomer, Gladly and Richpanel)',
+        heading: 'Before you start',
+        anchor: '#before-you-start',
+        text: '- Role: you need to be an admin of the site to connect, change or disconnect a help desk. Editors can see the card and the sync log.\n- Verified email: verify your email address first.\n- A plan that includes your store. Help desks carry your buyers and their orders, so they come with the plans that include selling.\n- Your help desk\'s API credentials, listed for each help desk below.'
+    },
+    {
+        path: '/commerce-and-bookings/commerce/help-desks',
+        title: 'Help desks (Gorgias, Re:amaze, Kustomer, Gladly and Richpanel)',
+        heading: 'Connect a help desk',
+        anchor: '#connect',
+        text: '1. Open the site, then Setup → Integrations. The Help desks card lists each help desk on a row of its own.\n2. On your help desk\'s row, select Connect.\n3. Fill in the fields it asks for (see below), then select Check and connect. Aglyn checks the details with the help desk before keeping them, stores the key encrypted and never shows it again.\n4. The row shows Syncing. The first sync starts within 15 minutes.\nWhat each help desk asks for {#credentials}\n| Help desk | What to enter |\n| Gorgias | Your Gorgias domain (acme for acme.gorgias.com), and the username and API key Gorgias lists in its REST API settings. |\n| Re:amaze | Your Re:amaze brand (acme for acme.reamaze.io), the email you sign in with, and your API token from Settings → Developer → API Token in Re:amaze. |\n| Kustomer | An API key from Settings → Security → API Keys in Kustomer, with roles to read and write customers, custom objects and messages, and to read Klasses. Creating a key needs an administrator in Kustomer. |\n| Gladly | Your Gladly organization (acme for acme.gladly.com), and the email and API token of a Gladly user with the API User permission. |\n| Richpanel | Your API key from Settings → Integrations → API Keys, your store\'s app client ID from Settings → Connected Apps, and the support email address your Richpanel email channel receives mail at. |\nYou can type the domain, brand or organization as the whole address; Aglyn keeps only the first part.'
+    },
+    {
+        path: '/commerce-and-bookings/commerce/help-desks',
+        title: 'Help desks (Gorgias, Re:amaze, Kustomer, Gladly and Richpanel)',
+        heading: 'What your agents see',
+        anchor: '#what-agents-see',
+        text: 'Aglyn sends each person who has ordered from the site, by their email address, with their name and, when it is in international format, their phone number. People who have never ordered, such as newsletter subscribers or leads, are not sent.\nOn the first sync, Aglyn sends the site\'s paid orders from the 90 days before you connected. After that, each order is sent when it is paid, and again when it is fulfilled, delivered, refunded or canceled, so its status stays current. Test-mode orders are never sent.\nEach order carries its number, date, status, total, refunded amount, items and a link that opens it in your console.\n| Help desk | Where orders appear |\n| Gorgias | On the customer as customer data: their latest order and their 10 most recent orders. Show it in the ticket sidebar the way you show any customer data in Gorgias. |\n| Re:amaze | On the contact as customer data attributes: Last order, Last order items, Last order link and Recent orders. |\n| Kustomer | Each order as a custom object on the customer\'s timeline, updated as the order changes. Choose which custom object in Orders object (see Settings). |\n| Gladly | Each order as an activity on the customer\'s timeline, with a View order link. A new activity is added when the order\'s status changes. |\n| Richpanel | Each order in the customer\'s order history, updated as the order changes. |'
+    },
+    {
+        path: '/commerce-and-bookings/commerce/help-desks',
+        title: 'Help desks (Gorgias, Re:amaze, Kustomer, Gladly and Richpanel)',
+        heading: 'Send contact form messages as tickets',
+        anchor: '#contact-form-tickets',
+        text: 'This is off until you turn it on. On the connected help desk\'s row, turn on Send contact form messages to your help desk. From then on, each message someone submits through any of the site\'s forms opens a new ticket from its sender:\n| Help desk | What a message becomes |\n| Gorgias | A new ticket from the customer. |\n| Re:amaze | A new conversation in the Channel you choose. |\n| Kustomer | A new conversation from the customer, as an inbound email message. |\n| Gladly | A task for the customer in the Inbox you choose, due a day after the message arrives. |\n| Richpanel | A new email ticket from the customer to your support email address. |\nThe ticket\'s subject is the message\'s subject answer, or the form\'s name and the sender\'s name. Its text is the message, then the form\'s other answers, then the form\'s name and the page it was sent from.\nA few things to know:\n- The sender must give an email address. A message with no email address has nobody to reply to, so it is not sent.\n- Only new messages are sent. Messages submitted before you turned this on stay in your Inbox only.\n- Your Inbox still gets every message. Sending to a help desk is in addition to the Inbox, not instead of it.'
+    },
+    {
+        path: '/commerce-and-bookings/commerce/help-desks',
+        title: 'Help desks (Gorgias, Re:amaze, Kustomer, Gladly and Richpanel)',
+        heading: 'Settings',
+        anchor: '#settings',
+        text: 'Each connected help desk\'s row has:\n- Channel (Re:amaze), Inbox (Gladly) or Orders object (Kustomer): where contact form messages or orders go. The menu lists what your help desk has; if it is empty, add one in your help desk, then connect again. Until you choose, the row says what it is waiting for.\n- Send buyers and their orders, on by default.\n- Send contact form messages to your help desk, off by default.\n- Pause and Resume, which stop and restart everything for this help desk. While paused, nothing new is queued for it.'
+    },
+    {
+        path: '/commerce-and-bookings/commerce/help-desks',
+        title: 'Help desks (Gorgias, Re:amaze, Kustomer, Gladly and Richpanel)',
+        heading: 'The sync log',
+        anchor: '#sync-log',
+        text: 'Aglyn syncs every 15 minutes. Sync now runs it at once; anything left over continues in the background. Sync log lists recent runs, what each sent, and anything the help desk refused, newest first.\nWhen something goes wrong, the row says so:\n- Connect again: the help desk no longer accepts the details you entered. Select Connect again and enter them fresh.\n- Stopped: the sync failed many times in a row. Fix what the message describes, then select Sync now.\n- An order or message the help desk refuses is tried again for a while, then listed in the sync log as Not sent, and the rest carry on.'
+    },
+    {
+        path: '/commerce-and-bookings/commerce/help-desks',
+        title: 'Help desks (Gorgias, Re:amaze, Kustomer, Gladly and Richpanel)',
+        heading: 'Disconnect',
+        anchor: '#disconnect',
+        text: 'Select Disconnect on the help desk\'s row and confirm. Nothing more is sent to it, and the stored key, the sync log and any orders or messages not yet sent are deleted. Customers, orders and tickets already in your help desk stay there.\nTo stop it for one site without disconnecting, turn off Help desks for that site in its plugin settings.'
+    },
+    {
+        path: '/commerce-and-bookings/commerce/help-desks',
+        title: 'Help desks (Gorgias, Re:amaze, Kustomer, Gladly and Richpanel)',
+        heading: 'Related',
+        anchor: '#related',
+        text: '- Orders and returns\n- Forms\n- Email platforms'
+    },
     {
         path: '/commerce-and-bookings/commerce/inventory-and-erp-sync',
         title: 'Inventory and ERP sync (Cin7 Core, inFlow, Brightpearl, Ordoro)',
@@ -7422,7 +7485,7 @@ export const DOCS_SECTION_INDEX = [
         title: 'Forms & Lead Capture',
         heading: 'Field types',
         anchor: '#field-types',
-        text: 'A field is not one element but a few, each one you can select, move and style on its own. The picker\'s presets put them together for you; the table lists every piece, all in the element picker\'s Forms group:\n| Element | What it is | Its settings |\n| Form Control | One field\'s frame. It holds the field\'s label, its input and any help text, and ties the label to the input. | Full width?, Required? (adds an asterisk to the label) |\n| Form Label | The words that name a field, above its input. | Text |\n| Input | A box a visitor types in. | Field name, Maps to schema field, Type (Text, Email, Phone, Link or Number), Placeholder, Required?, Several lines? (a message box instead of one line), Full width?, Accessible label |\n| Helper Text | A line of guidance under a field. | Text |\n| Select | A dropdown. It holds Select Options; a visitor picks one. | Field name, Maps to schema field, Placeholder, Required?, Full width?, Accessible label |\n| Select Option | One choice in a Select. | Text, Value (what is sent; left empty, the Text is sent) |\n| Checkbox | A tick box. | Field name, Maps to schema field, Value (what a tick sends, such as Yes), Required? |\n| Radio Group | A set of Radios; a visitor picks one. | Field name, Maps to schema field, In a row? |\n| Radio | One choice in a Radio Group. | Value, Required? |\n| Choice Label | The words beside a Checkbox or Radio placed inside it. Clicking the words ticks the box. | Text |\n| Rating | Stars a visitor picks. | Field name, Maps to schema field, Stars (how many to show) |\nWhat each one sends:\n| Element | Submitted value |\n| Input | What the visitor typed |\n| Select | The chosen option\'s Value (or its Text) |\n| Radio Group | The chosen Radio\'s Value |\n| Checkbox | Its Value when ticked, nothing when not |\n| Rating | The number of st'
+        text: 'A field is not one element but a few, each one you can select, move and style on its own. The picker\'s presets put them together for you; the table lists every piece, all in the element picker\'s Forms group:\n| Element | What it is | Its settings |\n| Form Control | One field\'s frame. It holds the field\'s label, its input and any help text, and ties the label to the input. | Full width?, Required? (adds an asterisk to the label) |\n| Form Label | The words that name a field, above its input. | Text |\n| Input | A box a visitor types in. | Field name, Maps to schema field, Type (Text, Email, Phone, Link or Number), Placeholder, Required?, Several lines? (a message box instead of one line), Full width?, Accessible label |\n| Helper Text | A line of guidance under a field. | Text |\n| Select | A dropdown. It holds Select Options; a visitor picks one. | Field name, Maps to schema field, Placeholder, Required?, Full width?, Accessible label |\n| Select Option | One choice in a Select. | Text, Value (what is sent; left empty, the Text is sent) |\n| Checkbox | A tick box. | Field name, Maps to schema field, Value (what a tick sends, such as Yes), Required? |\n| Radio Group | A set of Radios; a visitor picks one. | Field name, Maps to schema field, In a row? |\n| Radio | One choice in a Radio Group. | Value, Required? |\n| Choice Label | The words beside a Checkbox or Radio placed inside it. Clicking the words ticks the box. | Text |\n| Rating | Stars a visitor picks. | Field name, Maps to schema field, Stars (how many to show) |\n| Date Picker | A date a visitor picks from a calendar, or types. | Field name, Maps to schema field, Required?, No past dates?, No future dates?, Earliest date, Latest date, Start on today?, Size, Full width?, Accessible label |\n| Time Picker | A time of day a vi'
     },
     {
         path: '/content-and-data/forms/overview',