Lexicon Garden

at.happyproto.actor.acceptTerms

Record that the caller accepted the beta terms in force for their account, with the exact wording they were shown. The dashboard calls it from the terms screen after sign-in. Accepting terms already accepted records nothing new. Each acceptance is kept, append-only. Customers and staff; anyone else is refused.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · procedure
Kindprocedure
Authorityactor.happyproto.at
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

idempotencyKey

requiredstring

A UUID the client generates once per acceptance and resends on every retry of it.

termsVersion

requiredstring

The terms the caller accepted, as getTerms reported them. Anything but the terms in force is refused (TermsOutdated).

text

requiredstring

The exact wording the caller accepted.

textVersion

requiredstring

The version of the wording the caller was shown, chosen by the client.

Output

application/json

accepted

requiredboolean

Always true: the caller has now accepted termsVersion.

termsVersion

requiredstring

The beta terms in force.

Errors

AuthRequired

This endpoint requires an authenticated caller.

InvalidRequest

termsVersion, textVersion, text or idempotencyKey is missing or malformed, or the provisioner refused the request as malformed.

Forbidden

The caller is neither a customer nor staff, or the provisioner refused them.

TermsRequired

The wording or its version is blank.

TermsOutdated

termsVersion is not the terms in force: the client is showing old terms, and should read getTerms again.

NotFound

Passed through from the provisioner.

InvalidSlug

Passed through from the provisioner.

SlugTaken

Passed through from the provisioner.

NotEntitled

Passed through from the provisioner.

InstanceLimit

Passed through from the provisioner.

NoCapacity

Passed through from the provisioner.

OperationInProgress

Passed through from the provisioner.

Upstream

The provisioner is unreachable, not configured, or answered with an error it does not explain to callers.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • at.happyproto.actor.getTerms

    query

    Whether the caller has accepted the beta terms in force. The dashboard asks after each sign-in and shows the terms until the caller accepts them with acceptTerms: once per account, and again whenever the terms change. createInstance is refused until then. Customers and staff; anyone else is refused.

  • at.happyproto.server.createInstance

    procedure

    Create an instance for the caller, and start a job that follows its provisioning. Customers only.