@registrystack/client 0.43.0 → 0.45.0

package/scheduling/client.d.ts

@@ -10,11 +10,12 @@ export type JsonValue = JsonScalar | ReadonlyArray<JsonValue> | { readonly [key:
 
 export interface SchedulingClientConfig {
   baseUrl: string
-  requestTimeoutMilliseconds?: SafeInteger | null
-  connectTimeoutMilliseconds?: SafeInteger | null
-  maxResponseBytes?: SafeInteger | null
-  userAgent?: string | null
-  trustedRootCertificates?: string | null
+  attemptTimeoutMilliseconds?: SafeInteger
+  connectTimeoutMilliseconds?: SafeInteger
+  maximumResponseBytes?: SafeInteger
+  userAgent?: string
+  /** Additional trust roots for the deployment, as PEM text. */
+  trustedRootCertificates?: string
   /**
    * How many times a keyed command (hold, appointment create, reschedule,
    * cancel) whose outcome is unknown is resent, identically and under the
@@ -22,7 +23,7 @@ export interface SchedulingClientConfig {
    * to 2, default 2; 0 sends it once. Any other value is a `configuration`
    * error.
    */
-  maxMutationRetries?: SafeInteger | null
+  maximumMutationRetries?: SafeInteger
 }
 
 /** An opaque record link Scheduling retains with a hold or appointment. */
@@ -33,12 +34,98 @@ export interface ExternalReference {
 }
 
 export interface PartyCounts { recipients: SafeInteger; attendees: SafeInteger }
+export interface BusyCoverage { start: Instant; end: Instant; resources: ReadonlyArray<string> }
+export interface BusyIntervalInput { externalUid: string; externalRevision: string; resource: string; start: Instant; end: Instant }
+export interface BusyReconciliationRequest {
+  expectedRevision: SafeInteger
+  observedAt: Instant
+  freshUntil?: Instant | null
+  coverage: BusyCoverage
+  status: 'fresh' | 'unavailable'
+  records: ReadonlyArray<BusyIntervalInput>
+}
+export interface BusyCommitmentImpact { kind: string; resource: string; occupiedStart: Instant; occupiedEnd: Instant }
+export interface BusyImpactSummary {
+  total: SafeInteger
+  detailsAvailable: boolean
+  truncated: boolean
+  items?: ReadonlyArray<BusyCommitmentImpact>
+}
+export interface BusyReconciliationCounts {
+  sourceId: string
+  requestDigest: string
+  added: SafeInteger
+  changed: SafeInteger
+  deleted: SafeInteger
+  retainedOutsideAuthority: SafeInteger
+  retainedAcrossCoverageBoundary: SafeInteger
+  impacts: BusyImpactSummary
+}
+export interface BusyReconciliationPreview extends BusyReconciliationCounts {
+  expectedRevision: SafeInteger
+  currentRevision: SafeInteger
+}
+export interface BusyApplyOutcome extends BusyReconciliationCounts {
+  kind: 'applied' | 'already-applied'
+  revision: SafeInteger
+}
+/** A secondary physical requirement, committed with the primary offering. */
+export interface AdditionalAllocationRequest {
+  offering: string
+  resource?: string
+  units?: SafeInteger
+}
+export type AllocationRequirementDocument =
+  | { kind: 'primary' }
+  | { kind: 'additional'; index: SafeInteger }
+export interface AllocationDocument {
+  requirement: AllocationRequirementDocument
+  offering: string
+  resource: string
+  units: SafeInteger
+  occupiedStart: Instant
+  occupiedEnd: Instant
+}
+export interface OperationalAllocationDocument extends Omit<AllocationDocument, 'resource'> {
+  resource?: string
+}
+/** Physical advice only. This read never grants admission or reserves capacity. */
+export interface AvailabilityPreviewRequest {
+  offering: string
+  start: Instant
+  durationMinutes?: SafeInteger
+  resource?: string
+  resourceUnits?: SafeInteger
+  additionalAllocations?: ReadonlyArray<AdditionalAllocationRequest>
+  party?: PartyCounts
+}
+export interface AvailabilityPreviewDocument {
+  offering: string
+  start: Instant
+  end: Instant
+  capacityAvailable: boolean
+  publicCode?: string
+}
+/** A fixed verified-grant selector, never a caller-supplied manager identifier. */
+export type ManagerSelection = 'schedulingManager'
+/** Source-owned booking data. It grants no relationship or appointment authority. */
+export interface PartyReference {
+  role: 'beneficiary' | 'organization'
+  reference: ExternalReference
+}
 
 /** One admission: the offering, start, and party a hold or booking asks capacity for. */
 export interface AdmissionRequest {
   offering: string
   start: Instant
-  party: PartyCounts
+  durationMinutes?: SafeInteger
+  resource?: string
+  /** Physical units, default 1. People are counted separately. */
+  resourceUnits?: SafeInteger
+  additionalAllocations?: ReadonlyArray<AdditionalAllocationRequest>
+  party?: PartyCounts
+  manager?: ManagerSelection
+  partyReferences?: ReadonlyArray<PartyReference>
   channel?: string | null
   duplicateKey?: string | null
   policyRevision: SafeInteger
@@ -55,19 +142,59 @@ export type CreateAppointmentRequest =
 
 export interface RescheduleAppointmentRequest { observedRevision: SafeInteger; admission: AdmissionRequest }
 export interface CancelAppointmentRequest { observedRevision: SafeInteger; reason?: string | null }
+export type AttendanceState = 'arrived' | 'completed' | 'no-show'
+export interface RecordAttendanceRequest {
+  observedAppointmentRevision: SafeInteger
+  observedRevision: SafeInteger
+  state: AttendanceState
+  observedAt: Instant
+}
+export interface AttendanceDocument {
+  appointmentId: string
+  appointmentRevision: SafeInteger
+  revision: SafeInteger
+  state: AttendanceState
+  observedAt: Instant
+  recordedAt: Instant
+}
 
-export interface AvailabilityQuery {
+export interface AvailabilitySelection {
+  durationMinutes?: SafeInteger | null
+  resource?: string | null
+}
+export interface AvailabilityQuery extends AvailabilitySelection {
   start?: Instant | null
   end?: Instant | null
   cursor?: string | null
   limit?: SafeInteger | null
 }
 export interface PageQuery { cursor?: string | null; limit?: SafeInteger | null }
+export type OperationalTimeBasis = 'displayed' | 'occupied'
+export interface OperationalAppointmentQuery {
+  service: string
+  location: string
+  start: Instant
+  end: Instant
+  timeBasis: OperationalTimeBasis
+  offering?: string
+  state?: AppointmentState
+  resource?: string
+  externalReference?: ExternalReference
+  profile?: string
+  cursor?: string
+  limit?: SafeInteger
+}
 
 export interface SchedulingServiceDocument { schedulingId: string; policyRevision: SafeInteger; policyDigest: string }
 export interface ServiceDocument { id: string; label: string }
 export type SchedulingMode = 'exact-time' | 'arrival-window'
+export type OpeningCoverage = 'service-interval' | 'occupied-interval'
 export interface ReminderDocument { minutesBefore: SafeInteger }
+export interface DurationSelectionDocument {
+  minimumMinutes: SafeInteger
+  maximumMinutes: SafeInteger
+  incrementMinutes: SafeInteger
+}
 export interface WindowDocument { id: string; revision: SafeInteger; start: Instant; end: Instant; units: SafeInteger }
 export interface OfferingDocument {
   id: string
@@ -75,36 +202,46 @@ export interface OfferingDocument {
   label: string
   mode: SchedulingMode
   location: string
+  pool?: string
   leadTimeMinutes: SafeInteger
   horizonDays: SafeInteger
   cancellationCutoffMinutes: SafeInteger
   durationMinutes: SafeInteger | null
+  durationSelection?: DurationSelectionDocument
+  openingCoverage?: OpeningCoverage
+  allowResourceSelection?: boolean
+  partyCounts?: 'required' | 'optional'
   bufferBeforeMinutes: SafeInteger | null
   bufferAfterMinutes: SafeInteger | null
   startIncrementMinutes: SafeInteger | null
   maxRecipients: SafeInteger | null
   window: WindowDocument | null
+  windows?: ReadonlyArray<WindowDocument>
   reminders: ReadonlyArray<ReminderDocument>
   requiresCapabilities: ReadonlyArray<string>
   prerequisites: ReadonlyArray<string>
 }
-export interface ResourceDocument { resourceId: string; pool: string; capabilities: ReadonlyArray<string>; available: boolean }
+export interface ResourceDocument { resourceId: string; pool: string; capabilities: ReadonlyArray<string>; available: boolean; capacityUnits?: SafeInteger }
 export interface LocationDocument { locationId: string; timezone: string }
 
 /** Exact-time offerings answer grid slots; arrival-window offerings answer windows. */
 export type AvailabilityEntry =
-  | { kind: 'slot'; start: Instant; end: Instant; free: SafeInteger }
+  | { kind: 'slot'; start: Instant; end: Instant; free: SafeInteger; availableUnits?: SafeInteger }
   | { kind: 'window'; window: string; start: Instant; end: Instant; remaining: SafeInteger; channelRemaining: SafeInteger | null }
 
 export interface PageDocument<T> { items: ReadonlyArray<T>; nextCursor: string | null }
 
 export interface HoldDocument {
+  allocations?: ReadonlyArray<AllocationDocument>
   holdId: string
   offering: string
   start: Instant
   end: Instant
   resource: string | null
   units: SafeInteger
+  party?: PartyCounts
+  manager?: ManagerSelection
+  partyReferences?: ReadonlyArray<PartyReference>
   expiresAt: Instant
   policyRevision: SafeInteger
   externalReferences: ReadonlyArray<ExternalReference>
@@ -112,12 +249,17 @@ export interface HoldDocument {
 
 export type AppointmentState = 'confirmed' | 'cancelled'
 export interface AppointmentDocument {
+  attendance?: AttendanceDocument
+  allocations?: ReadonlyArray<AllocationDocument>
   appointmentId: string
   offering: string
   start: Instant
   end: Instant
   resource: string | null
   units: SafeInteger
+  party?: PartyCounts
+  manager?: ManagerSelection
+  partyReferences?: ReadonlyArray<PartyReference>
   channel: string | null
   revision: SafeInteger
   state: AppointmentState
@@ -126,6 +268,24 @@ export interface AppointmentDocument {
   cancelledAt: Instant | null
   externalReferences: ReadonlyArray<ExternalReference>
 }
+export interface OperationalAppointmentDocument {
+  attendance?: AttendanceDocument
+  allocations?: ReadonlyArray<OperationalAllocationDocument>
+  appointmentId: string
+  revision: SafeInteger
+  service: string
+  location: string
+  offering: string
+  state: AppointmentState
+  displayedStart: Instant
+  displayedEnd: Instant
+  occupiedStart?: Instant
+  occupiedEnd?: Instant
+  resource?: string
+  units?: SafeInteger
+  party?: PartyCounts
+  externalReferences?: ExternalReference[]
+}
 
 export interface AppointmentHistoryEntryDocument {
   eventId: string
@@ -213,7 +373,11 @@ export class SchedulingClient {
   listServices(token: string, cursor?: string | null): Promise<SchedulingOutcome<PageDocument<ServiceDocument>>>
   listOfferings(token: string, cursor?: string | null): Promise<SchedulingOutcome<PageDocument<OfferingDocument>>>
   availability(token: string, offering: string, query?: AvailabilityQuery | null): Promise<SchedulingOutcome<PageDocument<AvailabilityEntry>>>
-  explain(token: string, offering: string, start: Instant): Promise<SchedulingOutcome<ExplainDocument>>
+  previewAvailability(token: string, request: AvailabilityPreviewRequest): Promise<SchedulingOutcome<AvailabilityPreviewDocument>>
+  previewSourceBusy(token: string, profile: string, request: BusyReconciliationRequest): Promise<SchedulingOutcome<BusyReconciliationPreview>>
+  /** Apply once; recover uncertainty with the exact body and expected revision. */
+  applySourceBusy(token: string, profile: string, request: BusyReconciliationRequest): Promise<SchedulingOutcome<BusyApplyOutcome>>
+  explain(token: string, offering: string, start: Instant, selection?: AvailabilitySelection | null): Promise<SchedulingOutcome<ExplainDocument>>
   createHold(token: string, idempotencyKey: string, request: AdmissionRequest): Promise<SchedulingOutcome<HoldDocument>>
   releaseHold(token: string, holdId: string): Promise<SchedulingOutcome<null>>
   createAppointment(token: string, idempotencyKey: string, request: CreateAppointmentRequest): Promise<SchedulingOutcome<AppointmentDocument>>
@@ -221,8 +385,10 @@ export class SchedulingClient {
   appointmentReceipt(token: string, idempotencyKey: string, request: CreateAppointmentRequest): Promise<SchedulingOutcome<AppointmentDocument>>
   getAppointment(token: string, appointmentId: string): Promise<SchedulingOutcome<AppointmentDocument>>
   listAppointments(token: string, reference: ExternalReference, page?: PageQuery | null): Promise<SchedulingOutcome<PageDocument<AppointmentDocument>>>
+  listOperationalAppointments(token: string, query: OperationalAppointmentQuery): Promise<SchedulingOutcome<PageDocument<OperationalAppointmentDocument>>>
   rescheduleAppointment(token: string, appointmentId: string, idempotencyKey: string, request: RescheduleAppointmentRequest): Promise<SchedulingOutcome<AppointmentDocument>>
   cancelAppointment(token: string, appointmentId: string, idempotencyKey: string, request: CancelAppointmentRequest): Promise<SchedulingOutcome<AppointmentDocument>>
+  recordAttendance(token: string, appointmentId: string, idempotencyKey: string, request: RecordAttendanceRequest): Promise<SchedulingOutcome<AttendanceDocument>>
   appointmentHistory(token: string, appointmentId: string, cursor?: string | null): Promise<SchedulingOutcome<PageDocument<AppointmentHistoryEntryDocument>>>
   listResources(token: string, cursor?: string | null): Promise<SchedulingOutcome<PageDocument<ResourceDocument>>>
   listLocations(token: string, cursor?: string | null): Promise<SchedulingOutcome<PageDocument<LocationDocument>>>

package/scheduling/client.js

@@ -114,15 +114,20 @@ for (const [method, jsonIndexes] of [
   ['listServices', []],
   ['listOfferings', []],
   ['availability', [2]],
-  ['explain', []],
+  ['previewAvailability', [1]],
+  ['previewSourceBusy', [2]],
+  ['applySourceBusy', [2]],
+  ['explain', [3]],
   ['createHold', [2]],
   ['releaseHold', []],
   ['createAppointment', [2]],
   ['appointmentReceipt', [2]],
   ['getAppointment', []],
   ['listAppointments', [1, 2]],
+  ['listOperationalAppointments', [1]],
   ['rescheduleAppointment', [3]],
   ['cancelAppointment', [3]],
+  ['recordAttendance', [3]],
   ['appointmentHistory', []],
   ['listResources', []],
   ['listLocations', []],

package/scheduling/index.d.ts

@@ -7,15 +7,20 @@ export declare class SchedulingClient {
   listServices(token: string, cursor?: string | undefined | null): Promise<SchedulingOutcome>
   listOfferings(token: string, cursor?: string | undefined | null): Promise<SchedulingOutcome>
   availability(token: string, offering: string, query?: any | undefined | null): Promise<SchedulingOutcome>
-  explain(token: string, offering: string, start: string): Promise<SchedulingOutcome>
+  previewAvailability(token: string, request: any): Promise<SchedulingOutcome>
+  previewSourceBusy(token: string, profile: string, request: any): Promise<SchedulingOutcome>
+  applySourceBusy(token: string, profile: string, request: any): Promise<SchedulingOutcome>
+  explain(token: string, offering: string, start: string, selection?: any | undefined | null): Promise<SchedulingOutcome>
   createHold(token: string, idempotencyKey: string, request: any): Promise<SchedulingOutcome>
   releaseHold(token: string, holdId: string): Promise<SchedulingOutcome>
   createAppointment(token: string, idempotencyKey: string, request: any): Promise<SchedulingOutcome>
   appointmentReceipt(token: string, idempotencyKey: string, request: any): Promise<SchedulingOutcome>
   getAppointment(token: string, appointmentId: string): Promise<SchedulingOutcome>
   listAppointments(token: string, reference: any, page?: any | undefined | null): Promise<SchedulingOutcome>
+  listOperationalAppointments(token: string, query: any): Promise<SchedulingOutcome>
   rescheduleAppointment(token: string, appointmentId: string, idempotencyKey: string, request: any): Promise<SchedulingOutcome>
   cancelAppointment(token: string, appointmentId: string, idempotencyKey: string, request: any): Promise<SchedulingOutcome>
+  recordAttendance(token: string, appointmentId: string, idempotencyKey: string, request: any): Promise<SchedulingOutcome>
   appointmentHistory(token: string, appointmentId: string, cursor?: string | undefined | null): Promise<SchedulingOutcome>
   listResources(token: string, cursor?: string | undefined | null): Promise<SchedulingOutcome>
   listLocations(token: string, cursor?: string | undefined | null): Promise<SchedulingOutcome>