/**
 * Generated by orval v8.19.0 🍺
 * Do not edit manually.
 * Webitel API
 * OpenAPI spec version: 24.04.0
 */
import * as zod from 'zod';

/**
 * | Field       | Type
 * | ----------- | ----
 * | **----------- READ-ONLY -----------** |
 * | `id`        | int64
 * | `ver`       | int32
 * | `etag`      | string
 * | **---------- OPERATIONAL ----------** |
 * | `created_at` | int64(epoch:milli)
 * | `created_by` | lookup(user)
 * | `updated_at` | int64(epoch:milli)
 * | `updated_by` | lookup(user)
 * | **---------- ATTRIBUTES -----------** |
 * | `name`      | name!
 * | `home_page`   | string (home_page)
 * | `state`       | bool
 * | `has_children`| bool
 */
export const listSpacesSpacesQuerySortItemDefault = `id`;
export const listSpacesSpacesQuerySortItemRegExp = /^[+|-|!]?\w+$/;
export const listSpacesSpacesQueryFieldsItemDefault = `*`;

export const ListSpacesSpacesQueryParams = zod.object({
	page: zod.number().optional(),
	size: zod
		.number()
		.optional()
		.describe(
			'Limit of result page records count.   _default(16); limit=(size<=0?-1:size+1);_\n\n```javascript\nconst\n    default = 16\n  , maximum = 32\n;\n\n```',
		),
	q: zod
		.string()
		.optional()
		.describe(
			'Search term:\n`?` - matches any character\n`*` - matches 0 or more characters\nUsed to query records within a set of `qin` fields, eg: name, etc...',
		),
	sort: zod
		.array(
			zod
				.string()
				.regex(listSpacesSpacesQuerySortItemRegExp)
				.default(listSpacesSpacesQuerySortItemDefault),
		)
		.optional()
		.describe(
			'Sort result dataset of records by fields.\n```\nsort ::= *( ORDER name )\n\nORDER  = ASC / DESC\nDESC   = "-" / "!"\nASC    = [ "+" ]   ; Default\n```\n\nFields available\n\n- `id`(seq)\n- `domain`{name}\n- `state`',
		),
	fields: zod
		.array(zod.string().default(listSpacesSpacesQueryFieldsItemDefault))
		.optional(),
	id: zod
		.array(zod.string())
		.optional()
		.describe('Records with unique IDentifier(s).\nAccept: `id` -or- `etag`.'),
});

export const ListSpacesSpacesResponse = zod.object({
	data: zod
		.array(
			zod.object({
				createdAt: zod
					.string()
					.optional()
					.describe('The timestamp when the space was created (in Unix time).'),
				createdBy: zod
					.object({
						id: zod.string().optional().describe('Reference Object unique ID.'),
						name: zod
							.string()
							.optional()
							.describe('Reference Object display name.'),
						type: zod
							.string()
							.optional()
							.describe('Reference Object well-known type.'),
					})
					.optional()
					.describe('The user who created the space.'),
				domain: zod
					.object({
						id: zod.string().optional().describe('Reference Object unique ID.'),
						name: zod
							.string()
							.optional()
							.describe('Reference Object display name.'),
						type: zod
							.string()
							.optional()
							.describe('Reference Object well-known type.'),
					})
					.optional()
					.describe("READONLY. The space's metadata."),
				etag: zod
					.string()
					.optional()
					.describe(
						'Unique ID of the latest version of the update.\nThis ID changes after any update to the underlying value(s).',
					),
				hasChildren: zod
					.boolean()
					.optional()
					.describe('Indicates if the space has children.'),
				homePage: zod
					.string()
					.optional()
					.describe('BIO. Short description about the space.'),
				id: zod
					.string()
					.optional()
					.describe('The unique ID of the association. Never changes.'),
				mode: zod
					.string()
					.optional()
					.describe('[R]ecord[b]ased[A]ccess[C]ontrol mode granted.'),
				name: zod.string().optional().describe('The name of the space.'),
				state: zod.boolean().optional().describe('The state of the space.'),
				updatedAt: zod
					.string()
					.optional()
					.describe(
						'The timestamp when the space was last updated (in Unix time).',
					),
				updatedBy: zod
					.object({
						id: zod.string().optional().describe('Reference Object unique ID.'),
						name: zod
							.string()
							.optional()
							.describe('Reference Object display name.'),
						type: zod
							.string()
							.optional()
							.describe('Reference Object well-known type.'),
					})
					.optional()
					.describe('The user who last updated the space.'),
				ver: zod
					.number()
					.optional()
					.describe(
						'READONLY. Operational attributes\nVersion of the latest update. Numeric sequence.',
					),
			}),
		)
		.optional()
		.describe('Space(s) dataset page.'),
	next: zod.boolean().optional(),
	page: zod
		.number()
		.optional()
		.describe('The page number of the partial result.'),
});

