@webitel/api-services 26.8.90 → 26.8.92

package/src/gen-wire/_models/webitelImApiGatewayV1Thread.ts

@@ -4,6 +4,7 @@
  * Webitel API
  * OpenAPI spec version: 24.04.0
  */
+import type { WebitelImApiGatewayV1ChatTag } from './webitelImApiGatewayV1ChatTag';
 import type { WebitelImApiGatewayV1HistoryMessage } from './webitelImApiGatewayV1HistoryMessage';
 import type { WebitelImApiGatewayV1MemberReadState } from './webitelImApiGatewayV1MemberReadState';
 import type { WebitelImApiGatewayV1ThreadKind } from './webitelImApiGatewayV1ThreadKind';
@@ -15,8 +16,15 @@ import type { WebitelImApiGatewayV1ThreadVariables } from './webitelImApiGateway
  * Thread represents a thread (aka chat or conversation) entity.
  */
 export interface WebitelImApiGatewayV1Thread {
+	/** The caller's own tags on this thread. Empty if the caller hasn't tagged it. */
+	tags?: WebitelImApiGatewayV1ChatTag[];
 	/** Thread creation timestamp (Unix time, milliseconds). */
 	created_at?: string;
+	/**
+	 * Webitel CRM contact selected by an operator for this thread.
+	 * Empty if no CRM contact has been selected.
+	 */
+	crm_contact_id?: string;
 	/** Optional thread description. */
 	description?: string;
 	/** Unique thread identifier. */

package/src/gen-wire/_models/webitelImApiGatewayV1ThreadManagementSetCrmContactBody.ts

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+
+export interface WebitelImApiGatewayV1ThreadManagementSetCrmContactBody {
+	/** Webitel CRM contact id. Empty string clears the selection. */
+	crm_contact_id?: string;
+}

package/src/gen-wire/_models/webitelImApiGatewayV1ThreadTags.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+
+/**
+ * ThreadTags is the caller's own tags on a thread.
+ */
+export interface WebitelImApiGatewayV1ThreadTags {
+	items?: string[];
+}

package/src/gen-wire/_models/webitelImApiGatewayV1ThreadUpdates.ts

@@ -4,15 +4,26 @@
  * Webitel API
  * OpenAPI spec version: 24.04.0
  */
+import type { WebitelImApiGatewayV1DeletedMessage } from './webitelImApiGatewayV1DeletedMessage';
 import type { WebitelImApiGatewayV1MemberReadState } from './webitelImApiGatewayV1MemberReadState';
 import type { WebitelImApiGatewayV1Thread } from './webitelImApiGatewayV1Thread';
 import type { WebitelImApiGatewayV1ThreadMemberChange } from './webitelImApiGatewayV1ThreadMemberChange';
+import type { WebitelImApiGatewayV1ThreadTags } from './webitelImApiGatewayV1ThreadTags';
 import type { WebitelImApiGatewayV1UpdatedMessage } from './webitelImApiGatewayV1UpdatedMessage';
 
 export interface WebitelImApiGatewayV1ThreadUpdates {
+	/**
+	 * The caller's current tags on the thread, set only when they changed since cursor; replace the
+	 * cached ones. Absent means unchanged, empty items means every tag was removed.
+	 */
+	tags?: WebitelImApiGatewayV1ThreadTags;
+	/** Ids of deleted_messages, kept for older clients; prefer deleted_messages. */
 	deleted_message_ids?: string[];
+	/** Messages deleted since cursor, with when and who deleted them; drop them by id. */
+	deleted_messages?: WebitelImApiGatewayV1DeletedMessage[];
 	/**
-	 * The thread itself, set when it is new to the caller (created or joined since cursor).
+	 * The thread itself, set when it is new to the caller (created or joined since cursor)
+	 * or when its attributes changed since cursor (e.g. crm_contact_id); replace the cached thread.
 	 * Same model as the thread list, except last_msg and updates_cursor are never set here.
 	 */
 	dialog?: WebitelImApiGatewayV1Thread;

package/src/gen-wire/contact-groups/contact-groups.zod.ts

@@ -18,7 +18,10 @@ export const DeleteContactGroupsQueryParams = zod.object({
 		.array(zod.string())
 		.optional()
 		.describe('Fields to be retrieved as a result.'),
-	etag: zod.array(zod.string()).describe('Set of unique ID(s) to remove.'),
+	etag: zod
+		.array(zod.string())
+		.min(1)
+		.describe('Set of unique ID(s) to remove.'),
 });
 
 export const DeleteContactGroupsResponse = zod

package/src/gen-wire/contacts/contacts.zod.ts

@@ -569,6 +569,12 @@ export const SearchContactsResponse = zod
 													.describe(
 														'The unique ID of the association. Never changes.',
 													),
+												im_contact_id: zod
+													.string()
+													.optional()
+													.describe(
+														'IM-stack contact ID (UUID) from the im-contact-service.\nMutually exclusive with .user: a link has either a legacy\nchat client (.user) or an IM-stack contact, never both.',
+													),
 												protocol: zod
 													.string()
 													.optional()
@@ -1477,6 +1483,12 @@ export const CreateContactBody = zod
 							.string()
 							.optional()
 							.describe('App (Text-Gateway) used to connect the IM client.'),
+						im_contact_id: zod
+							.string()
+							.optional()
+							.describe(
+								'IM-stack contact ID (UUID) from the im-contact-service.\nExactly one of .external_user or .im_contact_id must be set.',
+							),
 						protocol: zod.string().optional(),
 						via: zod
 							.string()
@@ -2087,6 +2099,12 @@ export const CreateContactResponse = zod
 									.string()
 									.optional()
 									.describe('The unique ID of the association. Never changes.'),
+								im_contact_id: zod
+									.string()
+									.optional()
+									.describe(
+										'IM-stack contact ID (UUID) from the im-contact-service.\nMutually exclusive with .user: a link has either a legacy\nchat client (.user) or an IM-stack contact, never both.',
+									),
 								protocol: zod
 									.string()
 									.optional()
@@ -2943,6 +2961,12 @@ export const CreateContactsBodyItem = zod
 							.string()
 							.optional()
 							.describe('App (Text-Gateway) used to connect the IM client.'),
+						im_contact_id: zod
+							.string()
+							.optional()
+							.describe(
+								'IM-stack contact ID (UUID) from the im-contact-service.\nExactly one of .external_user or .im_contact_id must be set.',
+							),
 						protocol: zod.string().optional(),
 						via: zod
 							.string()
@@ -3584,6 +3608,12 @@ export const CreateContactsResponse = zod
 													.describe(
 														'The unique ID of the association. Never changes.',
 													),
+												im_contact_id: zod
+													.string()
+													.optional()
+													.describe(
+														'IM-stack contact ID (UUID) from the im-contact-service.\nMutually exclusive with .user: a link has either a legacy\nchat client (.user) or an IM-stack contact, never both.',
+													),
 												protocol: zod
 													.string()
 													.optional()
@@ -4500,6 +4530,12 @@ export const CreateContactsResponse = zod
 													.describe(
 														'App (Text-Gateway) used to connect the IM client.',
 													),
+												im_contact_id: zod
+													.string()
+													.optional()
+													.describe(
+														'IM-stack contact ID (UUID) from the im-contact-service.\nExactly one of .external_user or .im_contact_id must be set.',
+													),
 												protocol: zod.string().optional(),
 												via: zod
 													.string()
@@ -5170,6 +5206,12 @@ export const DeleteContactResponse = zod
 									.string()
 									.optional()
 									.describe('The unique ID of the association. Never changes.'),
+								im_contact_id: zod
+									.string()
+									.optional()
+									.describe(
+										'IM-stack contact ID (UUID) from the im-contact-service.\nMutually exclusive with .user: a link has either a legacy\nchat client (.user) or an IM-stack contact, never both.',
+									),
 								protocol: zod
 									.string()
 									.optional()
@@ -6318,6 +6360,12 @@ export const LocateContactResponse = zod
 									.string()
 									.optional()
 									.describe('The unique ID of the association. Never changes.'),
+								im_contact_id: zod
+									.string()
+									.optional()
+									.describe(
+										'IM-stack contact ID (UUID) from the im-contact-service.\nMutually exclusive with .user: a link has either a legacy\nchat client (.user) or an IM-stack contact, never both.',
+									),
 								protocol: zod
 									.string()
 									.optional()
@@ -7167,6 +7215,12 @@ export const UpdateContactBody = zod.object({
 						.string()
 						.optional()
 						.describe('App (Text-Gateway) used to connect the IM client.'),
+					im_contact_id: zod
+						.string()
+						.optional()
+						.describe(
+							'IM-stack contact ID (UUID) from the im-contact-service.\nExactly one of .external_user or .im_contact_id must be set.',
+						),
 					protocol: zod.string().optional(),
 					via: zod
 						.string()
@@ -7771,6 +7825,12 @@ export const UpdateContactResponse = zod
 									.string()
 									.optional()
 									.describe('The unique ID of the association. Never changes.'),
+								im_contact_id: zod
+									.string()
+									.optional()
+									.describe(
+										'IM-stack contact ID (UUID) from the im-contact-service.\nMutually exclusive with .user: a link has either a legacy\nchat client (.user) or an IM-stack contact, never both.',
+									),
 								protocol: zod
 									.string()
 									.optional()

package/src/gen-wire/emails/emails.zod.ts

@@ -22,6 +22,7 @@ export const DeleteEmailsQueryParams = zod.object({
 		.describe('Fields to be retrieved as a result.'),
 	etag: zod
 		.array(zod.string().regex(deleteEmailsQueryEtagItemRegExp))
+		.min(1)
 		.describe('Set of unique ID(s) to remove.'),
 });
 

package/src/gen-wire/groups/groups.zod.ts

@@ -791,6 +791,12 @@ export const AddContactsToGroupsResponse = zod
 													.describe(
 														'The unique ID of the association. Never changes.',
 													),
+												im_contact_id: zod
+													.string()
+													.optional()
+													.describe(
+														'IM-stack contact ID (UUID) from the im-contact-service.\nMutually exclusive with .user: a link has either a legacy\nchat client (.user) or an IM-stack contact, never both.',
+													),
 												protocol: zod
 													.string()
 													.optional()
@@ -2002,6 +2008,12 @@ export const RemoveContactsFromGroupResponse = zod
 													.describe(
 														'The unique ID of the association. Never changes.',
 													),
+												im_contact_id: zod
+													.string()
+													.optional()
+													.describe(
+														'IM-stack contact ID (UUID) from the im-contact-service.\nMutually exclusive with .user: a link has either a legacy\nchat client (.user) or an IM-stack contact, never both.',
+													),
 												protocol: zod
 													.string()
 													.optional()

package/src/gen-wire/imclients/imclients.ts

@@ -10,7 +10,9 @@ import axios from '../../api/axios/genClient';
 
 import type {
 	ContactsEmptyResponse,
+	ContactsIMClient,
 	ContactsIMClientList,
+	IMClientsLinkIMContactBody,
 	ListIMClientsParams,
 } from '../_models';
 
@@ -38,6 +40,22 @@ export const // --- title start
 					},
 				});
 			};
