@aglyn/aglyn 1.23.0 → 1.24.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-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/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/docs-help-sections.generated.js +4 -0
- package/src/lib/app-utils/docs-help-sections.generated.js.map +1 -1
- package/src/lib/app-utils/docs-help.generated.d.ts +10 -4
- package/src/lib/app-utils/docs-help.generated.js +57 -3
- package/src/lib/app-utils/docs-help.generated.js.map +1 -1
- package/src/lib/app-utils/docs-index.generated.js +129 -3
- 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/native-app-association.d.ts +4 -2
- package/src/lib/app-utils/native-app-association.js +5 -2
- package/src/lib/app-utils/native-app-association.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/plugin-release-flags.generated.js +2 -2
- package/src/lib/app-utils/plugin-release-flags.generated.js.map +1 -1
- package/src/lib/plugin-manager/feature-plugins.d.ts +22 -0
- package/src/lib/plugin-manager/feature-plugins.js +9 -0
- package/src/lib/plugin-manager/feature-plugins.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
|
@@ -3917,6 +3917,13 @@ export const DOCS_SECTION_INDEX = [
|
|
|
3917
3917
|
anchor: '#verify-your-site-with-google-search-console',
|
|
3918
3918
|
text: 'Search Console and Bing Webmaster Tools want proof the site is yours before they show you its search data. A site on an aglyn.app address has no DNS of its own to add a record to, so use the HTML tag method — it works on every site, custom domain or not.\n1. In Google Search Console, choose Add property → URL prefix, enter your site\'s full address, and pick HTML tag under Other verification methods.\n2. Copy the tag it shows you. You can paste the whole tag or just the code inside content — Aglyn keeps only the code.\n3. In Setup → SEO → Search engine verification, paste it into Google Search Console and press Update.\n4. Back in Search Console, press Verify. Allow a minute for the published site to pick up the change if the first attempt fails.\nBing works the same way: in Bing Webmaster Tools, choose Add site, pick HTML Meta Tag, and paste the msvalidate.01 tag into Bing Webmaster Tools.\nKeep the code in place after verifying — both tools re-check it from time to time, and removing it un-verifies the site. Clearing a field and pressing Update removes that tag from every page.'
|
|
3919
3919
|
},
|
|
3920
|
+
{
|
|
3921
|
+
path: '/building-sites/seo/overview',
|
|
3922
|
+
title: 'SEO Toolkit',
|
|
3923
|
+
heading: 'Verify your business with ChatGPT',
|
|
3924
|
+
anchor: '#chatgpt',
|
|
3925
|
+
text: 'ChatGPT lists businesses, and the owner of a business can claim its listing to keep its details right. To claim yours, ChatGPT asks you to show that you control your site\'s domain. The Verify with ChatGPT card, under Search engine verification in Setup → SEO, does that for you.\n1. In ChatGPT, open Business from the sidebar, search for your business and select it.\n2. When ChatGPT asks how to verify your claim, choose Website domain. It shows a record with a Value. Copy the value.\n3. In the Verify with ChatGPT card, press Verify with your domain\'s name.\n4. Paste the value and press Add record.\n5. Back in ChatGPT, press Verify domain. If ChatGPT doesn\'t see the record yet, wait a few minutes and try again.\nOnce the record is there, the card says so. If ChatGPT gives you a new value later, add it the same way and it replaces the old one.\nAglyn adds the record for a domain your workspace holds here that uses Aglyn\'s nameservers, and adding it takes a workspace owner or admin. For a domain that keeps its DNS with another provider, the card tells you which record to add there instead: a TXT record named openai-business-claim with the value ChatGPT gives you. A site on its free Aglyn address has no domain of its own to verify, so connect a domain first.'
|
|
3926
|
+
},
|
|
3920
3927
|
{
|
|
3921
3928
|
path: '/building-sites/seo/overview',
|
|
3922
3929
|
title: 'SEO Toolkit',
|
|
@@ -4897,6 +4904,62 @@ export const DOCS_SECTION_INDEX = [
|
|
|
4897
4904
|
anchor: '#related',
|
|
4898
4905
|
text: '- Sales channels\n- Commerce overview\n- SEO — products emit structured data and join the sitemap automatically.'
|
|
4899
4906
|
},
|
|
4907
|
+
{
|
|
4908
|
+
path: '/commerce-and-bookings/commerce/connect-quickbooks-online',
|
|
4909
|
+
title: 'Connect QuickBooks Online',
|
|
4910
|
+
heading: '',
|
|
4911
|
+
anchor: '',
|
|
4912
|
+
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.'
|
|
4913
|
+
},
|
|
4914
|
+
{
|
|
4915
|
+
path: '/commerce-and-bookings/commerce/connect-quickbooks-online',
|
|
4916
|
+
title: 'Connect QuickBooks Online',
|
|
4917
|
+
heading: 'Before you start',
|
|
4918
|
+
anchor: '#before-you-start',
|
|
4919
|
+
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.'
|
|
4920
|
+
},
|
|
4921
|
+
{
|
|
4922
|
+
path: '/commerce-and-bookings/commerce/connect-quickbooks-online',
|
|
4923
|
+
title: 'Connect QuickBooks Online',
|
|
4924
|
+
heading: 'Connect',
|
|
4925
|
+
anchor: '#connect',
|
|
4926
|
+
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.'
|
|
4927
|
+
},
|
|
4928
|
+
{
|
|
4929
|
+
path: '/commerce-and-bookings/commerce/connect-quickbooks-online',
|
|
4930
|
+
title: 'Connect QuickBooks Online',
|
|
4931
|
+
heading: 'Choose your accounts',
|
|
4932
|
+
anchor: '#choose-your-accounts',
|
|
4933
|
+
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.'
|
|
4934
|
+
},
|
|
4935
|
+
{
|
|
4936
|
+
path: '/commerce-and-bookings/commerce/connect-quickbooks-online',
|
|
4937
|
+
title: 'Connect QuickBooks Online',
|
|
4938
|
+
heading: 'What is posted',
|
|
4939
|
+
anchor: '#what-is-posted',
|
|
4940
|
+
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'
|
|
4941
|
+
},
|
|
4942
|
+
{
|
|
4943
|
+
path: '/commerce-and-bookings/commerce/connect-quickbooks-online',
|
|
4944
|
+
title: 'Connect QuickBooks Online',
|
|
4945
|
+
heading: 'Sales before you connected',
|
|
4946
|
+
anchor: '#sales-before-you-connected',
|
|
4947
|
+
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.'
|
|
4948
|
+
},
|
|
4949
|
+
{
|
|
4950
|
+
path: '/commerce-and-bookings/commerce/connect-quickbooks-online',
|
|
4951
|
+
title: 'Connect QuickBooks Online',
|
|
4952
|
+
heading: 'When something does not post',
|
|
4953
|
+
anchor: '#when-something-does-not-post',
|
|
4954
|
+
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.'
|
|
4955
|
+
},
|
|
4956
|
+
{
|
|
4957
|
+
path: '/commerce-and-bookings/commerce/connect-quickbooks-online',
|
|
4958
|
+
title: 'Connect QuickBooks Online',
|
|
4959
|
+
heading: 'Disconnect',
|
|
4960
|
+
anchor: '#disconnect',
|
|
4961
|
+
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.'
|
|
4962
|
+
},
|
|
4900
4963
|
{
|
|
4901
4964
|
path: '/commerce-and-bookings/commerce/connect-smile-io-or-yotpo',
|
|
4902
4965
|
title: 'Connect Smile.io or Yotpo Loyalty',
|
|
@@ -4932,6 +4995,69 @@ export const DOCS_SECTION_INDEX = [
|
|
|
4932
4995
|
anchor: '#disconnect',
|
|
4933
4996
|
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.'
|
|
4934
4997
|
},
|
|
4998
|
+
{
|
|
4999
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5000
|
+
title: 'Connect Xero',
|
|
5001
|
+
heading: '',
|
|
5002
|
+
anchor: '',
|
|
5003
|
+
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.'
|
|
5004
|
+
},
|
|
5005
|
+
{
|
|
5006
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5007
|
+
title: 'Connect Xero',
|
|
5008
|
+
heading: 'Before you start',
|
|
5009
|
+
anchor: '#before-you-start',
|
|
5010
|
+
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.'
|
|
5011
|
+
},
|
|
5012
|
+
{
|
|
5013
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5014
|
+
title: 'Connect Xero',
|
|
5015
|
+
heading: 'Connect',
|
|
5016
|
+
anchor: '#connect',
|
|
5017
|
+
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.'
|
|
5018
|
+
},
|
|
5019
|
+
{
|
|
5020
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5021
|
+
title: 'Connect Xero',
|
|
5022
|
+
heading: 'Choose an organization',
|
|
5023
|
+
anchor: '#choose-an-organization',
|
|
5024
|
+
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.'
|
|
5025
|
+
},
|
|
5026
|
+
{
|
|
5027
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5028
|
+
title: 'Connect Xero',
|
|
5029
|
+
heading: 'Choose your accounts',
|
|
5030
|
+
anchor: '#choose-your-accounts',
|
|
5031
|
+
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.'
|
|
5032
|
+
},
|
|
5033
|
+
{
|
|
5034
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5035
|
+
title: 'Connect Xero',
|
|
5036
|
+
heading: 'What is posted',
|
|
5037
|
+
anchor: '#what-is-posted',
|
|
5038
|
+
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'
|
|
5039
|
+
},
|
|
5040
|
+
{
|
|
5041
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5042
|
+
title: 'Connect Xero',
|
|
5043
|
+
heading: 'Sales before you connected',
|
|
5044
|
+
anchor: '#sales-before-you-connected',
|
|
5045
|
+
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.'
|
|
5046
|
+
},
|
|
5047
|
+
{
|
|
5048
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5049
|
+
title: 'Connect Xero',
|
|
5050
|
+
heading: 'When something does not post',
|
|
5051
|
+
anchor: '#when-something-does-not-post',
|
|
5052
|
+
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.'
|
|
5053
|
+
},
|
|
5054
|
+
{
|
|
5055
|
+
path: '/commerce-and-bookings/commerce/connect-xero',
|
|
5056
|
+
title: 'Connect Xero',
|
|
5057
|
+
heading: 'Disconnect',
|
|
5058
|
+
anchor: '#disconnect',
|
|
5059
|
+
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.'
|
|
5060
|
+
},
|
|
4935
5061
|
{
|
|
4936
5062
|
path: '/commerce-and-bookings/commerce/couriers',
|
|
4937
5063
|
title: 'Couriers for local delivery (DoorDash Drive)',
|
|
@@ -10957,7 +11083,7 @@ export const DOCS_SECTION_INDEX = [
|
|
|
10957
11083
|
title: 'Datasets & schema deep-dive',
|
|
10958
11084
|
heading: 'The typed model',
|
|
10959
11085
|
anchor: '#the-typed-model',
|
|
10960
|
-
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.'
|
|
11086
|
+
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.'
|
|
10961
11087
|
},
|
|
10962
11088
|
{
|
|
10963
11089
|
path: '/guides/datasets-and-schema',
|
|
@@ -11482,7 +11608,7 @@ export const DOCS_SECTION_INDEX = [
|
|
|
11482
11608
|
title: 'Your first API call',
|
|
11483
11609
|
heading: 'Letting an AI agent call it for you',
|
|
11484
11610
|
anchor: '#mcp',
|
|
11485
|
-
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.'
|
|
11611
|
+
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.'
|
|
11486
11612
|
},
|
|
11487
11613
|
{
|
|
11488
11614
|
path: '/guides/your-first-api-call',
|
|
@@ -12791,7 +12917,7 @@ export const DOCS_SECTION_INDEX = [
|
|
|
12791
12917
|
title: 'Billing & Plans',
|
|
12792
12918
|
heading: 'API access',
|
|
12793
12919
|
anchor: '#api-access',
|
|
12794
|
-
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| Plan | Included requests / month | Overage |\n| Pro | 1,500 | Metered per additional 1,000 |\n| Custom | Set by your agreement | — |\n- Requests past the included quota keep working and bill as metered overage on your monthly invoice — never a hard wall mid-integration.\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 limit are counted — rejected calls (bad key, wrong plan, rate-limited) are never billed.'
|
|
12920
|
+
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| Plan | Included requests / month | Overage |\n| Pro | 1,500 | Metered per additional 1,000 |\n| Custom | Set by your agreement | — |\n- Requests past the included quota keep working and bill as metered overage on your monthly invoice — never a hard wall mid-integration.\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 limit are counted — rejected calls (bad key, wrong plan, rate-limited) 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 who connected it, when it was last used and its access, and Disconnect ends its access at once. A connected app\'s requests count toward the same API requests meter as your keys.'
|
|
12795
12921
|
},
|
|
12796
12922
|
{
|
|
12797
12923
|
path: '/workspace-and-billing/billing-and-plans/overview',
|