Package ai.vectros.resources.schemas

Class RawSchemasClient

java.lang.Object

ai.vectros.resources.schemas.RawSchemasClient

public class RawSchemasClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawSchemasClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
VectrosApiHttpResponse<SchemaResponse>	createSchema(SchemaRequest request)	Defines a new record type with optional field definitions, validation rules, and lookup indexes.
VectrosApiHttpResponse<SchemaResponse>	createSchema(SchemaRequest request, RequestOptions requestOptions)	Defines a new record type with optional field definitions, validation rules, and lookup indexes.
VectrosApiHttpResponse<Void>	deleteSchema(String id)	Permanently deletes a record schema.
VectrosApiHttpResponse<Void>	deleteSchema(String id, RequestOptions requestOptions)	Permanently deletes a record schema.
VectrosApiHttpResponse<Void>	deleteSchema(String id, DeleteSchemaRequest request)	Permanently deletes a record schema.
VectrosApiHttpResponse<Void>	deleteSchema(String id, DeleteSchemaRequest request, RequestOptions requestOptions)	Permanently deletes a record schema.
VectrosApiHttpResponse<SchemaResponse>	getSchema(String id)	Retrieves a single record schema by its id.
VectrosApiHttpResponse<SchemaResponse>	getSchema(String id, RequestOptions requestOptions)	Retrieves a single record schema by its id.
VectrosApiHttpResponse<SchemaResponse>	getSchema(String id, GetSchemaRequest request)	Retrieves a single record schema by its id.
VectrosApiHttpResponse<SchemaResponse>	getSchema(String id, GetSchemaRequest request, RequestOptions requestOptions)	Retrieves a single record schema by its id.
VectrosApiHttpResponse<ModelDataVersionPage>	getSchemaVersions(String id)	Returns the audit trail of changes to a record schema, newest first (create, update, and delete).
VectrosApiHttpResponse<ModelDataVersionPage>	getSchemaVersions(String id, RequestOptions requestOptions)	Returns the audit trail of changes to a record schema, newest first (create, update, and delete).
VectrosApiHttpResponse<ModelDataVersionPage>	getSchemaVersions(String id, GetSchemaVersionsRequest request)	Returns the audit trail of changes to a record schema, newest first (create, update, and delete).
VectrosApiHttpResponse<ModelDataVersionPage>	getSchemaVersions(String id, GetSchemaVersionsRequest request, RequestOptions requestOptions)	Returns the audit trail of changes to a record schema, newest first (create, update, and delete).
VectrosApiHttpResponse<SchemaPage>	listSchemas()	Returns a paginated list of the record schemas defined in your account.
VectrosApiHttpResponse<SchemaPage>	listSchemas(RequestOptions requestOptions)	Returns a paginated list of the record schemas defined in your account.
VectrosApiHttpResponse<SchemaPage>	listSchemas(ListSchemasRequest request)	Returns a paginated list of the record schemas defined in your account.
VectrosApiHttpResponse<SchemaPage>	listSchemas(ListSchemasRequest request, RequestOptions requestOptions)	Returns a paginated list of the record schemas defined in your account.
VectrosApiHttpResponse<SchemaResponse>	updateSchema(String id, UpdateSchemaRequest request)	Updates a record schema.
VectrosApiHttpResponse<SchemaResponse>	updateSchema(String id, UpdateSchemaRequest request, RequestOptions requestOptions)	Updates a record schema.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

clientOptions

protected final ClientOptions clientOptions

Constructor Details

RawSchemasClient

public RawSchemasClient(ClientOptions clientOptions)

Method Details

listSchemas

public VectrosApiHttpResponse<SchemaPage> listSchemas()

Returns a paginated list of the record schemas defined in your account. Filter by userId or orgId to scope to an owner, by surface to list the types bindable to one surface, or by recordType to resolve the single schema for a type directly. Filtering by an identity surface (user, org, or client) lists your account-wide identity schemas regardless of the calling context; filtering by record or document lists within the calling context. Requires the schemas:r scope.

listSchemas

public VectrosApiHttpResponse<SchemaPage> listSchemas(RequestOptions requestOptions)

Returns a paginated list of the record schemas defined in your account. Filter by userId or orgId to scope to an owner, by surface to list the types bindable to one surface, or by recordType to resolve the single schema for a type directly. Filtering by an identity surface (user, org, or client) lists your account-wide identity schemas regardless of the calling context; filtering by record or document lists within the calling context. Requires the schemas:r scope.

listSchemas

public VectrosApiHttpResponse<SchemaPage> listSchemas(ListSchemasRequest request)

Returns a paginated list of the record schemas defined in your account. Filter by userId or orgId to scope to an owner, by surface to list the types bindable to one surface, or by recordType to resolve the single schema for a type directly. Filtering by an identity surface (user, org, or client) lists your account-wide identity schemas regardless of the calling context; filtering by record or document lists within the calling context. Requires the schemas:r scope.

listSchemas

