@webitel/api-services 26.8.47 → 26.8.49

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webitel/api-services",
-	"version": "26.8.47",
+	"version": "26.8.49",
 	"private": false,
 	"repository": {
 		"type": "git",

package/src/api/clients/catalog/__tests__/catalog.spec.ts

@@ -0,0 +1,79 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+
+const catalogGetHistory = vi.fn(() =>
+	Promise.resolve({
+		data: {
+			messages: [
+				{
+					id: 'm1',
+					from: {
+						id: 1,
+					},
+				},
+			],
+			peers: [
+				{
+					id: 'p1',
+				},
+			],
+			next: true,
+		},
+	}),
+);
+
+vi.mock('../../../../gen-wire', async (importOriginal) => ({
+	...(await importOriginal<Record<string, unknown>>()),
+	getMessages: () => ({
+		catalogGetHistory,
+	}),
+}));
+
+const { CatalogAPI } = await import('../catalog');
+
+/**
+ * The endpoint pages with `limit` and an `offset.date` cursor. Dropping either
+ * silently returns the newest page every time, and dropping `next` leaves the
+ * caller unable to tell there is more (WTEL-10384).
+ */
+describe('CatalogAPI.getChatMessagesList', () => {
+	beforeEach(() => catalogGetHistory.mockClear());
+
+	it('sends the cursor and limit when given, and neither when not', async () => {
+		await CatalogAPI.getChatMessagesList({
+			chatId: 'chat-1',
+			offsetDate: '1700000000000',
+			limit: 20,
+		});
+
+		expect(catalogGetHistory).toHaveBeenCalledWith('chat-1', {
+			'offset.date': '1700000000000',
+			limit: 20,
+		});
+
+		await CatalogAPI.getChatMessagesList({
+			chatId: 'chat-1',
+		});
+
+		// not the string 'undefined', which is what String(offsetDate) would send
+		expect(catalogGetHistory).toHaveBeenLastCalledWith('chat-1', {
+			'offset.date': undefined,
+			limit: undefined,
+		});
+	});
+
+	it('returns next alongside the merged messages', async () => {
+		const response = await CatalogAPI.getChatMessagesList({
+			chatId: 'chat-1',
+		});
+
+		expect(response.next).toBe(true);
+		expect(response.items).toEqual([
+			{
+				id: 'm1',
+				peer: {
+					id: 'p1',
+				},
+			},
+		]);
+	});
+});

package/src/api/clients/catalog/catalog.ts

@@ -2,7 +2,16 @@ import { getMessages } from '../../../gen-wire';
 import { applyTransform, notify, snakeToCamel } from '../../transformers';
 import type { ApiId, ApiParams } from '../_shared/types';
 
-const getChatMessagesList = async ({ chatId }: { chatId: ApiId }) => {
+const getChatMessagesList = async ({
+	chatId,
+	offsetDate,
+	limit,
+}: {
+	chatId: ApiId;
+	// messages sent strictly before this epoch(milli)
+	offsetDate?: ApiId;
+	limit?: number;
+}) => {
 	const mergeMessagesData = ({
 		messages,
 		peers,
@@ -20,8 +29,11 @@ const getChatMessagesList = async ({ chatId }: { chatId: ApiId }) => {
 	};
 
 	try {
-		const response = await getMessages().catalogGetHistory(String(chatId));
-		const { messages, peers } = applyTransform(response.data, [
+		const response = await getMessages().catalogGetHistory(String(chatId), {
+			'offset.date': offsetDate ? String(offsetDate) : undefined,
+			limit,
+		});
+		const { messages, peers, next } = applyTransform(response.data, [
 			snakeToCamel(),
 		]);
 		return {
@@ -35,6 +47,7 @@ const getChatMessagesList = async ({ chatId }: { chatId: ApiId }) => {
 				],
 			),
 			peers,
+			next: !!next,
 		};
 	} catch (err) {
 		throw applyTransform(err, [

package/src/api/clients/media/media.ts

@@ -122,6 +122,11 @@ export const getCallMediaUrl = (
 	return `${baseUrl}/storage/recordings/${id}/${download ? 'download' : 'stream'}?access_token=${accessToken}`;
 };
 
+export const getMediaStreamUrl = (id: ApiId) => {
+	const accessToken = localStorage.getItem('access-token');
+	return `${baseUrl}/storage/media/${id}/stream?access_token=${accessToken}`;
+};
+
 export const getMediaUrl = (id: ApiId, isThumb: boolean = false) => {
 	const accessToken = localStorage.getItem('access-token'); // after auth token variable is null
 	const url = `${baseUrl}/storage/file/${id}/stream?access_token=${accessToken}&fetch_thumbnail=${isThumb}`;

package/src/gen/_models/apiUserSetting.ts

@@ -7,4 +7,5 @@
 
 export interface ApiUserSetting {
 	key?: string;
+	value?: unknown;
 }

package/src/gen/_models/deleteMediaFileParams.ts

@@ -7,4 +7,5 @@
 
 export type DeleteMediaFileParams = {
 	domainId?: string;
+	force?: boolean;
 };

package/src/gen/_models/deleteRoleParams.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+
+export type DeleteRoleParams = {
+	/**
+	 * POST /roles/delete {"ids"}
+	 */
+	ids?: string[];
+	/**
+	 * deleteOrMark 'deleted' ?
+	 */
+	permanent?: boolean;
+};

package/src/gen/_models/engineAttemptHistory.ts

@@ -18,6 +18,7 @@ export interface EngineAttemptHistory {
 	channel?: string;
 	destination?: EngineMemberCommunication;
 	display?: string;
+	duration?: string;
 	id?: string;
 	joinedAt?: string;
 	leavingAt?: string;

package/src/gen/_models/engineCreateRoutingSchemaRequest.ts

@@ -13,5 +13,6 @@ export interface EngineCreateRoutingSchemaRequest {
 	description?: string;
 	editor?: boolean;
 	name?: string;
+	schema?: unknown;
 	type?: EngineRoutingSchemaType;
 }

package/src/gen/_models/engineCreateSchemaVariableRequest.ts

@@ -8,4 +8,5 @@
 export interface EngineCreateSchemaVariableRequest {
 	encrypt?: boolean;
 	name?: string;
+	value?: unknown;
 }

package/src/gen/_models/engineCreateSystemSettingRequest.ts

@@ -8,4 +8,5 @@ import type { EngineSystemSettingName } from './engineSystemSettingName';
 
 export interface EngineCreateSystemSettingRequest {
 	name?: EngineSystemSettingName;
+	value?: unknown;
 }

package/src/gen/_models/engineQueueType.ts

@@ -0,0 +1,24 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+
+export type EngineQueueType =
+	(typeof EngineQueueType)[keyof typeof EngineQueueType];
+
+export const EngineQueueType = {
+	QueueTypeUnspecified: 'QUEUE_TYPE_UNSPECIFIED',
+	QueueTypeOffline: 'QUEUE_TYPE_OFFLINE',
+	QueueTypeInboundCall: 'QUEUE_TYPE_INBOUND_CALL',
+	QueueTypeIvrCall: 'QUEUE_TYPE_IVR_CALL',
+	QueueTypePreviewCall: 'QUEUE_TYPE_PREVIEW_CALL',
+	QueueTypeProgressiveCall: 'QUEUE_TYPE_PROGRESSIVE_CALL',
+	QueueTypePredictiveCall: 'QUEUE_TYPE_PREDICTIVE_CALL',
+	QueueTypeInboundChat: 'QUEUE_TYPE_INBOUND_CHAT',
+	QueueTypeAgentTask: 'QUEUE_TYPE_AGENT_TASK',
+	QueueTypeOutboundTask: 'QUEUE_TYPE_OUTBOUND_TASK',
+	QueueTypeInboundIm: 'QUEUE_TYPE_INBOUND_IM',
+	QueueTypeOutboundCall: 'QUEUE_TYPE_OUTBOUND_CALL',
+} as const;

package/src/gen/_models/engineRoutingSchema.ts

@@ -17,6 +17,7 @@ export interface EngineRoutingSchema {
 	editor?: boolean;
 	id?: string;
 	name?: string;
+	schema?: unknown;
 	type?: EngineRoutingSchemaType;
 	updatedAt?: string;
 	updatedBy?: EngineLookup;

package/src/gen/_models/engineRoutingSchemaServicePatchRoutingSchemaBody.ts

@@ -15,5 +15,6 @@ export interface EngineRoutingSchemaServicePatchRoutingSchemaBody {
 	fields?: string[];
 	name?: string;
 	note?: string;
+	schema?: unknown;
 	type?: EngineRoutingSchemaType;
 }

package/src/gen/_models/engineRoutingSchemaServiceUpdateRoutingSchemaBody.ts

@@ -14,5 +14,6 @@ export interface EngineRoutingSchemaServiceUpdateRoutingSchemaBody {
 	editor?: boolean;
 	name?: string;
 	note?: string;
+	schema?: unknown;
 	type?: EngineRoutingSchemaType;
 }

package/src/gen/_models/engineSchemaVariable.ts

@@ -9,4 +9,5 @@ export interface EngineSchemaVariable {
 	encrypt?: boolean;
 	id?: number;
 	name?: string;
+	value?: unknown;
 }

package/src/gen/_models/engineSchemaVariablesServicePatchSchemaVariableBody.ts

@@ -9,4 +9,5 @@ export interface EngineSchemaVariablesServicePatchSchemaVariableBody {
 	encrypt?: boolean;
 	fields?: string[];
 	name?: string;
+	value?: unknown;
 }

package/src/gen/_models/engineSchemaVariablesServiceUpdateSchemaVariableBody.ts

@@ -8,4 +8,5 @@
 export interface EngineSchemaVariablesServiceUpdateSchemaVariableBody {
 	encrypt?: boolean;
 	name?: string;
+	value?: unknown;
 }

package/src/gen/_models/engineSchemaVersion.ts

@@ -11,6 +11,7 @@ export interface EngineSchemaVersion {
 	createdBy?: EngineLookup;
 	id?: string;
 	note?: string;
+	schema?: unknown;
 	schemaId?: string;
 	version?: string;
 }

package/src/gen/_models/engineSearchHistoryCallRequest.ts

@@ -5,6 +5,7 @@
  * OpenAPI spec version: 24.04.0
  */
 import type { EngineFilterBetween } from './engineFilterBetween';
+import type { EngineQueueType } from './engineQueueType';
 import type { EngineSearchHistoryCallRequestVariablesString } from './engineSearchHistoryCallRequestVariablesString';
 
 export interface EngineSearchHistoryCallRequest {
@@ -22,6 +23,7 @@ export interface EngineSearchHistoryCallRequest {
 	directions?: string[];
 	domainId?: string;
 	duration?: EngineFilterBetween;
+	excludedQueueTypes?: EngineQueueType[];
 	fields?: string[];
 	fts?: string;
 	gatewayId?: string[];

package/src/gen/_models/engineSystemSetting.ts

@@ -9,4 +9,5 @@ import type { EngineSystemSettingName } from './engineSystemSettingName';
 export interface EngineSystemSetting {
 	id?: number;
 	name?: EngineSystemSettingName;
+	value?: unknown;
 }

package/src/gen/_models/engineSystemSettingServicePatchSystemSettingBody.ts

@@ -7,4 +7,5 @@
 
 export interface EngineSystemSettingServicePatchSystemSettingBody {
 	fields?: string[];
+	value?: unknown;
 }

package/src/gen/_models/engineSystemSettingServiceUpdateSystemSettingBody.ts

@@ -6,5 +6,5 @@
  */
 
 export interface EngineSystemSettingServiceUpdateSystemSettingBody {
-	[key: string]: unknown;
+	value?: unknown;
 }

package/src/gen/_models/index.ts

@@ -336,6 +336,7 @@ export * from './deletePhotoParams';
 export * from './deletePhotosParams';
 export * from './deleteQueueParams';
 export * from './deleteQueueResourceGroupParams';
+export * from './deleteRoleParams';
 export * from './deleteRoutingOutboundCallParams';
 export * from './deleteRoutingSchemaParams';
 export * from './deleteRoutingVariableParams';
@@ -681,6 +682,7 @@ export * from './engineQueueSkill';
 export * from './engineQueueSkillServiceCreateQueueSkillBody';
 export * from './engineQueueSkillServicePatchQueueSkillBody';
 export * from './engineQueueSkillServiceUpdateQueueSkillBody';
+export * from './engineQueueType';
 export * from './engineQueueVariables';
 export * from './engineQuickRepliesServicePatchQuickReplyBody';
 export * from './engineQuickRepliesServiceUpdateQuickReplyBody';
@@ -907,6 +909,7 @@ export * from './listUserAccessTokenParams';
 export * from './listVariablesParams';
 export * from './listVersionsParams';
 export * from './locateArticleArticlesParams';
+export * from './locateArticleParams';
 export * from './locateCaseNeighborDirection';
 export * from './locateCaseNeighborParams';
 export * from './locateCaseParams';
@@ -1010,6 +1013,7 @@ export * from './readOutboundResourceParams';
 export * from './readPasswordSettingsParams';
 export * from './readQueueParams';
 export * from './readQueueResourceGroupParams';
+export * from './readRoleParams';
 export * from './readRoutingOutboundCallParams';
 export * from './readRoutingSchemaParams';
 export * from './readRoutingVariableParams';
@@ -1025,6 +1029,7 @@ export * from './resetMembersCountParams';
 export * from './resetPhonesParams';
 export * from './resetTimezonesParams';
 export * from './resetVariablesParams';
+export * from './roleMetadataParams';
 export * from './rolesUpdateRoleBody';
 export * from './rolesUpdateRoleBodyBody';
 export * from './rolesUpdateRoleBodyRole';
@@ -1076,6 +1081,7 @@ export * from './searchFilesByCallChannelItem';
 export * from './searchFilesByCallParams';
 export * from './searchFilesChannelItem';
 export * from './searchFilesParams';
+export * from './searchHistoryCallExcludedQueueTypesItem';
 export * from './searchHistoryCallParams';
 export * from './searchImportTemplateParams';
 export * from './searchLDAPCatalogParams';
@@ -1107,10 +1113,12 @@ export * from './searchQueueResourceGroupParams';
 export * from './searchQueueSkillParams';
 export * from './searchQueueTagsParams';
 export * from './searchQuickRepliesParams';
+export * from './searchRecordAvailableRolesParams';
 export * from './searchRecordsParams';
 export * from './searchRegionParams';
 export * from './searchRetrievalParams';
 export * from './searchRetrievalTagMatch';
+export * from './searchRolesParams';
 export * from './searchRoutingOutboundCallParams';
 export * from './searchRoutingSchemaParams';
 export * from './searchRoutingSchemaTagsParams';
@@ -1268,8 +1276,10 @@ export * from './update2Body';
 export * from './update2Params';
 export * from './update200';
 export * from './update2200';
+export * from './updateArticle2Params';
 export * from './updateArticleArticlesBody';
 export * from './updateArticleArticlesParams';
+export * from './updateArticleParams';
 export * from './updateBody';
 export * from './updateCase2Body';
 export * from './updateCase2BodyCustom';
@@ -1330,6 +1340,8 @@ export * from './updateManager2Params';
 export * from './updateManagerBody';
 export * from './updateManagerInputBody';
 export * from './updateManagerParams';
+export * from './updateModel2Params';
+export * from './updateModelParams';
 export * from './updateOAuthService2Params';
 export * from './updateOAuthServiceParams';
 export * from './updateParams';
@@ -1362,6 +1374,8 @@ export * from './updateSLAConditionParams';
 export * from './updateSLAParams';
 export * from './updateSource2Params';
 export * from './updateSourceParams';
+export * from './updateSpace2Params';
+export * from './updateSpaceParams';
 export * from './updateSpaceSpacesBody';
 export * from './updateSpaceSpacesParams';
 export * from './updateStatus2Params';
@@ -1411,6 +1425,8 @@ export * from './webitelCasesCaseLinkList';
 export * from './webitelCasesCaseList';
 export * from './webitelCasesCaseNavDirection';
 export * from './webitelCasesCaseTimelineEventType';
+export * from './webitelCasesCaseTimelinePostprocessingResult';
+export * from './webitelCasesCaseTimelineVariable';
 export * from './webitelCasesCatalog';
 export * from './webitelCasesCatalogList';
 export * from './webitelCasesChatEvent';
@@ -1427,6 +1443,7 @@ export * from './webitelCasesExportCasesResponse';
 export * from './webitelCasesFieldChange';
 export * from './webitelCasesFile';
 export * from './webitelCasesGetTimelineCounterResponse';
+export * from './webitelCasesGetTimelineItemInfoResponse';
 export * from './webitelCasesGetTimelineResponse';
 export * from './webitelCasesInputCase';
 export * from './webitelCasesInputCaseArticle';
@@ -1622,6 +1639,8 @@ export * from './webitelImApiGatewayV1GetContactSettingsResponse';
 export * from './webitelImApiGatewayV1GetMessageRevisionsResponse';
 export * from './webitelImApiGatewayV1GetThreadPermissionsResponse';
 export * from './webitelImApiGatewayV1GetUnreadSummaryResponse';
+export * from './webitelImApiGatewayV1GetUpdatesRequest';
+export * from './webitelImApiGatewayV1GetUpdatesResponse';
 export * from './webitelImApiGatewayV1HistoryMessage';
 export * from './webitelImApiGatewayV1HistoryMessageCursorRequest';
 export * from './webitelImApiGatewayV1HistoryMessageCursorResponse';
@@ -1645,13 +1664,12 @@ export * from './webitelImApiGatewayV1KeyboardMarkup';
 export * from './webitelImApiGatewayV1KeyboardRow';
 export * from './webitelImApiGatewayV1KeyboardRowWithSection';
 export * from './webitelImApiGatewayV1LogoutResponse';
+export * from './webitelImApiGatewayV1MemberReadState';
 export * from './webitelImApiGatewayV1MenuPlacement';
 export * from './webitelImApiGatewayV1MessageContact';
-export * from './webitelImApiGatewayV1MessageDeliveryStatus';
 export * from './webitelImApiGatewayV1MessageEditMessageBody';
 export * from './webitelImApiGatewayV1MessageLocation';
 export * from './webitelImApiGatewayV1MessageReaction';
-export * from './webitelImApiGatewayV1MessageRecipientStatus';
 export * from './webitelImApiGatewayV1MessageRevision';
 export * from './webitelImApiGatewayV1MessageRevisionAction';
 export * from './webitelImApiGatewayV1MessageSendInteractiveCallbackBody';
@@ -1700,16 +1718,21 @@ export * from './webitelImApiGatewayV1ThreadManagementFlushVariablesBody';
 export * from './webitelImApiGatewayV1ThreadManagementSetVariablesBody';
 export * from './webitelImApiGatewayV1ThreadManagementTransferBody';
 export * from './webitelImApiGatewayV1ThreadMember';
+export * from './webitelImApiGatewayV1ThreadMemberChange';
+export * from './webitelImApiGatewayV1ThreadMemberChangeAction';
 export * from './webitelImApiGatewayV1ThreadPermissions';
 export * from './webitelImApiGatewayV1ThreadRole';
 export * from './webitelImApiGatewayV1ThreadSettings';
 export * from './webitelImApiGatewayV1ThreadTagManagementAddTagBody';
+export * from './webitelImApiGatewayV1ThreadUpdates';
 export * from './webitelImApiGatewayV1ThreadVariables';
 export * from './webitelImApiGatewayV1ThreadVariablesVariables';
 export * from './webitelImApiGatewayV1TokenRequest';
 export * from './webitelImApiGatewayV1TransferResponse';
 export * from './webitelImApiGatewayV1UnregisterDeviceResponse';
 export * from './webitelImApiGatewayV1UpdateContactSettingsResponse';
+export * from './webitelImApiGatewayV1UpdatedMessage';
+export * from './webitelImApiGatewayV1UpdatedMessageMetadata';
 export * from './webitelImApiGatewayV1UpdateThreadPermissionsResponse';
 export * from './webitelImApiGatewayV1UserAgent';
 export * from './webitelImApiGatewayV1UserFilter';

package/src/gen/_models/locateArticleParams.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+
+export type LocateArticleParams = {
+	/**
+	 * Set of fields to return.
+	 */
+	fields?: string[];
+};

package/src/gen/_models/readRoleParams.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+
+export type ReadRoleParams = {
+	/**
+	 * select projection
+	 *
+	 * select: output (fields,...)
+	 */
+	fields?: string[];
+};

package/src/gen/_models/roleMetadataParams.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+
+export type RoleMetadataParams = {
+	/**
+	 * Optional. Unique ID of metadata role owner
+	 */
+	id?: string;
+	/**
+	 * Optional. Partial metadata document key name
+	 */
+	key?: string;
+};

package/src/gen/_models/searchHistoryCallExcludedQueueTypesItem.ts

@@ -0,0 +1,24 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+
+export type SearchHistoryCallExcludedQueueTypesItem =
+	(typeof SearchHistoryCallExcludedQueueTypesItem)[keyof typeof SearchHistoryCallExcludedQueueTypesItem];
+
+export const SearchHistoryCallExcludedQueueTypesItem = {
+	QueueTypeUnspecified: 'QUEUE_TYPE_UNSPECIFIED',
+	QueueTypeOffline: 'QUEUE_TYPE_OFFLINE',
+	QueueTypeInboundCall: 'QUEUE_TYPE_INBOUND_CALL',
+	QueueTypeIvrCall: 'QUEUE_TYPE_IVR_CALL',
+	QueueTypePreviewCall: 'QUEUE_TYPE_PREVIEW_CALL',
+	QueueTypeProgressiveCall: 'QUEUE_TYPE_PROGRESSIVE_CALL',
+	QueueTypePredictiveCall: 'QUEUE_TYPE_PREDICTIVE_CALL',
+	QueueTypeInboundChat: 'QUEUE_TYPE_INBOUND_CHAT',
+	QueueTypeAgentTask: 'QUEUE_TYPE_AGENT_TASK',
+	QueueTypeOutboundTask: 'QUEUE_TYPE_OUTBOUND_TASK',
+	QueueTypeInboundIm: 'QUEUE_TYPE_INBOUND_IM',
+	QueueTypeOutboundCall: 'QUEUE_TYPE_OUTBOUND_CALL',
+} as const;

package/src/gen/_models/searchHistoryCallParams.ts

@@ -4,6 +4,7 @@
  * Webitel API
  * OpenAPI spec version: 24.04.0
  */
+import type { SearchHistoryCallExcludedQueueTypesItem } from './searchHistoryCallExcludedQueueTypesItem';
 
 export type SearchHistoryCallParams = {
 	page?: number;
@@ -63,4 +64,5 @@ export type SearchHistoryCallParams = {
 	schemaId?: number[];
 	hasTransfer?: boolean;
 	timeline?: boolean;
+	excludedQueueTypes?: SearchHistoryCallExcludedQueueTypesItem[];
 };

package/src/gen/_models/searchRecordAvailableRolesParams.ts

@@ -0,0 +1,53 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+
+export type SearchRecordAvailableRolesParams = {
+	/**
+	 * ----- Role-specific Filters ----------------- //
+	 *
+	 * filter: .id = any(:ids...)
+	 */
+	ids?: string[];
+	/**
+	 * filter: group name like
+	 */
+	name?: string;
+	/**
+	 * Object ID
+	 */
+	userId?: string;
+	/**
+	 * Display Name
+	 */
+	userName?: string;
+	/**
+	 * filter: term of search (name, description)
+	 */
+	q?: string;
+	/**
+	 * display name
+	 */
+	recordName?: string;
+	/**
+	 * controls
+	 *
+	 * output
+	 */
+	fields?: string[];
+	/**
+	 * sort: "field" asc; "!field" desc
+	 */
+	sort?: string[];
+	/**
+	 * page number
+	 */
+	page?: number;
+	/**
+	 * page size
+	 */
+	size?: number;
+};

package/src/gen/_models/searchRetrievalParams.ts

@@ -20,9 +20,10 @@ export type SearchRetrievalParams = {
 	 */
 	tags?: string[];
 	/**
-	 * How to combine the tag filter.
+	 * How to combine the tag filter; unspecified means any.
 	 *
-	 *  - TAG_MATCH_ALL: Default: match articles having ALL listed tags (AND).
+	 *  - TAG_MATCH_UNSPECIFIED: Default mode: match articles having ANY listed tag (OR).
+	 *  - TAG_MATCH_ALL: Match articles having ALL listed tags (AND).
 	 *  - TAG_MATCH_ANY: Match articles having ANY listed tag (OR).
 	 */
 	tagMatch?: SearchRetrievalTagMatch;

package/src/gen/_models/searchRetrievalTagMatch.ts

@@ -9,6 +9,7 @@ export type SearchRetrievalTagMatch =
 	(typeof SearchRetrievalTagMatch)[keyof typeof SearchRetrievalTagMatch];
 
 export const SearchRetrievalTagMatch = {
+	TagMatchUnspecified: 'TAG_MATCH_UNSPECIFIED',
 	TagMatchAll: 'TAG_MATCH_ALL',
 	TagMatchAny: 'TAG_MATCH_ANY',
 } as const;