Schemas hooks

Hand-written shim. Implementation is generated; see ./schemas.gen. Custom hook: useListSchemaFields uses raw _fetch and is not yet in the manifest (no `fields` sub-resource on the SDK).

Hooks

useCreateSchema mutation

Create a new schema.

useCreateSchema(options?: MutationOpts<Schema, CreateSchemaParams>)

Types: Schema · CreateSchemaParams

useDeleteSchema mutation

Soft-delete a schema.

useDeleteSchema(options?: MutationOpts<SuccessResponse, string>)

Types: SuccessResponse

useListSchemaFields query

useListSchemaFields(schemaId: string, params?: Record<string, unknown>, options?: QueryOpts)

useListSchemas query

List schemas with pagination.

useListSchemas(params?: Omit<ListSchemasParams, | > & { filter?: SchemaFilter; orderBy?: SchemaOrderBy[]; } & SchemaShorthands, options?: QueryOpts<Page<Schema>>)

Types: ListSchemasParams · SchemaFilter · SchemaOrderBy · SchemaShorthands · Page · Schema

usePurgeSchema composite

Permanently delete a soft-deleted schema.

usePurgeSchema(options?: MutationOpts<SuccessResponse, PurgeSchemaParams>)

Types: SuccessResponse · PurgeSchemaParams

useRestoreSchema composite

Restore a soft-deleted schema.

useRestoreSchema(options?: MutationOpts<Schema, string>)

Types: Schema

useRetrieveSchema query

Get a single schema by ID.

useRetrieveSchema(id: string, options?: QueryOpts<Schema>)

Types: Schema

useUpdateSchema mutation

Update a schema.

useUpdateSchema(options?: MutationOpts<Schema, UpdateSchemaParams>)

Types: Schema · UpdateSchemaParams