Skip to content

masterplan-optimizer-frontend


masterplan-optimizer-frontend / publishStateApi

Variable: publishStateApi

const publishStateApi: object

Defined in: src/lib/api.ts:1976

Client wrapper for persisted, non-sensitive event publish state.

Type Declaration

clear

clear: (eventId) => Promise\<void>

Clear one event's publish state, for resets or destructive data workflows.

Parameters

eventId

number

Returns

Promise\<void>

get

get: (eventId) => Promise\<EventPublishState>

Fetch one event's publish confidence metadata from the backend database.

Parameters

eventId

number

Returns

Promise\<EventPublishState>

recordFailure

recordFailure: (eventId, payload) => Promise\<EventPublishState>

Record a failed publish attempt for the affected days.

Parameters

eventId

number

payload

EventPublishFailurePayload

Returns

Promise\<EventPublishState>

save

save: (eventId, payload) => Promise\<EventPublishState>

Save the full publish state after a successful publish action.

Parameters

eventId

number

payload

EventPublishStateSavePayload

Returns

Promise\<EventPublishState>