/**
 * @summary Create NEW Space
 */
export const CreateSpaceSpacesQueryParams = zod.object({
	fields: zod
		.array(zod.string())
		.optional()
		.describe('Source Fields to return into result.'),
});

export const CreateSpaceSpacesBodyItem = zod
	.object({
		etag: zod
			.string()
			.optional()
			.describe('Unique ID of the latest version of an existing resorce.'),
		homePage: zod
			.string()
			.optional()
			.describe(
				'BIO. Short description about the space.\nOPTIONAL. Multi-lined text.',
			),
		name: zod
			.string()
			.optional()
			.describe('Represents the name of the knowledge base space.'),
		state: zod.boolean().optional().describe('The state of the space.'),
	})
	.describe('The Space principal input.');
export const CreateSpaceSpacesBody = zod.array(CreateSpaceSpacesBodyItem);

export const CreateSpaceSpacesResponse = zod.object({
	createdAt: zod
		.string()
		.optional()
		.describe('The timestamp when the space was created (in Unix time).'),
	createdBy: zod
		.object({
			id: zod.string().optional().describe('Reference Object unique ID.'),
			name: zod.string().optional().describe('Reference Object display name.'),
			type: zod
				.string()
				.optional()
				.describe('Reference Object well-known type.'),
		})
		.optional()
		.describe('The user who created the space.'),
	domain: zod
		.object({
			id: zod.string().optional().describe('Reference Object unique ID.'),
			name: zod.string().optional().describe('Reference Object display name.'),
			type: zod
				.string()
				.optional()
				.describe('Reference Object well-known type.'),
		})
		.optional()
		.describe("READONLY. The space's metadata."),
	etag: zod
		.string()
		.optional()
		.describe(
			'Unique ID of the latest version of the update.\nThis ID changes after any update to the underlying value(s).',
		),
	hasChildren: zod
		.boolean()
		.optional()
		.describe('Indicates if the space has children.'),
	homePage: zod
		.string()
		.optional()
		.describe('BIO. Short description about the space.'),
	id: zod
		.string()
		.optional()
		.describe('The unique ID of the association. Never changes.'),
	mode: zod
		.string()
		.optional()
		.describe('[R]ecord[b]ased[A]ccess[C]ontrol mode granted.'),
	name: zod.string().optional().describe('The name of the space.'),
	state: zod.boolean().optional().describe('The state of the space.'),
	updatedAt: zod
		.string()
		.optional()
		.describe('The timestamp when the space was last updated (in Unix time).'),
	updatedBy: zod
		.object({
			id: zod.string().optional().describe('Reference Object unique ID.'),
			name: zod.string().optional().describe('Reference Object display name.'),
			type: zod
				.string()
				.optional()
				.describe('Reference Object well-known type.'),
		})
		.optional()
		.describe('The user who last updated the space.'),
	ver: zod
		.number()
		.optional()
		.describe(
			'READONLY. Operational attributes\nVersion of the latest update. Numeric sequence.',
		),
});

/**
 * @summary Remove Space source
 */