+			/**
+ * @summary Link an IM-stack contact (im-contact-service UUID) with the Contact.
+If the IM contact is already linked to another Contact
+within the domain, the link is reassigned to this Contact.
+ */
+			const linkIMContact = (
+				contactId: string,
+				iMClientsLinkIMContactBody: IMClientsLinkIMContactBody,
+				options?: AxiosRequestConfig,
+			): Promise<AxiosResponse<ContactsIMClient>> => {
+				return axiosInstance.post(
+					`/contacts/${contactId}/imclients`,
+					iMClientsLinkIMContactBody,
+					options,
+				);
+			};
 			const deleteIMClient = (
 				contactId: string,
 				id: string,
@@ -52,10 +70,12 @@ export const // --- title start
 			// --- footer start
 			return {
 				listIMClients,
+				linkIMContact,
 				deleteIMClient,
 			};
 		};
 export type ListIMClientsResult = AxiosResponse<ContactsIMClientList>;
+export type LinkIMContactResult = AxiosResponse<ContactsIMClient>;
 export type DeleteIMClientResult = AxiosResponse<ContactsEmptyResponse>;
 
 // --- footer end

package/src/gen-wire/imclients/imclients.zod.ts

@@ -98,6 +98,12 @@ export const ListIMClientsResponse = zod.object({
 						.string()
 						.optional()
 						.describe('The unique ID of the association. Never changes.'),
+					im_contact_id: zod
+						.string()
+						.optional()
+						.describe(
+							'IM-stack contact ID (UUID) from the im-contact-service.\nMutually exclusive with .user: a link has either a legacy\nchat client (.user) or an IM-stack contact, never both.',
+						),
 					protocol: zod
 						.string()
 						.optional()
@@ -163,6 +169,146 @@ export const ListIMClientsResponse = zod.object({
 	page: zod.int().optional().describe('The page number of the partial result.'),
 });
 
+/**
+ * @summary Link an IM-stack contact (im-contact-service UUID) with the Contact.
+If the IM contact is already linked to another Contact
+within the domain, the link is reassigned to this Contact.
+ */
+export const LinkIMContactParams = zod.object({
+	contact_id: zod.string().describe('Link contact ID (or etag).'),
+});
+
+export const LinkIMContactBody = zod.object({
+	gateway_id: zod
+		.string()
+		.optional()
+		.describe('App (gateway) the IM contact is connected through. Optional.'),
+	im_contact_id: zod
+		.string()
+		.optional()
+		.describe(
+			'IM-stack contact ID (UUID) from the im-contact-service. Required.',
+		),
+	protocol: zod
+		.string()
+		.optional()
+		.describe(
+			'Protocol (provider type) of the IM conversation, e.g. "telegram". Required.',
+		),
+	via: zod
+		.string()
+		.optional()
+		.describe(
+			'[Via] App(-specific) peer(-id) to connect[from] the IM contact. Optional.',
+		),
+});
+
+export const LinkIMContactResponse = zod
+	.object({
+		app: 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(
+				'App (Text-Gateway) used to connect the IM client.\nId will be internal id of gateway.\nName will be name of the gateway.',
+			),
+		created_at: zod
+			.string()
+			.optional()
+			.describe('The user who created this Field.'),
+		created_by: 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('Timestamp(milli) of the Field creation.'),
+		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).',
+			),
+		external_id: zod.string().optional().describe('External user id.'),
+		id: zod
+			.string()
+			.optional()
+			.describe('The unique ID of the association. Never changes.'),
+		im_contact_id: zod
+			.string()
+			.optional()
+			.describe(
+				'IM-stack contact ID (UUID) from the im-contact-service.\nMutually exclusive with .user: a link has either a legacy\nchat client (.user) or an IM-stack contact, never both.',
+			),
+		protocol: zod
+			.string()
+			.optional()
+			.describe('Protocol used to connect the IM client.'),
+		updated_at: zod
+			.string()
+			.optional()
+			.describe(
+				'Timestamp(milli) of the last Field update.\nTake part in Etag generation.',
+			),
+		updated_by: 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 performed last Update.'),
+		user: 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(
+				'External user which contacted to us.\nId will be from external service.\nName will be from external service.',
+			),
+		ver: zod
+			.int()
+			.optional()
+			.describe('Version of the latest update. Numeric sequence.'),
+		via: zod
+			.string()
+			.optional()
+			.describe(
+				'[Via] App(-specific) peer(-id) to connect[from] the IM client.',
+			),
+	})
+	.describe("A contact's [I]nstant[M]essaging client.");
+
 export const DeleteIMClientParams = zod.object({
 	contact_id: zod.string(),
 	id: zod.string(),

package/src/gen-wire/index.ts

@@ -1252,6 +1252,9 @@ export * from './imclients/imclients';
 export {
 	DeleteIMClientParams,
 	DeleteIMClientResponse,
+	LinkIMContactBody,
+	LinkIMContactParams,
+	LinkIMContactResponse,
 	ListIMClientsParams,
 	ListIMClientsQueryParams,
 	ListIMClientsResponse,
@@ -2742,6 +2745,9 @@ export {
 	ThreadManagementSearchResponse,
 	ThreadManagementSearchVariablesQueryParams,
 	ThreadManagementSearchVariablesResponse,
+	ThreadManagementSetCrmContactBody,
+	ThreadManagementSetCrmContactParams,
+	ThreadManagementSetCrmContactResponse,
 	ThreadManagementSetVariablesBody,
 	ThreadManagementSetVariablesParams,
 	ThreadManagementSetVariablesResponse,

package/src/gen-wire/labels/labels.zod.ts

@@ -86,6 +86,7 @@ export const DeleteLabelsQueryParams = zod.object({
 		.describe('Fields to be retrieved into result.'),
 	etag: zod
 		.array(zod.string().regex(deleteLabelsQueryEtagItemRegExp))
+		.min(1)
 		.describe('Set of unique label(s).etag identifiers.'),
 });
 

package/src/gen-wire/languages/languages.zod.ts

@@ -20,6 +20,7 @@ export const DelContactLanguagesQueryParams = zod.object({
 		.describe('Fields to be retrieved as a result.'),
 	etag: zod
 		.array(zod.string())
+		.min(1)
 		.describe('Set of unique language{etag} association(s) to remove.'),
 });
 

package/src/gen-wire/managers/managers.zod.ts

@@ -18,7 +18,10 @@ export const DeleteManagersQueryParams = zod.object({
 		.array(zod.string())
 		.optional()
 		.describe('Fields to be retrieved as a result.'),
-	etag: zod.array(zod.string()).describe('Set of unique ID(s) to remove.'),
+	etag: zod
+		.array(zod.string())
+		.min(1)
+		.describe('Set of unique ID(s) to remove.'),
 });
 
 export const DeleteManagersResponseItem = zod

package/src/gen-wire/phones/phones.zod.ts

@@ -18,7 +18,10 @@ export const DeletePhonesQueryParams = zod.object({
 		.array(zod.string())
 		.optional()
 		.describe('Fields to be retrieved into result.'),
-	etag: zod.array(zod.string()).describe('Set of linked ID(s) to be removed.'),
+	etag: zod
+		.array(zod.string())
+		.min(1)
+		.describe('Set of linked ID(s) to be removed.'),
 });
 
 export const DeletePhonesResponse = zod

package/src/gen-wire/photos/photos.zod.ts

@@ -18,7 +18,10 @@ export const DeletePhotosQueryParams = zod.object({
 		.array(zod.string())
 		.optional()
 		.describe('Fields to be retrieved into result of changes.'),
-	etag: zod.array(zod.string()).describe('Set of linked ID(s) to be removed.'),
+	etag: zod
+		.array(zod.string())
+		.min(1)
+		.describe('Set of linked ID(s) to be removed.'),
 });
 
 export const DeletePhotosResponse = zod

package/src/gen-wire/presence/presence.zod.ts

@@ -37,7 +37,7 @@ export const SetStatus2Response = zod.object({
 		.array(zod.unknown())
 		.optional()
 		.describe(
-			'// FIXME: well-known types ?\r\n repeated Dialog  call = 9;\r\n repeated Sipreg  sip = 9;\r\n repeated Websock wss = 9;',
+			'// FIXME: well-known types ?\n repeated Dialog  call = 9;\n repeated Sipreg  sip = 9;\n repeated Websock wss = 9;',
 		),
 	priority: zod.int().optional(),
 	sequence: zod.string().optional(),
@@ -79,7 +79,7 @@ export const SetStatusResponse = zod.object({
 		.array(zod.unknown())
 		.optional()
 		.describe(
-			'// FIXME: well-known types ?\r\n repeated Dialog  call = 9;\r\n repeated Sipreg  sip = 9;\r\n repeated Websock wss = 9;',
+			'// FIXME: well-known types ?\n repeated Dialog  call = 9;\n repeated Sipreg  sip = 9;\n repeated Websock wss = 9;',
 		),
 	priority: zod.int().optional(),
 	sequence: zod.string().optional(),

package/src/gen-wire/timezones/timezones.zod.ts

@@ -18,7 +18,10 @@ export const DeleteTimezonesQueryParams = zod.object({
 		.array(zod.string())
 		.optional()
 		.describe('Fields to be retrieved as a result.'),
-	etag: zod.array(zod.string()).describe('Set of unique ID(s) to remove.'),
+	etag: zod
+		.array(zod.string())
+		.min(1)
+		.describe('Set of unique ID(s) to remove.'),
 });
 
 export const DeleteTimezonesResponse = zod

package/src/gen-wire/variables/variables.zod.ts

@@ -22,6 +22,7 @@ export const DeleteVariablesQueryParams = zod.object({
 		.describe('Fields to be retrieved as a result.'),
 	etag: zod
 		.array(zod.string().regex(deleteVariablesQueryEtagItemRegExp))
+		.min(1)
 		.describe('Set of unique ID(s) to remove.'),
 });
 

package/src/gen-wire/webitel-im-api-gateway-v1-contacts/webitel-im-api-gateway-v1-contacts.zod.ts

@@ -38,6 +38,7 @@ export const ContactsSearchQueryParams = zod.object({
 		.optional()
 		.describe('Filter by internal system subjects/user IDs.'),
 	only_bots: zod.boolean().optional(),
+	ids: zod.array(zod.string()).optional().describe('Filter by contact IDs.'),
 });
 
 export const ContactsSearchResponse = zod
@@ -56,6 +57,7 @@ export const ContactsSearchResponse = zod
 							.describe(
 								'Record creation timestamp (Unix Epoch in milliseconds).',
 							),
+						id: zod.string().optional().describe('Unique contact identifier.'),
 						is_bot: zod
 							.boolean()
 							.optional()