minca
ApiSchemasVariables

Variable: orderUpdate

const orderUpdate: object & Typed<{
  note?: string;
  respondingTo?: string;
  status: "cancelled" | "accepted" | "paid" | "shipped" | "delivered" | "refunded";
}>;

Defined in: packages/core/src/schemas/library/money.ts:177

A step in an order's life, from either side: accepted, paid, shipped.

Type Declaration

description

readonly description: "A step in an order: accepted, paid, shipped, delivered, cancelled." = 'A step in an order: accepted, paid, shipped, delivered, cancelled.';
readonly links: object;

links.about

readonly about: LinkDeclaration;

name

readonly name: "std.order-update" = 'std.order-update';

schema

readonly schema: object;

schema.properties

readonly properties: object;

schema.properties.note

readonly note: object;

schema.properties.note.maxLength

maxLength: number = max;

schema.properties.note.minLength?

minLength?: number = min;

schema.properties.note.type

type: "string";

schema.properties.respondingTo

readonly respondingTo: object & object;
Type Declaration
maxLength
maxLength: number = max;
minLength?
minLength?: number = min;
type
type: "string";
x-kind
readonly "x-kind": "did";

schema.properties.status

readonly status: object;

schema.properties.status.enum

enum: ("cancelled" | "accepted" | "paid" | "shipped" | "delivered" | "refunded")[];

schema.required

readonly required: readonly ["status"];

schema.type

readonly type: "object" = 'object';

title

readonly title: "Order update" = 'Order update';

topics

readonly topics: readonly ["respondingTo"];

On this page