@aglyn/aglyn 1.23.1 → 1.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +11 -11
- package/src/lib/app-utils/activity-labels.js +4 -1
- package/src/lib/app-utils/activity-labels.js.map +1 -1
- package/src/lib/app-utils/activity-presenter.d.ts +11 -0
- package/src/lib/app-utils/activity-presenter.js +9 -0
- package/src/lib/app-utils/activity-presenter.js.map +1 -1
- package/src/lib/app-utils/activity-search.d.ts +1 -0
- package/src/lib/app-utils/activity-search.js +1 -0
- package/src/lib/app-utils/activity-search.js.map +1 -1
- package/src/lib/app-utils/agent-api-catalog.d.ts +18 -0
- package/src/lib/app-utils/agent-api-catalog.js +8 -1
- package/src/lib/app-utils/agent-api-catalog.js.map +1 -1
- package/src/lib/app-utils/binding-token-catalog.d.ts +15 -0
- package/src/lib/app-utils/binding-token-catalog.js +16 -0
- package/src/lib/app-utils/binding-token-catalog.js.map +1 -1
- package/src/lib/app-utils/business-details.d.ts +5 -0
- package/src/lib/app-utils/business-details.js +4 -0
- package/src/lib/app-utils/business-details.js.map +1 -1
- package/src/lib/app-utils/connector-discovery.d.ts +80 -0
- package/src/lib/app-utils/connector-discovery.js +107 -0
- package/src/lib/app-utils/connector-discovery.js.map +1 -0
- package/src/lib/app-utils/crm.d.ts +17 -30
- package/src/lib/app-utils/crm.js +139 -3
- package/src/lib/app-utils/crm.js.map +1 -1
- package/src/lib/app-utils/docs-help-sections.generated.js +5 -1
- package/src/lib/app-utils/docs-help-sections.generated.js.map +1 -1
- package/src/lib/app-utils/docs-help.generated.d.ts +5 -5
- package/src/lib/app-utils/docs-help.generated.js +12 -3
- package/src/lib/app-utils/docs-help.generated.js.map +1 -1
- package/src/lib/app-utils/docs-index.generated.js +149 -9
- package/src/lib/app-utils/docs-index.generated.js.map +1 -1
- package/src/lib/app-utils/entity-picker-context.d.ts +6 -0
- package/src/lib/app-utils/entity-picker-context.js.map +1 -1
- package/src/lib/app-utils/expand-repeatables.js +25 -2
- package/src/lib/app-utils/expand-repeatables.js.map +1 -1
- package/src/lib/app-utils/host-tokens.d.ts +17 -0
- package/src/lib/app-utils/host-tokens.js +18 -0
- package/src/lib/app-utils/host-tokens.js.map +1 -1
- package/src/lib/app-utils/native-app-association.d.ts +9 -5
- package/src/lib/app-utils/native-app-association.js +10 -5
- package/src/lib/app-utils/native-app-association.js.map +1 -1
- package/src/lib/app-utils/native-nav.js +1 -1
- package/src/lib/app-utils/native-nav.js.map +1 -1
- package/src/lib/app-utils/organizations.js +4 -2
- package/src/lib/app-utils/organizations.js.map +1 -1
- package/src/lib/app-utils/plan-entitlements.d.ts +227 -36
- package/src/lib/app-utils/plan-entitlements.js +335 -43
- package/src/lib/app-utils/plan-entitlements.js.map +1 -1
- package/src/lib/app-utils/plugin-release-flags.generated.js +2 -2
- package/src/lib/app-utils/plugin-release-flags.generated.js.map +1 -1
- package/src/lib/app-utils/reusable-component-keys.d.ts +9 -0
- package/src/lib/app-utils/reusable-component-keys.js +9 -0
- package/src/lib/app-utils/reusable-component-keys.js.map +1 -1
- package/src/lib/app-utils/server.d.ts +1 -0
- package/src/lib/app-utils/server.js +1 -0
- package/src/lib/app-utils/server.js.map +1 -1
- package/src/lib/app-utils/sign-in-visibility.d.ts +78 -0
- package/src/lib/app-utils/sign-in-visibility.js +79 -0
- package/src/lib/app-utils/sign-in-visibility.js.map +1 -0
- package/src/lib/app-utils/site-live-url.d.ts +4 -1
- package/src/lib/app-utils/site-live-url.js +17 -3
- package/src/lib/app-utils/site-live-url.js.map +1 -1
- package/src/lib/app-utils/usage-level.d.ts +50 -0
- package/src/lib/app-utils/usage-level.js +94 -0
- package/src/lib/app-utils/usage-level.js.map +1 -0
- package/src/lib/foundation/definitions/org-billing.types.d.ts +24 -2
- package/src/lib/foundation/definitions/org-billing.types.js.map +1 -1
- package/src/lib/plugin-manager/plugin-contact-capture.d.ts +2 -0
- package/src/lib/plugin-manager/plugin-contact-capture.js.map +1 -1
|
@@ -2643,6 +2643,27 @@ export const DOCS_SECTION_INDEX = [
|
|
|
2643
2643
|
anchor: '#related',
|
|
2644
2644
|
text: '- Copy & paste elements\n- The Besigner\n- Pages & layouts\n- Generate a reusable component with Aglyn AI'
|
|
2645
2645
|
},
|
|
2646
|
+
{
|
|
2647
|
+
path: '/building-sites/besigner/show-to-signed-in-visitors',
|
|
2648
|
+
title: 'Show to signed-in or signed-out visitors',
|
|
2649
|
+
heading: '',
|
|
2650
|
+
anchor: '',
|
|
2651
|
+
text: 'Show to signed-in or signed-out visitors\nWhen your site has accounts, some things are for members and some are for everyone else: Sign in in the header for visitors and Account once they have signed in, a "Create an account" banner only for people who have not, a "Welcome back" only for those who have.'
|
|
2652
|
+
},
|
|
2653
|
+
{
|
|
2654
|
+
path: '/building-sites/besigner/show-to-signed-in-visitors',
|
|
2655
|
+
title: 'Show to signed-in or signed-out visitors',
|
|
2656
|
+
heading: 'Choose who sees an element',
|
|
2657
|
+
anchor: '#choose-who-sees-an-element',
|
|
2658
|
+
text: '1. Select the element on the canvas.\n2. In the Attributes panel, find Show to.\n3. Pick Signed-in visitors or Signed-out visitors. Everyone is the default.\nFor a header that says "Sign in" to visitors and "Account" to members, put two buttons side by side: set the "Sign in" button to Signed-out visitors and the "Account" button to Signed-in visitors. Both can open your account page, which shows the sign-in form to anyone who is not signed in yet.'
|
|
2659
|
+
},
|
|
2660
|
+
{
|
|
2661
|
+
path: '/building-sites/besigner/show-to-signed-in-visitors',
|
|
2662
|
+
title: 'Show to signed-in or signed-out visitors',
|
|
2663
|
+
heading: 'What visitors see',
|
|
2664
|
+
anchor: '#what-visitors-see',
|
|
2665
|
+
text: 'The live site decides as the page loads, so a visitor never sees the wrong button appear and disappear. Signing in or out on the account page updates the page straight away.\nIn the Besigner every element shows, whatever its Show to, so you can select and edit both versions.\nIt hides, it does not protect Show to decides what is shown, not who may see it: the content is still in the page. For content only members may read, use a members-only page.'
|
|
2666
|
+
},
|
|
2646
2667
|
{
|
|
2647
2668
|
path: '/building-sites/besigner/text-editing',
|
|
2648
2669
|
title: 'Inline & rich text editing',
|
|
@@ -4904,6 +4925,62 @@ export const DOCS_SECTION_INDEX = [
|
|
|
4904
4925
|
anchor: '#related',
|
|
4905
4926
|
text: '- Sales channels\n- Commerce overview\n- SEO — products emit structured data and join the sitemap automatically.'
|
|
4906
4927
|
},
|
|
4928
|
+
{
|
|
4929
|
+
path: '/commerce-and-bookings/commerce/connect-quickbooks-online',
|
|
4930
|
+
title: 'Connect QuickBooks Online',
|
|
4931
|
+
heading: '',
|
|
4932
|
+
anchor: '',
|
|
4933
|
+
text: 'Connect QuickBooks Online\nConnect your QuickBooks Online company and Aglyn posts your store\'s money to it as it happens: each paid order, each refund, the Aglyn fee on each sale, and each Stripe payout to your bank. You choose the accounts; Aglyn never creates accounts in your chart.\nAccounting comes with every plan that includes selling online, at no extra cost. Connecting or changing it takes the Manage accounting permission, which organization owners and admins hold by default.'
|
|
4934
|
+
},
|
|
4935
|
+
{
|
|
4936
|
+
path: '/commerce-and-bookings/commerce/connect-quickbooks-online',
|
|
4937
|
+
title: 'Connect QuickBooks Online',
|
|
4938
|
+
heading: 'Before you start',
|
|
4939
|
+
anchor: '#before-you-start',
|
|
4940
|
+
text: 'You need:\n- A QuickBooks Online company, and a login that can approve app connections for it.\n- In that company\'s chart of accounts:\n- an income account for sales (and, if you want shipping separate, one for shipping income);\n- a bank account that stands for your Stripe balance — the Stripe clearing account. Create one named, for example, "Stripe clearing" if you do not have one;\n- an expense account for Aglyn\'s fees;\n- the bank account your Stripe payouts land in.\n- If you charge sales tax, sales tax set up in that QuickBooks company (Taxes in QuickBooks). Until it is, a US company\'s sales that carry tax wait under Needs attention, because QuickBooks would otherwise record them without their tax.'
|
|
4941
|
+
},
|
|
4942
|
+
{
|
|
4943
|
+
path: '/commerce-and-bookings/commerce/connect-quickbooks-online',
|
|
4944
|
+
title: 'Connect QuickBooks Online',
|
|
4945
|
+
heading: 'Connect',
|
|
4946
|
+
anchor: '#connect',
|
|
4947
|
+
text: '1. Open your organization, then Accounting → Connection.\n2. Select Connect QuickBooks Online. QuickBooks asks you to sign in and to choose the company to connect.\n3. Approve the connection. You come back to the Accounting page, which shows the company\'s name.\nA connection made against a QuickBooks sandbox company shows a Sandbox company label.'
|
|
4948
|
+
},
|
|
4949
|
+
{
|
|
4950
|
+
path: '/commerce-and-bookings/commerce/connect-quickbooks-online',
|
|
4951
|
+
title: 'Connect QuickBooks Online',
|
|
4952
|
+
heading: 'Choose your accounts',
|
|
4953
|
+
anchor: '#choose-your-accounts',
|
|
4954
|
+
text: 'Under Accounts and tax, pick:\n| Setting | What it is for |\n| -- | -- |\n| Sales income | Where item sales are recorded. |\n| Shipping income | Where shipping you charge is recorded. Leave it empty to use sales income. |\n| Stripe clearing account | Every sale is paid into it and every payout leaves it, so it returns to zero with each payout. |\n| Aglyn fee expense | Where the Aglyn fee on each sale is recorded. |\n| Payout bank account | The bank account Stripe pays out to. |\n| Tips | Where tips taken at the register are recorded. Leave it empty to use sales income; tips your staff are owed belong in a liability account. |\n| Cash and other payments | A bank account for money that does not go through Stripe: cash at the register, room charges, and sales on a marketplace. Needed once one of those sales arrives. |\n| Gift card liability | Where gift cards you sell are owed until they are spent. Needed once a gift card is sold or spent. |\n| Sales tax codes | The QuickBooks tax code for orders with sales tax, and for orders without. |\nThen choose how sales are posted, set a Start date, and select Save. Nothing is posted until the accounts are chosen.\nThe first time you save, Aglyn adds two service items to your QuickBooks products and services — Aglyn sales and Aglyn shipping — that post to the income accounts you chose. Sales receipts name them on each line. Choosing a tips account or a gift card liability adds Aglyn tips or Aglyn gift cards the same way.'
|
|
4955
|
+
},
|
|
4956
|
+
{
|
|
4957
|
+
path: '/commerce-and-bookings/commerce/connect-quickbooks-online',
|
|
4958
|
+
title: 'Connect QuickBooks Online',
|
|
4959
|
+
heading: 'What is posted',
|
|
4960
|
+
anchor: '#what-is-posted',
|
|
4961
|
+
text: '| In Aglyn | In QuickBooks Online |\n| -- | -- |\n| A paid order | A sales receipt: one line per item, shipping, any discount and the sales tax, deposited to the Stripe clearing account. |\n| A refund | A refund receipt paid out of the Stripe clearing account, with the tax given back in proportion. |\n| The Aglyn fee on a sale | An expense from the Stripe clearing account to the fee expense account. |\n| A Stripe payout | A transfer from the Stripe clearing account to the payout bank account. |\n| A sale paid in cash, by room charge or on a marketplace | Its sales receipt, then a transfer of that share from the Stripe clearing account to the cash and other payments account. |\nEach sales receipt\'s number is the order\'s number with a short code for the site in front of it, so two sites\' order #1042 are two receipts.\nHow each payment is posted\nEvery sale is deposited to the Stripe clearing account, so receipts read the same whatever paid them. What did not come through Stripe then moves on:\n- Card, online or at the register: stays in clearing until Stripe pays it out. Only the Aglyn fee Stripe took is posted as an expense.\n- Cash and room charges at the register, and a marketplace\'s sale: a transfer moves that share to the cash and other payments account. A marketplace collects and remits its own sales tax, so its sales post without tax.\n- A gift card spent, at the register or online: a line takes it off the gift card liability, since the card was paid for when it was sold. A gift card sold is a line on that liability too, untaxed, not a sale.\n- Store credit (rewards or referral credit): a discount on the sale.\n- A tip: its own untaxed line, to the tips account.\nA refund comes back the same way, in proportion to how the sale was paid. A sale made with Stripe in test mode is neve'
|
|
4962
|
+
},
|
|
4963
|
+
{
|
|
4964
|
+
path: '/commerce-and-bookings/commerce/connect-quickbooks-online',
|
|
4965
|
+
title: 'Connect QuickBooks Online',
|
|
4966
|
+
heading: 'Sales before you connected',
|
|
4967
|
+
anchor: '#sales-before-you-connected',
|
|
4968
|
+
text: 'Set a Start date before the day you connected, and Aglyn posts the sales, fees and refunds from that day on, a page at a time over the next while. Payouts from the start date on are posted too. Sales already posted are never posted twice.'
|
|
4969
|
+
},
|
|
4970
|
+
{
|
|
4971
|
+
path: '/commerce-and-bookings/commerce/connect-quickbooks-online',
|
|
4972
|
+
title: 'Connect QuickBooks Online',
|
|
4973
|
+
heading: 'When something does not post',
|
|
4974
|
+
anchor: '#when-something-does-not-post',
|
|
4975
|
+
text: 'Accounting → Sync activity lists everything posted, waiting or skipped. Needs attention shows what QuickBooks refused, with its reason — an account made inactive, a closed period, a currency the company does not use. Fix the cause in QuickBooks or in your account choices, then select Retry on the item, or Retry all.\nA failure on QuickBooks\' side, or its rate limit, is retried on its own, waiting longer each time, before it is listed under Needs attention.'
|
|
4976
|
+
},
|
|
4977
|
+
{
|
|
4978
|
+
path: '/commerce-and-bookings/commerce/connect-quickbooks-online',
|
|
4979
|
+
title: 'Connect QuickBooks Online',
|
|
4980
|
+
heading: 'Disconnect',
|
|
4981
|
+
anchor: '#disconnect',
|
|
4982
|
+
text: 'Select Disconnect. Aglyn revokes its access to your company at Intuit and stops posting. What was already posted stays in QuickBooks, and the sync history stays in Aglyn, so reconnecting the same company later does not post anything a second time.\nIf QuickBooks stops accepting the connection — it was disconnected from QuickBooks\' side, or left unused for over 100 days — the page shows Reconnect required. Nothing is lost: what is waiting posts once you reconnect.'
|
|
4983
|
+
},
|
|
4907
4984
|
{
|
|
4908
4985
|
path: '/commerce-and-bookings/commerce/connect-smile-io-or-yotpo',
|
|
4909
4986
|
title: 'Connect Smile.io or Yotpo Loyalty',
|
|
@@ -4939,6 +5016,69 @@ export const DOCS_SECTION_INDEX = [
|
|
|
4939
5016
|
anchor: '#disconnect',
|
|
4940
5017
|
text: 'Select Disconnect on the card and confirm. Rewards turns off. Points members earned in your Smile.io or Yotpo account stay there, each member\'s built-in points go back to exactly what they were when you connected, and store credit is unchanged. Turn Rewards on again to run the built-in program with those balances.'
|
|
4941
5018
|
},
|
|
5019
|
+
{
|
|
5020
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5021
|
+
title: 'Connect Xero',
|
|
5022
|
+
heading: '',
|
|
5023
|
+
anchor: '',
|
|
5024
|
+
text: 'Connect Xero\nConnect your Xero organization and Aglyn posts your store\'s money to it as it happens: each paid order, each refund, the Aglyn fee on each sale, and each Stripe payout to your bank. You choose the accounts; Aglyn never creates accounts in your chart.\nAccounting comes with every plan that includes selling online, at no extra cost. Connecting or changing it takes the Manage accounting permission, which organization owners and admins hold by default.'
|
|
5025
|
+
},
|
|
5026
|
+
{
|
|
5027
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5028
|
+
title: 'Connect Xero',
|
|
5029
|
+
heading: 'Before you start',
|
|
5030
|
+
anchor: '#before-you-start',
|
|
5031
|
+
text: 'You need:\n- A Xero organization, and a Xero login that can connect apps to it.\n- In its chart of accounts:\n- a revenue account for sales (and, if you want shipping separate, one for shipping);\n- a bank account that stands for your Stripe balance — the Stripe clearing account. In Xero, add a bank account named, for example, "Stripe clearing" if you do not have one;\n- an expense account for Aglyn\'s fees;\n- the bank account your Stripe payouts land in.'
|
|
5032
|
+
},
|
|
5033
|
+
{
|
|
5034
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5035
|
+
title: 'Connect Xero',
|
|
5036
|
+
heading: 'Connect',
|
|
5037
|
+
anchor: '#connect',
|
|
5038
|
+
text: '1. Open your organization, then Accounting → Connection.\n2. Select Connect Xero. Xero asks you to sign in and to allow access.\n3. If your login reaches more than one Xero organization, choose the one to use and select Use this organization.'
|
|
5039
|
+
},
|
|
5040
|
+
{
|
|
5041
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5042
|
+
title: 'Connect Xero',
|
|
5043
|
+
heading: 'Choose an organization',
|
|
5044
|
+
anchor: '#choose-an-organization',
|
|
5045
|
+
text: 'When your Xero login reaches more than one organization, the Accounting page asks which one this workspace posts to: pick it and select Use this organization.\nNothing is posted until you choose. Every paid order, refund, fee and payout of the workspace then goes to that organization.'
|
|
5046
|
+
},
|
|
5047
|
+
{
|
|
5048
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5049
|
+
title: 'Connect Xero',
|
|
5050
|
+
heading: 'Choose your accounts',
|
|
5051
|
+
anchor: '#choose-your-accounts',
|
|
5052
|
+
text: 'Under Accounts and tax, pick the Sales income, Shipping income (optional), Stripe clearing account, Aglyn fee expense and Payout bank account, and the Xero tax rate for orders with sales tax and for orders without. Then choose how sales are posted, set a Start date, and select Save. Nothing is posted until the accounts are chosen.\nThree more are asked for only when your sales need them:\n- Tips: where tips taken at the register are recorded. Left empty, sales income; tips your staff are owed belong in a liability account.\n- Cash and other payments: a bank account for money that does not go through Stripe — cash at the register, room charges, and sales on a marketplace.\n- Gift card liability: where gift cards you sell are owed until they are spent.'
|
|
5053
|
+
},
|
|
5054
|
+
{
|
|
5055
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5056
|
+
title: 'Connect Xero',
|
|
5057
|
+
heading: 'What is posted',
|
|
5058
|
+
anchor: '#what-is-posted',
|
|
5059
|
+
text: '| In Aglyn | In Xero |\n| -- | -- |\n| A paid order | An approved sales invoice — one line per item, shipping, any discount, with the order\'s own tax on each line — and a payment of the whole amount into the Stripe clearing account. |\n| A refund | An approved credit note, refunded out of the Stripe clearing account, with the tax given back in proportion. |\n| The Aglyn fee on a sale | A spend money transaction from the Stripe clearing account to the fee expense account, paid to a contact named Aglyn. |\n| A Stripe payout | A bank transfer from the Stripe clearing account to the payout bank account. |\n| A sale paid in cash, by room charge or on a marketplace | Its invoice and payment, then a bank transfer of that share from the Stripe clearing account to the cash and other payments account. |\nEach invoice\'s number is the order\'s number with a short code for the site in front of it, so two sites\' order #1042 are two invoices. A customer with an email address is filed under their own Xero contact, found by that address or added; a sale with no name or address is filed under Online customer.\nHow each payment is posted\nEvery sale is paid into the Stripe clearing account, so invoices read the same whatever paid them. What did not come through Stripe then moves on:\n- Card, online or at the register: stays in clearing until Stripe pays it out. Only the Aglyn fee Stripe took is posted.\n- Cash and room charges at the register, and a marketplace\'s sale: a bank transfer moves that share to the cash and other payments account. A marketplace collects and remits its own sales tax, so its sales post without tax.\n- A gift card spent, at the register or online: a line takes it off the gift card liability, since the card was paid for when it was sold. A gift card sold is a line on that liabil'
|
|
5060
|
+
},
|
|
5061
|
+
{
|
|
5062
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5063
|
+
title: 'Connect Xero',
|
|
5064
|
+
heading: 'Sales before you connected',
|
|
5065
|
+
anchor: '#sales-before-you-connected',
|
|
5066
|
+
text: 'Set a Start date before the day you connected, and Aglyn posts the sales, fees and refunds from that day on, a page at a time. Payouts from the start date on are posted too. Sales already posted are never posted twice.'
|
|
5067
|
+
},
|
|
5068
|
+
{
|
|
5069
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5070
|
+
title: 'Connect Xero',
|
|
5071
|
+
heading: 'When something does not post',
|
|
5072
|
+
anchor: '#when-something-does-not-post',
|
|
5073
|
+
text: 'Accounting → Sync activity lists everything posted, waiting or skipped. Needs attention shows what Xero refused, with its reason. Fix the cause in Xero or in your account choices, then select Retry on the item, or Retry all.\nXero allows an app 60 requests a minute and 5,000 a day for each organization. Aglyn paces itself under both, so a busy day\'s sales may take a little longer to appear; a request Xero turns away is retried on its own, waiting longer each time.'
|
|
5074
|
+
},
|
|
5075
|
+
{
|
|
5076
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5077
|
+
title: 'Connect Xero',
|
|
5078
|
+
heading: 'Disconnect',
|
|
5079
|
+
anchor: '#disconnect',
|
|
5080
|
+
text: 'Select Disconnect. Aglyn removes its connection to your Xero organization, revokes its access, and stops posting. What was already posted stays in Xero, and the sync history stays in Aglyn, so reconnecting the same organization later does not post anything a second time.\nIf Xero stops accepting the connection — it was disconnected from Xero\'s side, or left unused for over 60 days — the page shows Reconnect required. What is waiting posts once you reconnect.'
|
|
5081
|
+
},
|
|
4942
5082
|
{
|
|
4943
5083
|
path: '/commerce-and-bookings/commerce/couriers',
|
|
4944
5084
|
title: 'Couriers for local delivery (DoorDash Drive)',
|
|
@@ -8514,7 +8654,7 @@ export const DOCS_SECTION_INDEX = [
|
|
|
8514
8654
|
title: 'Forms & Lead Capture',
|
|
8515
8655
|
heading: 'Where submissions go',
|
|
8516
8656
|
anchor: '#where-submissions-go',
|
|
8517
|
-
text: '- Inbox — every submission is captured; open it in the console\'s mail reader dialog.\n- Datasets — bind a form to a dataset (Write to dataset on the Form element) and each submission is also appended as a record. The inbox always gets its copy, and each submission\'s own detail dialog carries chips saying where it went — including saying nothing about a dataset when the record wasn\'t created.\n- Contacts — every submission that carries an email address updates the person in the CRM at stage Lead: a new contact when the address is new, an interaction on their timeline when it is not, and a customer stays a customer. A field can also save its answer into one of your custom contact fields — pick the field under Saves to contact fields on the form\'s own page.\n- Leads — only when the form\'s CRM routing card has the lead switch on. See What makes a lead.\nThe inbox\nThe site\'s Inbox page collects everything visitors send, in three tabs — Submissions, Members & leads, and Campaigns. The Form Submissions table reads as a list of people, not of forms: From, Message, Received, and the row actions.\n- From shows the sender — a colored initials avatar and their name, with the form name as a caption underneath (the Form element\'s Form name attribute, so name your forms distinctly: "Contact", "Newsletter", "Survey"). The avatar\'s color is derived from the name, so one sender keeps one color on every machine.\n- Unread submissions are bold with a dot at the left of the row. There is no "New" chip — bold text and a chip saying New are the same fact twice. Site managers
|
|
8657
|
+
text: '- Inbox — every submission is captured; open it in the console\'s mail reader dialog.\n- Datasets — bind a form to a dataset (Write to dataset on the Form element) and each submission is also appended as a record. The inbox always gets its copy, and each submission\'s own detail dialog carries chips saying where it went — including saying nothing about a dataset when the record wasn\'t created.\n- Contacts — every submission that carries an email address updates the person in the CRM at stage Lead: a new contact when the address is new, an interaction on their timeline when it is not, and a customer stays a customer. A field can also save its answer into one of your custom contact fields — pick the field under Saves to contact fields on the form\'s own page.\n- Leads — only when the form\'s CRM routing card has the lead switch on. See What makes a lead.\nOn Free, which keeps up to 100 people for the CRM, a submission past that is still saved in the inbox and the visitor sees the normal confirmation, but no new contact or lead is made from it, now or later — see CRM records.\nThe inbox\nThe site\'s Inbox page collects everything visitors send, in three tabs — Submissions, Members & leads, and Campaigns. The Form Submissions table reads as a list of people, not of forms: From, Message, Received, and the row actions.\n- From shows the sender — a colored initials avatar and their name, with the form name as a caption underneath (the Form element\'s Form name attribute, so name your forms distinctly: "Contact", "Newsletter", "Survey"). The avatar\'s color is derived from the name, so one sender keeps one color on every machine.\n- Unread submissions are bold with a dot at the left of the row. There is no "New" chip — bold text and a chip saying New are the same fact twice. Site managers als'
|
|
8518
8658
|
},
|
|
8519
8659
|
{
|
|
8520
8660
|
path: '/content-and-data/forms/overview',
|
|
@@ -10964,7 +11104,7 @@ export const DOCS_SECTION_INDEX = [
|
|
|
10964
11104
|
title: 'Datasets & schema deep-dive',
|
|
10965
11105
|
heading: 'The typed model',
|
|
10966
11106
|
anchor: '#the-typed-model',
|
|
10967
|
-
text: 'A dataset\'s model is a map of field definitions plus a display order. Each field definition carries its type, whether it\'s Required, an optional Description and Default value, validation (regex pattern, min/max length, an enum of Options), and — for reference fields — the target dataset and delete behavior.\nThe types you can author:\n| Type | Holds |\n| Text | Strings; optionally pattern-, length-, or enum-constrained |\n| Boolean | true / false |\n| Integer | Whole numbers |\n| Number | Floating-point numbers |\n| Date & time | Timestamps |\n| Coordinates | Latitude / longitude pairs |\n| List | Ordered arrays |\n| Reference | A link to a record in another dataset — see relations |\n| Page address | A record\'s own segment of its page\'s address, filled in from a text field — see page address fields |\nPlugins can register custom field types, which appear in the type picker suffixed with the plugin id. The console, imports, site restores and the REST API validate records against the model. Form submissions and the automation dataset steps do not: they store each value as text.\nLegacy datasets Datasets created before typed models (a flat comma-separated field list) still work: the runtime derives an effective model where every column is an optional text field whose id equals the column name. Open the schema dialog and re-type the fields to upgrade — ids are preserved.\nReference fields configure what happens when a referenced document is deleted: Clear the reference (default) or Block the delete. Tick Allow multiple for many-to-many relations.'
|
|
11107
|
+
text: 'A dataset\'s model is a map of field definitions plus a display order. Each field definition carries its type, whether it\'s Required, an optional Description and Default value, validation (regex pattern, min/max length, an enum of Options), and — for reference fields — the target dataset and delete behavior.\nThe types you can author:\n| Type | Holds |\n| Text | Strings; optionally pattern-, length-, or enum-constrained |\n| Boolean | true / false |\n| Integer | Whole numbers |\n| Number | Floating-point numbers |\n| Date & time | Timestamps |\n| Coordinates | Latitude / longitude pairs |\n| List | Ordered arrays |\n| Reference | A link to a record in another dataset — see relations |\n| Page address | A record\'s own segment of its page\'s address, filled in from a text field — see page address fields |\n| Icon | An icon from the library, which an Icon element in a repeat shows — see icon fields |\nPlugins can register custom field types, which appear in the type picker suffixed with the plugin id. The console, imports, site restores and the REST API validate records against the model. Form submissions and the automation dataset steps do not: they store each value as text.\nLegacy datasets Datasets created before typed models (a flat comma-separated field list) still work: the runtime derives an effective model where every column is an optional text field whose id equals the column name. Open the schema dialog and re-type the fields to upgrade — ids are preserved.\nReference fields configure what happens when a referenced document is deleted: Clear the reference (default) or Block the delete. Tick Allow multiple for many-to-many relations.'
|
|
10968
11108
|
},
|
|
10969
11109
|
{
|
|
10970
11110
|
path: '/guides/datasets-and-schema',
|
|
@@ -11440,7 +11580,7 @@ export const DOCS_SECTION_INDEX = [
|
|
|
11440
11580
|
title: 'Your first API call',
|
|
11441
11581
|
heading: '',
|
|
11442
11582
|
anchor: '',
|
|
11443
|
-
text: 'Your first API call\nBy the end of this page you\'ll have made a real request to your own data and handled the errors properly. It assumes nothing — if you\'ve never used an API before, start at the top and follow along; if you have, skip to Step 3 and then read the API reference instead of the rest of this.\nEverything here uses curl, which is already installed on macOS and Linux and ships with Windows 10 and later. There\'s a JavaScript version of each step underneath.\nWhat you need\n- An organization on a plan that includes API access — Pro or Custom.\n- The Manage API keys permission, which owners and admins hold by default.\n- A terminal.'
|
|
11583
|
+
text: 'Your first API call\nBy the end of this page you\'ll have made a real request to your own data and handled the errors properly. It assumes nothing — if you\'ve never used an API before, start at the top and follow along; if you have, skip to Step 3 and then read the API reference instead of the rest of this.\nEverything here uses curl, which is already installed on macOS and Linux and ships with Windows 10 and later. There\'s a JavaScript version of each step underneath.\nWhat you need\n- An organization on a plan that includes API access — Starter, Pro or Custom.\n- The Manage API keys permission, which owners and admins hold by default.\n- A terminal.'
|
|
11444
11584
|
},
|
|
11445
11585
|
{
|
|
11446
11586
|
path: '/guides/your-first-api-call',
|
|
@@ -11482,14 +11622,14 @@ export const DOCS_SECTION_INDEX = [
|
|
|
11482
11622
|
title: 'Your first API call',
|
|
11483
11623
|
heading: 'The four errors you will hit',
|
|
11484
11624
|
anchor: '#the-four-errors-you-will-hit',
|
|
11485
|
-
text: 'Every error has the same shape, and type is the field to branch on:\n| You see | It means | Do this |\n| 401 unauthorized | Key missing, mistyped, or revoked. | Check the header is Authorization: Bearer aglynsk…. A common cause is a shell variable that didn\'t expand — echo $AGLYNAPIKEY. |\n| 403 insufficientscope | The key is fine; it lacks a permission. code names the exact scope. | Create a key with that scope. You can\'t add a scope to an existing key. |\n| 403 planrequired | The organization\'s plan doesn\'t include API access — or, on commerce endpoints, doesn\'t include commerce (code: "commerce"). | Not transient. Don\'t retry — alert a human. |\n| 429 ratelimited |
|
|
11625
|
+
text: 'Every error has the same shape, and type is the field to branch on:\n| You see | It means | Do this |\n| 401 unauthorized | Key missing, mistyped, or revoked. | Check the header is Authorization: Bearer aglynsk…. A common cause is a shell variable that didn\'t expand — echo $AGLYNAPIKEY. |\n| 403 insufficientscope | The key is fine; it lacks a permission. code names the exact scope. | Create a key with that scope. You can\'t add a scope to an existing key. |\n| 403 planrequired | The organization\'s plan doesn\'t include API access — or, on commerce endpoints, doesn\'t include commerce (code: "commerce"). | Not transient. Don\'t retry — alert a human. |\n| 429 ratelimited | A limit refused it — 120 requests/minute for this key, the workspace\'s per-minute limit across all its keys, or (on Starter) the monthly ceiling. code says which; see Rate limits. | Back off. Retry-After says for how long, and every response carries the remaining budget in its headers. |\nRetry 429 and 500. Never retry 401, 403, or 400 — nothing about them will change on the second attempt, and a loop that retries them turns a config mistake into a rate-limit ban.'
|
|
11486
11626
|
},
|
|
11487
11627
|
{
|
|
11488
11628
|
path: '/guides/your-first-api-call',
|
|
11489
11629
|
title: 'Your first API call',
|
|
11490
11630
|
heading: 'Letting an AI agent call it for you',
|
|
11491
11631
|
anchor: '#mcp',
|
|
11492
|
-
text: 'Everything above is the same API reached with an HTTP client. If what you are wiring up is a model — Claude, ChatGPT, or anything else that speaks the Model Context Protocol — point it at the MCP server instead and it gets the same operations as tools, with no client code to write:\nIt is the same API, the same key and the same scopes. A tool call runs through the identical pipeline a request does, so an operation your key has no scope for is refused there exactly as it is here, with the same error body. The tool list is generated from the API description on this site, so it is never out of date with the reference.\nAuthenticate with the key you made in Step 1, as a bearer token:\nThe transport is Streamable HTTP, and the server keeps no session between calls — every request carries its own key, so there is nothing to resume and nothing to expire. Point your client\'s MCP configuration at the URL above and it will discover the tools itself; /.well-known/api-catalog on any site names it alongside the REST API for clients that look there first.'
|
|
11632
|
+
text: 'Everything above is the same API reached with an HTTP client. If what you are wiring up is a model — Claude, ChatGPT, or anything else that speaks the Model Context Protocol — point it at the MCP server instead and it gets the same operations as tools, with no client code to write:\nIt is the same API, the same key and the same scopes. A tool call runs through the identical pipeline a request does, so an operation your key has no scope for is refused there exactly as it is here, with the same error body. The tool list is generated from the API description on this site, so it is never out of date with the reference.\nAuthenticate with the key you made in Step 1, as a bearer token:\nA client that signs people in — Claude is one — needs no key at all: it is answered 401 with the address of the sign-in description, and the person connects a workspace in the browser. See apps that sign in.\nThe transport is Streamable HTTP, and the server keeps no session between calls — every request carries its own key, so there is nothing to resume and nothing to expire. Point your client\'s MCP configuration at the URL above and it will discover the tools itself; /.well-known/api-catalog on any site names it alongside the REST API for clients that look there first.'
|
|
11493
11633
|
},
|
|
11494
11634
|
{
|
|
11495
11635
|
path: '/guides/your-first-api-call',
|
|
@@ -12567,7 +12707,7 @@ export const DOCS_SECTION_INDEX = [
|
|
|
12567
12707
|
title: 'Add-ons',
|
|
12568
12708
|
heading: 'What you can add',
|
|
12569
12709
|
anchor: '#what-you-can-add',
|
|
12570
|
-
text: 'Buy extra capacity for the whole workspace on the Plan add-ons card under Billing → Plan: manager seats, datasets and extra sites apply straight away, while collaborator seats and POS registers become pools you then assign to a site.\nPrices live on one page Per-unit add-on prices are on aglyn.com/pricing, and what YOUR workspace would pay is shown in Billing before you confirm. This page covers what each add-on does and how it is billed; restating the numbers here would just be a second copy to keep in step.\n| Add-on | What it does | How it is priced |\n| Manager seats | Workspace manager seats beyond the included count | Per seat, per month — cheaper on Pro |\n| Collaborator seats | Per-site collaborator (teammate) seats beyond the included count | Per seat, per month — cheaper on Pro |\n| Extra datasets | Additional shared datasets across the workspace | Per dataset, per month |\n| Extra sites | Publish more sites than your plan includes | Per site, per month —
|
|
12710
|
+
text: 'Buy extra capacity for the whole workspace on the Plan add-ons card under Billing → Plan: manager seats, datasets and extra sites apply straight away, while collaborator seats and POS registers become pools you then assign to a site.\nPrices live on one page Per-unit add-on prices are on aglyn.com/pricing, and what YOUR workspace would pay is shown in Billing before you confirm. This page covers what each add-on does and how it is billed; restating the numbers here would just be a second copy to keep in step.\n| Add-on | What it does | How it is priced |\n| Manager seats | Workspace manager seats beyond the included count | Per seat, per month — cheaper on Pro |\n| Collaborator seats | Per-site collaborator (teammate) seats beyond the included count | Per seat, per month — cheaper on Pro |\n| Extra datasets | Additional shared datasets across the workspace | Per dataset, per month |\n| Extra sites | Publish more sites than your plan includes | Per site, per month — Starter\'s rate is higher than Pro\'s; aglyn.com/pricing has each |\n| POS registers | One extra point-of-sale register, assigned to one site | Flat per register, per month — the same on every plan |\n| Event Calendar | The event manager + calendar elements, workspace-wide | Flat per month — the same on every plan |\n| AI credits | Blocks of 5,000 AI credits a month added to your plan\'s own, workspace-wide, up to 30 blocks | Per block, per month — the same on every paid plan |\n| Site Care | Our team makes your small site changes for you, about an hour of work a month, workspace-wide | Flat per month — the same on every paid plan |\n- Prices are per unit per month. On annual billing, add-ons bill yearly alongside your plan (12× the monthly price) — a subscription has one billing interval.\n- POS registers also require a pl'
|
|
12571
12711
|
},
|
|
12572
12712
|
{
|
|
12573
12713
|
path: '/workspace-and-billing/billing-and-plans/add-ons',
|
|
@@ -12742,7 +12882,7 @@ export const DOCS_SECTION_INDEX = [
|
|
|
12742
12882
|
title: 'Billing & Plans',
|
|
12743
12883
|
heading: 'Tiers & entitlements',
|
|
12744
12884
|
anchor: '#tiers--entitlements',
|
|
12745
|
-
text: 'Prices live on one page Current prices — monthly, annual, transaction fees and per-unit overage rates — are on aglyn.com/pricing, and your own plan and next invoice are in Billing in the console. This page explains how billing WORKS; it deliberately does not restate the numbers, because a second copy is a copy that goes stale.\n| Plan | What it is for |\n| Free | One site to build and publish — no selling, no custom domain |\n| Starter | One site with your own domain, a store, bookings and the
|
|
12885
|
+
text: 'Prices live on one page Current prices — monthly, annual, transaction fees and per-unit overage rates — are on aglyn.com/pricing, and your own plan and next invoice are in Billing in the console. This page explains how billing WORKS; it deliberately does not restate the numbers, because a second copy is a copy that goes stale.\n| Plan | What it is for |\n| Free | One site to build and publish — no selling, no custom domain |\n| Starter | One site with your own domain, a store, bookings, the CRM and the API, with the highest transaction fee |\n| Pro | The full platform: unlimited pages, products, forms, workflows and dataset records, POS, video, recurring billing, members-only content, gift cards, A/B testing, multilingual sites, scheduled publishing, the API and webhooks |\n| Custom | Everything in Pro, plus white-label, single sign-on, a dedicated support commitment, no transaction fee, and limits set by agreement |\nPro grows by add-ons, not by changing plan. It includes three sites and a set amount of storage, bandwidth, team seats, collaborators, datasets, CRM records, email, workflow runs, API requests and AI credits. Past any of them you buy more — an extra site, seat or dataset from Add-ons — or the extra usage is metered on your invoice. There is no ceiling on how many seats, collaborators or datasets a Pro workspace can add.\nTransaction fees are Aglyn platform fees on the sales you take through your site — storefront orders, recurring billing and paid bookings alike — separate from Stripe\'s payment-processing fees, which Stripe bills to your own Stripe account. Pro\'s are lower than Starter\'s, and Custom has none.\nEvery plan also includes an amount of monthly traffic — 2 GB on Free, more on each paid plan, and on Custom whatever the agreement sets. Passing it is meter'
|
|
12746
12886
|
},
|
|
12747
12887
|
{
|
|
12748
12888
|
path: '/workspace-and-billing/billing-and-plans/overview',
|
|
@@ -12784,7 +12924,7 @@ export const DOCS_SECTION_INDEX = [
|
|
|
12784
12924
|
title: 'Billing & Plans',
|
|
12785
12925
|
heading: 'CRM records',
|
|
12786
12926
|
anchor: '#crm-records',
|
|
12787
|
-
text: 'Your CRM — the contacts captured from forms, member sign-ups, buyers and bookings, and the companies and deals your team files beside them — is priced as one CRM records band, not a hard cap. A record is a contact, a company or a deal; tasks, logged activities, pipelines and custom fields are not counted.\n- Each plan includes a band: Free 100, Starter 1,000 and Pro 10,000 records; on Custom the agreement sets it.\n- On Starter and Pro, growing past the band never blocks or drops anything — extra records are metered overage on your monthly invoice, at a per-1,000 rate that is lower on Pro — see pricing for the current rate on your plan, per extra 1,000 records per month.\n- On Free, which includes no CRM, the band is a hard limit on capture:
|
|
12927
|
+
text: 'Your CRM — the contacts captured from forms, member sign-ups, buyers and bookings, and the companies and deals your team files beside them — is priced as one CRM records band, not a hard cap. A record is a contact, a company or a deal; tasks, logged activities, pipelines and custom fields are not counted.\n- Each plan includes a band: Free 100, Starter 1,000 and Pro 10,000 records; on Custom the agreement sets it.\n- On Starter and Pro, growing past the band never blocks or drops anything — extra records are metered overage on your monthly invoice, at a per-1,000 rate that is lower on Pro — see pricing for the current rate on your plan, per extra 1,000 records per month.\n- On Free, which includes no CRM, the band is a hard limit on capture: your sites keep up to 100 people — contacts and the leads a form files, together — ready for the CRM when you upgrade. Past 100 a site adds no new person: the form entry is still saved under Forms and the visitor sees the normal confirmation, a new visitor keeps their member account and orders, and someone already kept is still updated, but no new contact or lead is made, and none is made later from the entries saved meanwhile. Everyone already kept stays. On Billing → Usage the band reads Stored records (organization), and at the limit it says new people are not being added, that form entries are still saved under Forms, and that upgrading keeps adding people; the owner is also told as the count nears and reaches 100. The Free plan card names no CRM records.\n- The billed count is the size of your CRM at the end of the month, not its size on any other day. The three collections are a running total rather than a monthly tally, so a month has to be charged on one moment in it, and that moment is the last daily reading taken before the mo'
|
|
12788
12928
|
},
|
|
12789
12929
|
{
|
|
12790
12930
|
path: '/workspace-and-billing/billing-and-plans/overview',
|
|
@@ -12798,7 +12938,7 @@ export const DOCS_SECTION_INDEX = [
|
|
|
12798
12938
|
title: 'Billing & Plans',
|
|
12799
12939
|
heading: 'API access',
|
|
12800
12940
|
anchor: '#api-access',
|
|
12801
|
-
text: 'The customer REST API is included on Pro and Custom — mint scoped API keys and call the versioned /v1 endpoints from anywhere. Requests are metered per organization:\n|
|
|
12941
|
+
text: 'The customer REST API is included on Starter, Pro and Custom — mint scoped API keys and call the versioned /v1 endpoints from anywhere. Requests are metered per organization, and the plans differ in how much they allow:\n| | Starter | Pro | Custom |\n| Included requests / month | 500 | 1,500 | Set by your agreement |\n| Past the included requests | Metered per additional 1,000 | Metered per additional 1,000 | — |\n| Monthly ceiling | 20,000 requests, then refused until the month turns | None | Set by your agreement |\n| Requests per minute, whole workspace | 120 | 600 | Set by your agreement |\n| Requests per minute, per key | 120 | 120 | 120 |\n| Webhooks and Zapier hooks | Not included | Included | Included |\n- Requests past the included quota keep working and bill as metered overage on your monthly invoice. On Starter they stop at the monthly ceiling: the API answers 429 until the next calendar month (UTC). Pro has no ceiling.\n- The workspace limit counts every key together, so adding keys doesn\'t add capacity past it. See Rate limits & usage.\n- On any plan, a workspace that can\'t be billed for overage — no active subscription, or a 100% discount on the whole bill — stops at its included requests.\n- The billing page shows an API requests meter, and the usage-cap banner warns at 80% and 100% of the included quota.\n- Only requests that pass authentication and the rate limits are counted — rejected calls (bad key, wrong plan, rate-limited, past the ceiling) are never billed.\nConnected apps {#connected-apps}\nConnected apps lists every app that was connected to the workspace by signing in instead of with an API key, such as an AI assistant. To connect one, add Aglyn in the app, sign in when it asks, pick the workspace and choose View only or View and make changes. Each row shows'
|
|
12802
12942
|
},
|
|
12803
12943
|
{
|
|
12804
12944
|
path: '/workspace-and-billing/billing-and-plans/overview',
|