Skip to content

Commit

Permalink
Deploying to gh-pages from @ 491786a 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
daallen303 committed May 29, 2024
1 parent 339df1e commit cc13b31
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions api/accounts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,16 @@
window.addEventListener('beforeunload', () => {
localStorage.setItem('sidebar-scroll', leftSidebar.scrollTop);
});
</script><main class="flex flex-col min-h-full w-full pt-16 md:pl-64 xl:pl-80"><div class="relative mx-auto desktop-gutters flex justify-center"><div class="min-w-0 max-w-2xl flex-auto px-8 pb-16 pt-8 xl:pt-16 lg:max-w-none"><article><header class="mb-9 space-y-1"><h1 class="font-display text-3xl tracking-tight text-slate-900">Accounts</h1></header><astro-island uid="Z2ixSlE" component-url="/_astro/Prose.8cdff347.js" component-export="default" renderer-url="/_astro/client.e0200ae5.js" props="{}" ssr="" client="load" opts="{&quot;name&quot;:&quot;Prose&quot;,&quot;value&quot;:true}" await-children=""><div class="prose prose-slate max-w-none prose-headings:font-display prose-headings:font-normal prose-h2:scroll-mt-16 prose-h2:mt-8 prose-h2:pt-8 prose-h2:border-t prose-h3:scroll-mt-20 prose-h4:scroll-mt-20 prose-lead:text-slate-500 prose-a:no-underline prose-a:text-content-primary hover:prose-a:no-underline prose-img:mb-8 prose-img:mx-auto prose-img:object-contain"><!--[--><astro-slot><p>An Account represents a permission boundary around Centrapay resources.
</script><main class="flex flex-col min-h-full w-full pt-16 md:pl-64 xl:pl-80"><div class="relative mx-auto desktop-gutters flex justify-center"><div class="min-w-0 max-w-2xl flex-auto px-8 pb-16 pt-8 xl:pt-16 lg:max-w-none"><article><header class="mb-9 space-y-1"><h1 class="font-display text-3xl tracking-tight text-slate-900">Accounts</h1></header><astro-island uid="Z2scnlN" component-url="/_astro/Prose.8cdff347.js" component-export="default" renderer-url="/_astro/client.e0200ae5.js" props="{}" ssr="" client="load" opts="{&quot;name&quot;:&quot;Prose&quot;,&quot;value&quot;:true}" await-children=""><div class="prose prose-slate max-w-none prose-headings:font-display prose-headings:font-normal prose-h2:scroll-mt-16 prose-h2:mt-8 prose-h2:pt-8 prose-h2:border-t prose-h3:scroll-mt-20 prose-h4:scroll-mt-20 prose-lead:text-slate-500 prose-a:no-underline prose-a:text-content-primary hover:prose-a:no-underline prose-img:mb-8 prose-img:mx-auto prose-img:object-contain"><!--[--><astro-slot><p>An Account represents a permission boundary around Centrapay resources.
Accounts can have <a href="/api/api-keys/" target="_self" class="group inline-flex justify-center items-center text-interactive-secondary hover:text-interactive-secondary-hover"><span class="underline"><!--[-->API Keys<!--]--></span><span> </span><span class="rounded-sm bg-interactive-secondary group-hover:bg-interactive-secondary-hover h-3 w-6 inline-flex justify-center items-center"><span class="text-content-inverse-primary text-[10px]"> API </span></span></a> and <a href="/api/account-memberships/" target="_self" class="group inline-flex justify-center items-center text-interactive-secondary hover:text-interactive-secondary-hover"><span class="underline"><!--[-->Account Memberships<!--]--></span><span> </span><span class="rounded-sm bg-interactive-secondary group-hover:bg-interactive-secondary-hover h-3 w-6 inline-flex justify-center items-center"><span class="text-content-inverse-primary text-[10px]"> API </span></span></a> which grant access to the resources.</p>
<p>Accounts are classified as either “individual” or “org”. Individual accounts
can only have a single member and Centrapay users can only be a member of a single
individual account.</p>
<section class="heading" data-heading-rank="2"><div class="not-prose"><a href="#account-model" class="group flex items-center relative"><svg width="16" height="16" viewbox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="w-4 h-4 mr-2 absolute right-full opacity-0 group-hover:opacity-100"><path fill-rule="evenodd" clip-rule="evenodd" d="M4.5 5.75C3.90326 5.75 3.33097 5.98705 2.90901 6.40901C2.48705 6.83097 2.25 7.40326 2.25 8C2.25 8.59674 2.48705 9.16903 2.90901 9.59099C3.33097 10.0129 3.90326 10.25 4.5 10.25H6.27063C6.68484 10.25 7.02063 10.5858 7.02063 11C7.02063 11.4142 6.68484 11.75 6.27063 11.75H4.5C3.50544 11.75 2.55161 11.3549 1.84835 10.6517C1.14509 9.94839 0.75 8.99456 0.75 8C0.75 7.00544 1.14509 6.05161 1.84835 5.34835C2.55161 4.64509 3.50544 4.25 4.5 4.25H6.23156C6.64578 4.25 6.98156 4.58579 6.98156 5C6.98156 5.41421 6.64578 5.75 6.23156 5.75H4.5Z" fill="currentColor"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M9.01855 5C9.01855 4.58579 9.35434 4.25 9.76855 4.25H11.5001C12.4947 4.25 13.4485 4.64509 14.1518 5.34835C14.855 6.05161 15.2501 7.00544 15.2501 8C15.2501 8.99456 14.855 9.94839 14.1518 10.6517C13.4485 11.3549 12.4947 11.75 11.5001 11.75H9.72949C9.31528 11.75 8.97949 11.4142 8.97949 11C8.97949 10.5858 9.31528 10.25 9.72949 10.25H11.5001C12.0969 10.25 12.6692 10.0129 13.0911 9.59099C13.5131 9.16903 13.7501 8.59674 13.7501 8C13.7501 7.40326 13.5131 6.83097 13.0911 6.40901C12.6692 5.98705 12.0969 5.75 11.5001 5.75H9.76855C9.35434 5.75 9.01855 5.41421 9.01855 5Z" fill="currentColor"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M4.53345 8C4.53345 7.58579 4.86923 7.25 5.28345 7.25H10.7791C11.1933 7.25 11.5291 7.58579 11.5291 8C11.5291 8.41421 11.1933 8.75 10.7791 8.75H5.28345C4.86923 8.75 4.53345 8.41421 4.53345 8Z" fill="currentColor"></path></svg><h2 id="account-model" class="scroll-mt-32 my-4 type-headline-4 flex flex-wrap gap-1">Account Model</h2></a></div>
<div data-attributes class="my-6"><div class="flex justify-between items-center not-prose py-2"><h3 class="type-subtitle-1">Attributes</h3><button data-expand-button class="text-content-tertiary type-overline hover:text-content-secondary">
Collapse all
</button></div><ul data-attribute-list role="list" class="m-0 list-none border-y border-outline-transparent divide-y divide-outline-transparent p-0 pt-4"><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="id">id</h4><span class="not-prose items-center inline-flex"><span class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border">string</span></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>The unique identifier.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="type">type</h4><span class="not-prose items-center inline-flex"><span class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border">string</span></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>Account type, must be either ‘org’ or ‘individual’.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="name">name</h4><span class="not-prose items-center inline-flex"><span class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border">string</span></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>The display name of the Account.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="region">region</h4><span class="not-prose items-center inline-flex"><span class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border">string</span></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>The region that the Account will operate in.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="test">test</h4><span class="not-prose items-center inline-flex"><span class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border">boolean</span></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>A flag which is only present if the Account is for testing.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="createdAt">createdAt</h4><span class="not-prose items-center inline-flex"><a class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border underline" href="/api/data-types#timestamp">timestamp</a></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>When the Account was created.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="modifiedAt">modifiedAt</h4><span class="not-prose items-center inline-flex"><a class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border underline" href="/api/data-types#timestamp">timestamp</a></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>When the Account was updated.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="createdBy">createdBy</h4><span class="not-prose items-center inline-flex"><a class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border underline" href="/api/data-types#crn">crn</a></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>The User or API Key that created the Account.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="modifiedBy">modifiedBy</h4><span class="not-prose items-center inline-flex"><a class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border underline" href="/api/data-types#crn">crn</a></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>The User or API Key that updated the Account.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="subscriptions">subscriptions</h4><span class="not-prose items-center inline-flex"><span class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border">array</span></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>A list of <a href="#subscription-model" target="_self" class="group inline-flex justify-center items-center text-interactive-secondary hover:text-interactive-secondary-hover"><span class="underline"><!--[-->Subscriptions<!--]--></span><!----><!----></a> on the Account.</p></div></li></ul></div>
</button></div><ul data-attribute-list role="list" class="m-0 list-none border-y border-outline-transparent divide-y divide-outline-transparent p-0 pt-4"><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="id">id</h4><span class="not-prose items-center inline-flex"><span class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border">string</span></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>The unique identifier.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="type">type</h4><span class="not-prose items-center inline-flex"><span class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border">string</span></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>Account type, must be either ‘org’ or ‘individual’.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="name">name</h4><span class="not-prose items-center inline-flex"><span class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border">string</span></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>The display name of the Account.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="region">region</h4><span class="not-prose items-center inline-flex"><span class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border">string</span></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>The region that the Account will operate in.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="test">test</h4><span class="not-prose items-center inline-flex"><span class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border">boolean</span></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>A flag which is only present if the Account is for testing.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="createdAt">createdAt</h4><span class="not-prose items-center inline-flex"><a class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border underline" href="/api/data-types#timestamp">timestamp</a></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>When the Account was created.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="modifiedAt">modifiedAt</h4><span class="not-prose items-center inline-flex"><a class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border underline" href="/api/data-types#timestamp">timestamp</a></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>When the Account was updated.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="createdBy">createdBy</h4><span class="not-prose items-center inline-flex"><a class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border underline" href="/api/data-types#crn">crn</a></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>The User or API Key that created the Account.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="modifiedBy">modifiedBy</h4><span class="not-prose items-center inline-flex"><a class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border underline" href="/api/data-types#crn">crn</a></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>The User or API Key that updated the Account.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="subscriptions">subscriptions</h4><span class="not-prose items-center inline-flex"><span class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border">array</span></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>A list of <a href="#subscription-model" target="_self" class="group inline-flex justify-center items-center text-interactive-secondary hover:text-interactive-secondary-hover"><span class="underline"><!--[-->Subscriptions<!--]--></span><!----><!----></a> on the Account.</p></div></li><li class="m-0 px-0 py-4 first:pt-0"><div class="m-0 flex flex-wrap items-center gap-x-3"><h4 class="my-0" id="parentAccountId">parentAccountId</h4><span class="not-prose items-center inline-flex"><span class="text-content-primary border-outline-opaque bg-surface-tertiary type-caption-2 px-2 py-0.5 rounded-full border">string</span></span></div><div data-expandable-slot class="w-full flex-none [&>:first-child]:mt-0 [&>:last-child]:mb-0 transition-opacity duration-500 expanded"><p>The unique identifier of the parent account to which the current account is linked.
This field establishes a hierarchical relationship between accounts, indicating that the current account was created by the specified parent account.</p></div></li></ul></div>
<hr/>
</section><section class="heading" data-heading-rank="2"><div class="not-prose"><a href="#subscription-model" class="group flex items-center relative"><svg width="16" height="16" viewbox="0 0 16 16" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="w-4 h-4 mr-2 absolute right-full opacity-0 group-hover:opacity-100"><path fill-rule="evenodd" clip-rule="evenodd" d="M4.5 5.75C3.90326 5.75 3.33097 5.98705 2.90901 6.40901C2.48705 6.83097 2.25 7.40326 2.25 8C2.25 8.59674 2.48705 9.16903 2.90901 9.59099C3.33097 10.0129 3.90326 10.25 4.5 10.25H6.27063C6.68484 10.25 7.02063 10.5858 7.02063 11C7.02063 11.4142 6.68484 11.75 6.27063 11.75H4.5C3.50544 11.75 2.55161 11.3549 1.84835 10.6517C1.14509 9.94839 0.75 8.99456 0.75 8C0.75 7.00544 1.14509 6.05161 1.84835 5.34835C2.55161 4.64509 3.50544 4.25 4.5 4.25H6.23156C6.64578 4.25 6.98156 4.58579 6.98156 5C6.98156 5.41421 6.64578 5.75 6.23156 5.75H4.5Z" fill="currentColor"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M9.01855 5C9.01855 4.58579 9.35434 4.25 9.76855 4.25H11.5001C12.4947 4.25 13.4485 4.64509 14.1518 5.34835C14.855 6.05161 15.2501 7.00544 15.2501 8C15.2501 8.99456 14.855 9.94839 14.1518 10.6517C13.4485 11.3549 12.4947 11.75 11.5001 11.75H9.72949C9.31528 11.75 8.97949 11.4142 8.97949 11C8.97949 10.5858 9.31528 10.25 9.72949 10.25H11.5001C12.0969 10.25 12.6692 10.0129 13.0911 9.59099C13.5131 9.16903 13.7501 8.59674 13.7501 8C13.7501 7.40326 13.5131 6.83097 13.0911 6.40901C12.6692 5.98705 12.0969 5.75 11.5001 5.75H9.76855C9.35434 5.75 9.01855 5.41421 9.01855 5Z" fill="currentColor"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M4.53345 8C4.53345 7.58579 4.86923 7.25 5.28345 7.25H10.7791C11.1933 7.25 11.5291 7.58579 11.5291 8C11.5291 8.41421 11.1933 8.75 10.7791 8.75H5.28345C4.86923 8.75 4.53345 8.41421 4.53345 8Z" fill="currentColor"></path></svg><h2 id="subscription-model" class="scroll-mt-32 my-4 type-headline-4 flex flex-wrap gap-1">Subscription Model</h2></a></div>
<div data-attributes class="my-6"><div class="flex justify-between items-center not-prose py-2"><h3 class="type-subtitle-1">Attributes</h3><button data-expand-button class="text-content-tertiary type-overline hover:text-content-secondary">
Expand Down

0 comments on commit cc13b31

Please sign in to comment.