export const DeleteSpaceSpacesParams = zod.object({
	etag: zod.string().describe('Unique ID of the latest version of a resource.'),
});

export const DeleteSpaceSpacesQueryParams = zod.object({
	fields: zod
		.array(zod.string())
		.optional()
		.describe('Fields to be retrieved into result of changes.'),
});

export const DeleteSpaceSpacesResponse = zod.object({
	createdAt: zod
		.string()
		.optional()
		.describe('The timestamp when the space was created (in Unix time).'),
	createdBy: zod
		.object({
			id: zod.string().optional().describe('Reference Object unique ID.'),
			name: zod.string().optional().describe('Reference Object display name.'),
			type: zod
				.string()
				.optional()
				.describe('Reference Object well-known type.'),
		})
		.optional()
		.describe('The user who created the space.'),
	domain: zod
		.object({
			id: zod.string().optional().describe('Reference Object unique ID.'),
			name: zod.string().optional().describe('Reference Object display name.'),
			type: zod
				.string()
				.optional()
				.describe('Reference Object well-known type.'),
		})
		.optional()
		.describe("READONLY. The space's metadata."),
	etag: zod
		.string()
		.optional()
		.describe(
			'Unique ID of the latest version of the update.\nThis ID changes after any update to the underlying value(s).',
		),
	hasChildren: zod
		.boolean()
		.optional()
		.describe('Indicates if the space has children.'),
	homePage: zod
		.string()
		.optional()
		.describe('BIO. Short description about the space.'),
	id: zod
		.string()
		.optional()
		.describe('The unique ID of the association. Never changes.'),
	mode: zod
		.string()
		.optional()
		.describe('[R]ecord[b]ased[A]ccess[C]ontrol mode granted.'),
	name: zod.string().optional().describe('The name of the space.'),
	state: zod.boolean().optional().describe('The state of the space.'),
	updatedAt: zod
		.string()
		.optional()
		.describe('The timestamp when the space was last updated (in Unix time).'),
	updatedBy: zod
		.object({
			id: zod.string().optional().describe('Reference Object unique ID.'),
			name: zod.string().optional().describe('Reference Object display name.'),
			type: zod
				.string()
				.optional()
				.describe('Reference Object well-known type.'),
		})
		.optional()
		.describe('The user who last updated the space.'),
	ver: zod
		.number()
		.optional()
		.describe(
			'READONLY. Operational attributes\nVersion of the latest update. Numeric sequence.',
		),
});

/**
 * @summary Locate spaces source
 */
export const LocateSpaceSpacesParams = zod.object({
	etag: zod
		.string()
		.describe(
			'The Space source IDentifier.\nAccept: `etag` (obsolete+) or `id`.',
		),
});

export const LocateSpaceSpacesQueryParams = zod.object({
	fields: zod
		.array(zod.string())
		.optional()
		.describe('Source Fields to return into result.'),
});

export const LocateSpaceSpacesResponse = zod.object({
	createdAt: zod
		.string()
		.optional()
		.describe('The timestamp when the space was created (in Unix time).'),
	createdBy: zod
		.object({
			id: zod.string().optional().describe('Reference Object unique ID.'),
			name: zod.string().optional().describe('Reference Object display name.'),
			type: zod
				.string()
				.optional()
				.describe('Reference Object well-known type.'),
		})
		.optional()
		.describe('The user who created the space.'),
	domain: zod
		.object({
			id: zod.string().optional().describe('Reference Object unique ID.'),
			name: zod.string().optional().describe('Reference Object display name.'),
			type: zod
				.string()
				.optional()
				.describe('Reference Object well-known type.'),
		})
		.optional()
		.describe("READONLY. The space's metadata."),
	etag: zod
		.string()
		.optional()
		.describe(
			'Unique ID of the latest version of the update.\nThis ID changes after any update to the underlying value(s).',
		),
	hasChildren: zod
		.boolean()
		.optional()
		.describe('Indicates if the space has children.'),
	homePage: zod
		.string()
		.optional()
		.describe('BIO. Short description about the space.'),
	id: zod
		.string()
		.optional()
		.describe('The unique ID of the association. Never changes.'),
	mode: zod
		.string()
		.optional()
		.describe('[R]ecord[b]ased[A]ccess[C]ontrol mode granted.'),
	name: zod.string().optional().describe('The name of the space.'),
	state: zod.boolean().optional().describe('The state of the space.'),
	updatedAt: zod
		.string()
		.optional()
		.describe('The timestamp when the space was last updated (in Unix time).'),
	updatedBy: zod
		.object({
			id: zod.string().optional().describe('Reference Object unique ID.'),
			name: zod.string().optional().describe('Reference Object display name.'),
			type: zod
				.string()
				.optional()
				.describe('Reference Object well-known type.'),
		})
		.optional()
		.describe('The user who last updated the space.'),
	ver: zod
		.number()
		.optional()
		.describe(
			'READONLY. Operational attributes\nVersion of the latest update. Numeric sequence.',
		),
});

