Organizations — customer accounts

The service each organisation you serve gets: the tier it is on, what it is entitled to, the account team that looks after it, and its VIP people. Your support, sales or success kits route and promise by them. Only your own people set them, never the organisation's.

It is an add-on to Osysharp.Organizations, which holds who belongs to which organisation, the roles they hold there and the mail domains that place a newcomer. Take this kit as well when the organisations are your customers:

osy

// app.osy
use Osysharp.Identity@0;
use Osysharp.Organizations@0;
use Osysharp.Organizations.Accounts@0;

osy

using Osysharp.Identity;
using Osysharp.Organizations;
using Osysharp.Organizations.Accounts;

policy ManagesOrganizations => IsStaff;   // the base kit's one question — this kit asks the same

// A customer is a CustomerAccount (itself an Organization) — it has a tier.
entity Company : CustomerAccount {
  [MaxLength(40)] string AccountNumber = "";
  security {
    allow read, create, update when IsStaff;
    allow read when IsAuthenticated where IsMemberOf(this);
  }
}

// Your own teams stay plain organisations: nobody serves them.
entity Team : Organization { security { allow read, create, update when IsStaff; } }

// What a tier (or one company's contract) includes, in your own shape.
entity ResponseTarget : Entitlement {
  int FirstReplyHours = 24;
  security { allow read, create, update, delete when IsStaff; }
}

What it holds

CustomerAccount — an organisation you serve, with its Tier. Derive your customers from it.
OrganizationTier — Standard, Premium, Enterprise, as you name them: rows your organisation managers define, ordered by Rank, one of them IsDefault. Rows rather than an enum, because they are configuration you change without a release.
Entitlement — what an organisation may have: a channel, support hours, a response target. Attached to a tier (everybody on it) or to one organisation (its own contract), for a period. Derive your own kind.
AccountTeamMember — your own people looking after an organisation: one Owner, a pod (Member), and a Backup who covers while the owner is away. An organisation's people can see who looks after them.
VipMembership — a person who is a VIP at an organisation: an executive, a key contact. They stop being one when their membership is suspended or ends.

What holds whatever your app grants

The tier is yours to set. An organisation's own people never change the tier they are on, however much else your app lets them edit about their company.
So is who is a VIP, and who is on the account team. Nobody makes themself, or a colleague, a VIP.

The tiers page

/settings/tiers joins your settings area by itself, for your organisation managers: each tier, its rank, what it is, and what everybody on it is entitled to, kept on Save. Write a component called TierSettings to replace it, or use TierEditor(description: "…") inside your own page to keep the editor and say it in your app's words.

What an app calls


`DefaultTier()` · `TierOfAccount(org)`	the default tier · the tier an organisation is on, or the default
`EntitlementsOf(org)`	what applies to an organisation now — its own contract first, then its tier's
`AccountOwnerOf(org)` · `AccountTeamOf(org)` · `SetAccountOwner(org, person)` · `AddToAccountTeam(org, person, role)`	the account team
`MarkVip(org, person)` · `UnmarkVip(org, person)` · `IsVipPerson(person)`	VIPs

Osysharp.Inbox uses all of it: a customer's work goes to its account owner first, then the backup and the pod, and its promise is chosen by its tier and whether the person asking is a VIP.

Its tests

The kit's test app is a supplier's portal: two customer companies on two tiers, a contract of their own, an account team, and a VIP buyer who may edit her company's details but never its tier, its team or who is a VIP. The tiers page is driven as a person would use it, wide and on a phone.

Get it

Add the kit to your app’s manifest:

osy

app MyApp {
  use Osysharp.Organizations.Accounts@0;
}

Then run osy lock: it downloads the release, verifies it by its content address and pins that version in osyrin.lock. osy kits Osysharp.Organizations.Accounts shows what the kit is for, from inside your app.

Reference: osy docs security-organizations-accounts-kit.