@webitel/api-services 0.0.52 → 0.0.54

package/src/gen/extensions/extensions.msw.api.gen.ts

@@ -590,7 +590,7 @@ export const getDeleteType2ResponseMock = (
 	...overrideResponse,
 });
 
-export const getSearchTypeResponseMock = (
+export const getSearchTypeMixin3ResponseMock = (
 	overrideResponse: Partial<DataStructList> = {},
 ): DataStructList => ({
 	data: faker.helpers.arrayElement([
@@ -1170,7 +1170,7 @@ export const getSearchTypeResponseMock = (
 	...overrideResponse,
 });
 
-export const getDeleteTypeResponseMock = (
+export const getDeleteTypeMixin3ResponseMock = (
 	overrideResponse: Partial<DataStructList> = {},
 ): DataStructList => ({
 	data: faker.helpers.arrayElement([
@@ -1750,7 +1750,7 @@ export const getDeleteTypeResponseMock = (
 	...overrideResponse,
 });
 
-export const getLocateTypeMixin3ResponseMock = (
+export const getLocateTypeResponseMock = (
 	overrideResponse: Partial<ProtodataStruct> = {},
 ): ProtodataStruct => ({
 	about: faker.helpers.arrayElement([
@@ -2308,7 +2308,7 @@ export const getLocateTypeMixin3ResponseMock = (
 	...overrideResponse,
 });
 
-export const getCreateTypeMixin3ResponseMock = (
+export const getCreateTypeResponseMock = (
 	overrideResponse: Partial<ProtodataStruct> = {},
 ): ProtodataStruct => ({
 	about: faker.helpers.arrayElement([
@@ -2866,7 +2866,7 @@ export const getCreateTypeMixin3ResponseMock = (
 	...overrideResponse,
 });
 
-export const getUpdateTypeMixin3ResponseMock = (
+export const getUpdateTypeResponseMock = (
 	overrideResponse: Partial<ProtodataStruct> = {},
 ): ProtodataStruct => ({
 	about: faker.helpers.arrayElement([
@@ -3447,7 +3447,7 @@ export const getDeleteType2MockHandler = (
 	});
 };
 
-export const getSearchTypeMockHandler = (
+export const getSearchTypeMixin3MockHandler = (
 	overrideResponse?:
 		| DataStructList
 		| ((
@@ -3463,14 +3463,14 @@ export const getSearchTypeMockHandler = (
 					? typeof overrideResponse === 'function'
 						? await overrideResponse(info)
 						: overrideResponse
-					: getSearchTypeResponseMock(),
+					: getSearchTypeMixin3ResponseMock(),
 			),
 			{ status: 200, headers: { 'Content-Type': 'application/json' } },
 		);
 	});
 };
 
-export const getDeleteTypeMockHandler = (
+export const getDeleteTypeMixin3MockHandler = (
 	overrideResponse?:
 		| DataStructList
 		| ((
@@ -3486,14 +3486,14 @@ export const getDeleteTypeMockHandler = (
 					? typeof overrideResponse === 'function'
 						? await overrideResponse(info)
 						: overrideResponse
-					: getDeleteTypeResponseMock(),
+					: getDeleteTypeMixin3ResponseMock(),
 			),
 			{ status: 200, headers: { 'Content-Type': 'application/json' } },
 		);
 	});
 };
 
-export const getLocateTypeMixin3MockHandler = (
+export const getLocateTypeMockHandler = (
 	overrideResponse?:
 		| ProtodataStruct
 		| ((
@@ -3509,14 +3509,14 @@ export const getLocateTypeMixin3MockHandler = (
 					? typeof overrideResponse === 'function'
 						? await overrideResponse(info)
 						: overrideResponse
-					: getLocateTypeMixin3ResponseMock(),
+					: getLocateTypeResponseMock(),
 			),
 			{ status: 200, headers: { 'Content-Type': 'application/json' } },
 		);
 	});
 };
 
-export const getCreateTypeMixin3MockHandler = (
+export const getCreateTypeMockHandler = (
 	overrideResponse?:
 		| ProtodataStruct
 		| ((
@@ -3532,14 +3532,14 @@ export const getCreateTypeMixin3MockHandler = (
 					? typeof overrideResponse === 'function'
 						? await overrideResponse(info)
 						: overrideResponse
-					: getCreateTypeMixin3ResponseMock(),
+					: getCreateTypeResponseMock(),
 			),
 			{ status: 200, headers: { 'Content-Type': 'application/json' } },
 		);
 	});
 };
 
-export const getUpdateTypeMixin3MockHandler = (
+export const getUpdateTypeMockHandler = (
 	overrideResponse?:
 		| ProtodataStruct
 		| ((
@@ -3555,7 +3555,7 @@ export const getUpdateTypeMixin3MockHandler = (
 					? typeof overrideResponse === 'function'
 						? await overrideResponse(info)
 						: overrideResponse
-					: getUpdateTypeMixin3ResponseMock(),
+					: getUpdateTypeResponseMock(),
 			),
 			{ status: 200, headers: { 'Content-Type': 'application/json' } },
 		);
@@ -3563,9 +3563,9 @@ export const getUpdateTypeMixin3MockHandler = (
 };
 export const getExtensionsMock = () => [
 	getDeleteType2MockHandler(),
-	getSearchTypeMockHandler(),
-	getDeleteTypeMockHandler(),
-	getLocateTypeMixin3MockHandler(),
-	getCreateTypeMixin3MockHandler(),
-	getUpdateTypeMixin3MockHandler(),
+	getSearchTypeMixin3MockHandler(),
+	getDeleteTypeMixin3MockHandler(),
+	getLocateTypeMockHandler(),
+	getCreateTypeMockHandler(),
+	getUpdateTypeMockHandler(),
 ];

package/src/gen/extensions/extensions.zod.gen.ts

@@ -392,11 +392,11 @@ export const deleteType2Response = zod
  * (ExtensionList) {
  * @summary Search for type extensions.
  */
-export const searchTypeQuerySortItemDefault = '*';
-export const searchTypeQuerySortItemRegExp = /^[+|-|!]?\w+$/;
-export const searchTypeQueryFieldsItemDefault = '*';
+export const searchTypeMixin3QuerySortItemDefault = '*';
+export const searchTypeMixin3QuerySortItemRegExp = /^[+|-|!]?\w+$/;
+export const searchTypeMixin3QueryFieldsItemDefault = '*';
 
-export const searchTypeQueryParams = zod.object({
+export const searchTypeMixin3QueryParams = zod.object({
 	size: zod
 		.number()
 		.optional()
@@ -406,7 +406,7 @@ export const searchTypeQueryParams = zod.object({
 		.optional()
 		.describe('Page number of result set of records.\nDefault: 1.'),
 	sort: zod
-		.array(zod.string().regex(searchTypeQuerySortItemRegExp))
+		.array(zod.string().regex(searchTypeMixin3QuerySortItemRegExp))
 		.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- `created_at`\n- `created_by`{name}\n- `updated_at`\n- `updated_by`{name}\n\nUse ?fields=`field.sort()` option to sort Edge fields.',
@@ -426,9 +426,9 @@ export const searchTypeQueryParams = zod.object({
 	id: zod.array(zod.string()).optional().describe('extension.type.id'),
 });
 
-export const searchTypeResponseDataItemFieldsItemKindDefault = 'none';
+export const searchTypeMixin3ResponseDataItemFieldsItemKindDefault = 'none';
 
-export const searchTypeResponse = zod
+export const searchTypeMixin3Response = zod
 	.object({
 		data: zod
 			.array(
@@ -609,7 +609,9 @@ export const searchTypeResponse = zod
 												'datetime',
 												'duration',
 											])
-											.default(searchTypeResponseDataItemFieldsItemKindDefault)
+											.default(
+												searchTypeMixin3ResponseDataItemFieldsItemKindDefault,
+											)
 											.describe(
 												'Kind of primitive data types.\n\n - none: option allow_alias = true;\n - list: [array]\n - int: int32\n - uint: uint32\n - float: float32\n - datetime: date &| time',
 											),
@@ -803,17 +805,17 @@ export const searchTypeResponse = zod
  * returns (ExtensionList) {
  * @summary Delete extension for types.
  */
-export const deleteTypeParams = zod.object({
+export const deleteTypeMixin3Params = zod.object({
 	repo: zod.array(zod.string()).min(1).describe('`type.repo`'),
 });
 
-export const deleteTypeQueryParams = zod.object({
+export const deleteTypeMixin3QueryParams = zod.object({
 	fields: zod.array(zod.string()).optional(),
 });
 
-export const deleteTypeResponseDataItemFieldsItemKindDefault = 'none';
+export const deleteTypeMixin3ResponseDataItemFieldsItemKindDefault = 'none';
 
-export const deleteTypeResponse = zod
+export const deleteTypeMixin3Response = zod
 	.object({
 		data: zod
 			.array(
@@ -994,7 +996,9 @@ export const deleteTypeResponse = zod
 												'datetime',
 												'duration',
 											])
-											.default(deleteTypeResponseDataItemFieldsItemKindDefault)
+											.default(
+												deleteTypeMixin3ResponseDataItemFieldsItemKindDefault,
+											)
 											.describe(
 												'Kind of primitive data types.\n\n - none: option allow_alias = true;\n - list: [array]\n - int: int32\n - uint: uint32\n - float: float32\n - datetime: date &| time',
 											),
@@ -1188,13 +1192,13 @@ export const deleteTypeResponse = zod
  * returns (Extension) {
  * @summary Type extension details.
  */
-export const locateTypeMixin3Params = zod.object({
+export const locateTypeParams = zod.object({
 	repo: zod.string().describe('`type.repo`\n\nid'),
 });
 
-export const locateTypeMixin3ResponseFieldsItemKindDefault = 'none';
+export const locateTypeResponseFieldsItemKindDefault = 'none';
 
-export const locateTypeMixin3Response = zod
+export const locateTypeResponse = zod
 	.object({
 		about: zod.string().optional().describe('Optional. Short description.'),
 		administered: zod.boolean().optional(),
@@ -1338,7 +1342,7 @@ export const locateTypeMixin3Response = zod
 								'datetime',
 								'duration',
 							])
-							.default(locateTypeMixin3ResponseFieldsItemKindDefault)
+							.default(locateTypeResponseFieldsItemKindDefault)
 							.describe(
 								'Kind of primitive data types.\n\n - none: option allow_alias = true;\n - list: [array]\n - int: int32\n - uint: uint32\n - float: float32\n - datetime: date &| time',
 							),
@@ -1500,7 +1504,7 @@ export const locateTypeMixin3Response = zod
  * returns (Extension) {
  * @summary Create type extension.
  */
-export const createTypeMixin3Params = zod.object({
+export const createTypeParams = zod.object({
 	repo: zod
 		.string()
 		.describe(
@@ -1508,9 +1512,9 @@ export const createTypeMixin3Params = zod.object({
 		),
 });
 
-export const createTypeMixin3BodyFieldsItemKindDefault = 'none';
+export const createTypeBodyFieldsItemKindDefault = 'none';
 
-export const createTypeMixin3Body = zod.object({
+export const createTypeBody = zod.object({
 	fields: zod
 		.array(
 			zod
@@ -1633,7 +1637,7 @@ export const createTypeMixin3Body = zod.object({
 							'datetime',
 							'duration',
 						])
-						.default(createTypeMixin3BodyFieldsItemKindDefault)
+						.default(createTypeBodyFieldsItemKindDefault)
 						.describe(
 							'Kind of primitive data types.\n\n - none: option allow_alias = true;\n - list: [array]\n - int: int32\n - uint: uint32\n - float: float32\n - datetime: date &| time',
 						),
@@ -1749,9 +1753,9 @@ export const createTypeMixin3Body = zod.object({
 		.optional(),
 });
 
-export const createTypeMixin3ResponseFieldsItemKindDefault = 'none';
+export const createTypeResponseFieldsItemKindDefault = 'none';
 
-export const createTypeMixin3Response = zod
+export const createTypeResponse = zod
 	.object({
 		about: zod.string().optional().describe('Optional. Short description.'),
 		administered: zod.boolean().optional(),
@@ -1895,7 +1899,7 @@ export const createTypeMixin3Response = zod
 								'datetime',
 								'duration',
 							])
-							.default(createTypeMixin3ResponseFieldsItemKindDefault)
+							.default(createTypeResponseFieldsItemKindDefault)
 							.describe(
 								'Kind of primitive data types.\n\n - none: option allow_alias = true;\n - list: [array]\n - int: int32\n - uint: uint32\n - float: float32\n - datetime: date &| time',
 							),
@@ -2057,13 +2061,13 @@ export const createTypeMixin3Response = zod
  * returns (Extension) {
  * @summary Update type extension.
  */
-export const updateTypeMixin3Params = zod.object({
+export const updateTypeParams = zod.object({
 	repo: zod.string().describe('`type.repo`'),
 });
 
-export const updateTypeMixin3BodyFieldsItemKindDefault = 'none';
+export const updateTypeBodyFieldsItemKindDefault = 'none';
 
-export const updateTypeMixin3Body = zod.object({
+export const updateTypeBody = zod.object({
 	fields: zod
 		.array(
 			zod
@@ -2186,7 +2190,7 @@ export const updateTypeMixin3Body = zod.object({
 							'datetime',
 							'duration',
 						])
-						.default(updateTypeMixin3BodyFieldsItemKindDefault)
+						.default(updateTypeBodyFieldsItemKindDefault)
 						.describe(
 							'Kind of primitive data types.\n\n - none: option allow_alias = true;\n - list: [array]\n - int: int32\n - uint: uint32\n - float: float32\n - datetime: date &| time',
 						),
@@ -2302,9 +2306,9 @@ export const updateTypeMixin3Body = zod.object({
 		.optional(),
 });
 
-export const updateTypeMixin3ResponseFieldsItemKindDefault = 'none';
+export const updateTypeResponseFieldsItemKindDefault = 'none';
 
-export const updateTypeMixin3Response = zod
+export const updateTypeResponse = zod
 	.object({
 		about: zod.string().optional().describe('Optional. Short description.'),
 		administered: zod.boolean().optional(),
@@ -2448,7 +2452,7 @@ export const updateTypeMixin3Response = zod
 								'datetime',
 								'duration',
 							])
-							.default(updateTypeMixin3ResponseFieldsItemKindDefault)
+							.default(updateTypeResponseFieldsItemKindDefault)
 							.describe(
 								'Kind of primitive data types.\n\n - none: option allow_alias = true;\n - list: [array]\n - int: int32\n - uint: uint32\n - float: float32\n - datetime: date &| time',
 							),

package/src/gen/file-service/file-service.api.gen.ts

@@ -14,9 +14,12 @@ import type {
 	SearchScreenRecordingsParams,
 	StorageDeleteFilesRequest,
 	StorageDeleteFilesResponse,
+	StorageDeleteQuarantineFilesRequest,
 	StorageFileServiceDeleteScreenRecordingsBody,
 	StorageFileServiceDeleteScreenRecordingsByAgentBody,
 	StorageListFile,
+	StorageRestoreFilesRequest,
+	StorageRestoreFilesResponse,
 } from '.././_models';
 
 // --- header start
@@ -70,6 +73,27 @@ export const // --- title start
 					params: { ...params, ...options?.params },
 				});
 			};
+			const deleteQuarantineFiles = <
+				TData = AxiosResponse<StorageDeleteFilesResponse>,
+			>(
+				storageDeleteQuarantineFilesRequest: StorageDeleteQuarantineFilesRequest,
+				options?: AxiosRequestConfig,
+			): Promise<TData> => {
+				return axios.delete('/storage/file/quarantine', {
+					data: storageDeleteQuarantineFilesRequest,
+					...options,
+				});
+			};
+			const restoreFiles = <TData = AxiosResponse<StorageRestoreFilesResponse>>(
+				storageRestoreFilesRequest: StorageRestoreFilesRequest,
+				options?: AxiosRequestConfig,
+			): Promise<TData> => {
+				return axios.patch(
+					'/storage/file/restore',
+					storageRestoreFilesRequest,
+					options,
+				);
+			};
 			const searchScreenRecordings = <TData = AxiosResponse<StorageListFile>>(
 				userId: string,
 				params?: SearchScreenRecordingsParams,
@@ -100,6 +124,8 @@ export const // --- title start
 				deleteScreenRecordingsByAgent,
 				deleteFiles,
 				searchFiles,
+				deleteQuarantineFiles,
+				restoreFiles,
 				searchScreenRecordings,
 				deleteScreenRecordings,
 			};
@@ -110,6 +136,9 @@ export type DeleteScreenRecordingsByAgentResult =
 	AxiosResponse<StorageDeleteFilesResponse>;
 export type DeleteFilesResult = AxiosResponse<StorageDeleteFilesResponse>;
 export type SearchFilesResult = AxiosResponse<StorageListFile>;
+export type DeleteQuarantineFilesResult =
+	AxiosResponse<StorageDeleteFilesResponse>;
+export type RestoreFilesResult = AxiosResponse<StorageRestoreFilesResponse>;
 export type SearchScreenRecordingsResult = AxiosResponse<StorageListFile>;
 export type DeleteScreenRecordingsResult =
 	AxiosResponse<StorageDeleteFilesResponse>;

package/src/gen/file-service/file-service.msw.api.gen.ts

@@ -7,7 +7,11 @@
 import { faker } from '@faker-js/faker';
 
 import { delay, HttpResponse, http } from 'msw';
-import type { StorageDeleteFilesResponse, StorageListFile } from '.././_models';
+import type {
+	StorageDeleteFilesResponse,
+	StorageListFile,
+	StorageRestoreFilesResponse,
+} from '.././_models';
 import { StorageUploadFileChannel } from '.././_models';
 
 export const getSearchScreenRecordingsByAgentResponseMock = (
@@ -194,6 +198,12 @@ export const getSearchFilesResponseMock = (
 	...overrideResponse,
 });
 
+export const getDeleteQuarantineFilesResponseMock =
+	(): StorageDeleteFilesResponse => ({});
+
+export const getRestoreFilesResponseMock =
+	(): StorageRestoreFilesResponse => ({});
+
 export const getSearchScreenRecordingsResponseMock = (
 	overrideResponse: Partial<StorageListFile> = {},
 ): StorageListFile => ({
@@ -378,6 +388,52 @@ export const getSearchFilesMockHandler = (
 	});
 };
 
+export const getDeleteQuarantineFilesMockHandler = (
+	overrideResponse?:
+		| StorageDeleteFilesResponse
+		| ((
+				info: Parameters<Parameters<typeof http.delete>[1]>[0],
+		  ) => Promise<StorageDeleteFilesResponse> | StorageDeleteFilesResponse),
+) => {
+	return http.delete('*/storage/file/quarantine', async (info) => {
+		await delay(1000);
+
+		return new HttpResponse(
+			JSON.stringify(
+				overrideResponse !== undefined
+					? typeof overrideResponse === 'function'
+						? await overrideResponse(info)
+						: overrideResponse
+					: getDeleteQuarantineFilesResponseMock(),
+			),
+			{ status: 200, headers: { 'Content-Type': 'application/json' } },
+		);
+	});
+};
+
+export const getRestoreFilesMockHandler = (
+	overrideResponse?:
+		| StorageRestoreFilesResponse
+		| ((
+				info: Parameters<Parameters<typeof http.patch>[1]>[0],
+		  ) => Promise<StorageRestoreFilesResponse> | StorageRestoreFilesResponse),
+) => {
+	return http.patch('*/storage/file/restore', async (info) => {
+		await delay(1000);
+
+		return new HttpResponse(
+			JSON.stringify(
+				overrideResponse !== undefined
+					? typeof overrideResponse === 'function'
+						? await overrideResponse(info)
+						: overrideResponse
+					: getRestoreFilesResponseMock(),
+			),
+			{ status: 200, headers: { 'Content-Type': 'application/json' } },
+		);
+	});
+};
+
 export const getSearchScreenRecordingsMockHandler = (
 	overrideResponse?:
 		| StorageListFile
@@ -428,6 +484,8 @@ export const getFileServiceMock = () => [
 	getDeleteScreenRecordingsByAgentMockHandler(),
 	getDeleteFilesMockHandler(),
 	getSearchFilesMockHandler(),
+	getDeleteQuarantineFilesMockHandler(),
+	getRestoreFilesMockHandler(),
 	getSearchScreenRecordingsMockHandler(),
 	getDeleteScreenRecordingsMockHandler(),
 ];

package/src/gen/file-service/file-service.zod.gen.ts

@@ -188,6 +188,18 @@ export const searchFilesResponse = zod.object({
 	next: zod.boolean().optional(),
 });
 
+export const deleteQuarantineFilesBody = zod.object({
+	id: zod.array(zod.string()).optional(),
+});
+
+export const deleteQuarantineFilesResponse = zod.object({});
+
+export const restoreFilesBody = zod.object({
+	id: zod.array(zod.string()).optional(),
+});
+
+export const restoreFilesResponse = zod.object({});
+
 export const searchScreenRecordingsParams = zod.object({
 	user_id: zod.string(),
 });

package/types/api/clients/fileServices/fileServices.d.ts

@@ -0,0 +1,23 @@
+export declare const FileServicesAPI: {
+    getList: (params: any) => Promise<{
+        items: any;
+        next: any;
+    }>;
+    delete: (id: any) => Promise<any>;
+    getScreenRecordingsByUser: (params: any) => Promise<{
+        items: any;
+        next: any;
+    }>;
+    deleteScreenRecordingsByUser: ({ userId, id }: {
+        userId: any;
+        id: any;
+    }) => Promise<any>;
+    getScreenRecordingsByAgent: (params: any) => Promise<{
+        items: any;
+        next: any;
+    }>;
+    deleteScreenRecordingsByAgent: ({ agentId, id }: {
+        agentId: any;
+        id: any;
+    }) => Promise<any>;
+};

package/types/api/clients/index.d.ts

@@ -30,3 +30,4 @@ export * from './wtTypes/adjunctTypes/adjunctTypes';
 export * from './wtTypes/sysTypes/sysTypes';
 export * from './wtTypes/typeExtensions/typeExtensions';
 export * from './сontacts';
+export * from './fileServices/fileServices';

package/types/api/clients/media/media.d.ts

@@ -1,4 +1,6 @@
 export declare const downloadMedia: (id: any) => Promise<import("axios").AxiosResponse<any, any>>;
+export declare const downloadFile: (id: any) => void;
+export declare const getScreenRecordingMediaUrl: (id: any, isThumb?: boolean) => string;
 export declare const MediaAPI: {
     getList: (params: any) => Promise<{
         items: any;

package/types/gen/_models/deleteTypeMixin3Params.d.ts

@@ -5,15 +5,5 @@
  * OpenAPI spec version: 24.04.0
  */
 export type DeleteTypeMixin3Params = {
-    /**
-     * Fields to retrive into result dataset.
-     */
     fields?: string[];
-    /**
- * `types.repo`
-
-// `record.pk`
- repeated string id = 3;
- */
-    repo: string[];
 };

package/types/gen/_models/deleteTypeParams.d.ts

@@ -5,5 +5,15 @@
  * OpenAPI spec version: 24.04.0
  */
 export type DeleteTypeParams = {
+    /**
+     * Fields to retrive into result dataset.
+     */
     fields?: string[];
+    /**
+ * `types.repo`
+
+// `record.pk`
+ repeated string id = 3;
+ */
+    repo: string[];
 };

package/types/gen/_models/searchTypeMixin3Params.d.ts

@@ -6,49 +6,6 @@
  */
 export type SearchTypeMixin3Params = {
     /**
- * Search term:
-`?` - matches any character
-`*` - matches 0 or more characters
-e.g.: name,emails{type},labels etc...
- */
-    q?: string;
-    /**
-     * `types.id`
-     */
-    id?: string;
-    /**
-     * `types.name`
-     */
-    name?: string;
-    /**
-     * `types.repo`
-     */
-    repo?: string;
-    /**
-     * `types.path`
-     */
-    path?: string;
-    /**
-     * [NOT] [ system / custom ] types only
-     */
-    readonly?: boolean;
-    /**
-     * [NOT] Extend[able] types only.
-     */
-    extendable?: boolean;
-    /**
-     * [NOT] include extensions/* types.
-     */
-    extensions?: boolean;
-    /**
-     * [NOT] Extend[ed] types only.
-     */
-    extended?: boolean;
-    /**
-     * [NOT] Administer access control only
-     */
-    administered?: boolean;
-    /**
  * Number of result records (per page).
 Default: 16.
  */
@@ -96,4 +53,15 @@ USCORE   = %x5F ; underscore  ; "_"
 ```
  */
     fields?: string[];
+    /**
+ * Search term:
+`?` - matches any character
+`*` - matches 0 or more characters
+e.g.: name,emails{type},labels etc...
+ */
+    q?: string;
+    /**
+     * extension.type.id
+     */
+    id?: string[];
 };