/**
 * @summary NEW Update of the Space source
 */
export const UpdateSpaceSpacesParams = zod.object({
	etag: zod
		.string()
		.describe('Unique ID of the latest version of an existing resorce.'),
});

export const UpdateSpaceSpacesQueryParams = zod.object({
	fields: zod
		.array(zod.string())
		.optional()
		.describe('Source Fields to return into result.'),
});

export const UpdateSpaceSpacesBody = zod.object({
	homePage: zod
		.string()
		.optional()
		.describe(
			'BIO. Short description about the space.\nOPTIONAL. Multi-lined text.',
		),
	name: zod
		.string()
		.optional()
		.describe('Represents the name of the knowledge base space.'),
	state: zod.boolean().optional().describe('The state of the space.'),
});

export const UpdateSpaceSpacesResponse = zod.object({
	createdAt: zod
		.string()
		.optional()
		.describe('The timestamp when the space was created (in Unix time).'),
	createdBy: zod
		.object({
			id: zod.string().optional().describe('Reference Object unique ID.'),
			name: zod.string().optional().describe('Reference Object display name.'),
			type: zod
				.string()
				.optional()
				.describe('Reference Object well-known type.'),
		})
		.optional()
		.describe('The user who created the space.'),
	domain: zod
		.object({
			id: zod.string().optional().describe('Reference Object unique ID.'),
			name: zod.string().optional().describe('Reference Object display name.'),
			type: zod
				.string()
				.optional()
				.describe('Reference Object well-known type.'),
		})
		.optional()
		.describe("READONLY. The space's metadata."),
	etag: zod
		.string()
		.optional()
		.describe(
			'Unique ID of the latest version of the update.\nThis ID changes after any update to the underlying value(s).',
		),
	hasChildren: zod
		.boolean()
		.optional()
		.describe('Indicates if the space has children.'),
	homePage: zod
		.string()
		.optional()
		.describe('BIO. Short description about the space.'),
	id: zod
		.string()
		.optional()
		.describe('The unique ID of the association. Never changes.'),
	mode: zod
		.string()
		.optional()
		.describe('[R]ecord[b]ased[A]ccess[C]ontrol mode granted.'),
	name: zod.string().optional().describe('The name of the space.'),
	state: zod.boolean().optional().describe('The state of the space.'),
	updatedAt: zod
		.string()
		.optional()
		.describe('The timestamp when the space was last updated (in Unix time).'),
	updatedBy: zod
		.object({
			id: zod.string().optional().describe('Reference Object unique ID.'),
			name: zod.string().optional().describe('Reference Object display name.'),
			type: zod
				.string()
				.optional()
				.describe('Reference Object well-known type.'),
		})
		.optional()
		.describe('The user who last updated the space.'),
	ver: zod
		.number()
		.optional()
		.describe(
			'READONLY. Operational attributes\nVersion of the latest update. Numeric sequence.',
		),
});