public VectrosApiHttpResponse<SchemaPage> listSchemas(ListSchemasRequest request,
 RequestOptions requestOptions)

Returns a paginated list of the record schemas defined in your account. Filter by userId or orgId to scope to an owner, by surface to list the types bindable to one surface, or by recordType to resolve the single schema for a type directly. Filtering by an identity surface (user, org, or client) lists your account-wide identity schemas regardless of the calling context; filtering by record or document lists within the calling context. Requires the schemas:r scope.

createSchema

public VectrosApiHttpResponse<SchemaResponse> createSchema(SchemaRequest request)

Defines a new record type with optional field definitions, validation rules, and lookup indexes. Idempotent by typeName within the same ownership scope: re-creating an existing typeName returns the existing schema rather than failing. Requires the schemas:w scope.

createSchema

public VectrosApiHttpResponse<SchemaResponse> createSchema(SchemaRequest request,
 RequestOptions requestOptions)

Defines a new record type with optional field definitions, validation rules, and lookup indexes. Idempotent by typeName within the same ownership scope: re-creating an existing typeName returns the existing schema rather than failing. Requires the schemas:w scope.

getSchema

public VectrosApiHttpResponse<SchemaResponse> getSchema(String id)

Retrieves a single record schema by its id. Requires the schemas:r scope.

getSchema

public VectrosApiHttpResponse<SchemaResponse> getSchema(String id,
 RequestOptions requestOptions)

Retrieves a single record schema by its id. Requires the schemas:r scope.

getSchema

public VectrosApiHttpResponse<SchemaResponse> getSchema(String id,
 GetSchemaRequest request)

Retrieves a single record schema by its id. Requires the schemas:r scope.

getSchema

public VectrosApiHttpResponse<SchemaResponse> getSchema(String id,
 GetSchemaRequest request,
 RequestOptions requestOptions)

Retrieves a single record schema by its id. Requires the schemas:r scope.

updateSchema

public VectrosApiHttpResponse<SchemaResponse> updateSchema(String id,
 UpdateSchemaRequest request)

Updates a record schema. Fields you omit are preserved; typeName is immutable and cannot be changed. Collection fields (fields, lookupFields, renderHints, capabilities) are replaced in full when supplied. Requires the schemas:w scope.

updateSchema

public VectrosApiHttpResponse<SchemaResponse> updateSchema(String id,
 UpdateSchemaRequest request,
 RequestOptions requestOptions)

Updates a record schema. Fields you omit are preserved; typeName is immutable and cannot be changed. Collection fields (fields, lookupFields, renderHints, capabilities) are replaced in full when supplied. Requires the schemas:w scope.

deleteSchema

public VectrosApiHttpResponse<Void> deleteSchema(String id)

Permanently deletes a record schema. The request is refused with 409 if records of this type still exist — delete those records first, since every record must reference a live schema. Requires the schemas:w scope.

deleteSchema

public VectrosApiHttpResponse<Void> deleteSchema(String id,
 RequestOptions requestOptions)

Permanently deletes a record schema. The request is refused with 409 if records of this type still exist — delete those records first, since every record must reference a live schema. Requires the schemas:w scope.

deleteSchema

public VectrosApiHttpResponse<Void> deleteSchema(String id,
 DeleteSchemaRequest request)

Permanently deletes a record schema. The request is refused with 409 if records of this type still exist — delete those records first, since every record must reference a live schema. Requires the schemas:w scope.

deleteSchema

public VectrosApiHttpResponse<Void> deleteSchema(String id,
 DeleteSchemaRequest request,
 RequestOptions requestOptions)

Permanently deletes a record schema. The request is refused with 409 if records of this type still exist — delete those records first, since every record must reference a live schema. Requires the schemas:w scope.

getSchemaVersions

public VectrosApiHttpResponse<ModelDataVersionPage> getSchemaVersions(String id)

Returns the audit trail of changes to a record schema, newest first (create, update, and delete). Schema version history is always recorded — there is no per-schema toggle to disable it. Requires the schemas:r scope.

getSchemaVersions

public VectrosApiHttpResponse<ModelDataVersionPage> getSchemaVersions(String id,
 RequestOptions requestOptions)

Returns the audit trail of changes to a record schema, newest first (create, update, and delete). Schema version history is always recorded — there is no per-schema toggle to disable it. Requires the schemas:r scope.

getSchemaVersions

public VectrosApiHttpResponse<ModelDataVersionPage> getSchemaVersions(String id,
 GetSchemaVersionsRequest request)

Returns the audit trail of changes to a record schema, newest first (create, update, and delete). Schema version history is always recorded — there is no per-schema toggle to disable it. Requires the schemas:r scope.

getSchemaVersions

public VectrosApiHttpResponse<ModelDataVersionPage> getSchemaVersions(String id,
 GetSchemaVersionsRequest request,
 RequestOptions requestOptions)

Returns the audit trail of changes to a record schema, newest first (create, update, and delete). Schema version history is always recorded — there is no per-schema toggle to disable it. Requires the schemas:r scope.