/** * Generated by orval v8.19.0 🍺 * Do not edit manually. * Webitel API * OpenAPI spec version: 24.04.0 */ import * as zod from 'zod'; /** * @summary Remove the contact's photo link(s) */ export const DeletePhotosParams = zod.object({ contact_id: zod.string().describe('Link(s) contact ID.'), }); export const DeletePhotosQueryParams = zod.object({ fields: zod .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.'), }); export const DeletePhotosResponse = zod .object({ data: zod .array( zod .object({ createdAt: zod .string() .optional() .describe('The user who created this Field.'), 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('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).', ), id: zod .string() .optional() .describe('The unique ID of the association. Never changes.'), photoId: zod.string().optional(), photoUrl: zod.string().optional(), primary: zod .boolean() .optional() .describe( 'True if the photo is a default photo; false if the photo is a user-provided photo.', ), updatedAt: zod .string() .optional() .describe( 'Timestamp(milli) of the last Field update.\nTake part in Etag generation.', ), 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 performed last Update.'), ver: zod .number() .optional() .describe('Version of the latest update. Numeric sequence.'), }) .describe( "A contact's photo.\nA picture shown next to the contact's name\nto help others recognize the contact.", ), ) .optional() .describe('Photo dataset page.'), next: zod.boolean().optional(), page: zod .number() .optional() .describe('The page number of the partial result.'), }) .describe('Photo dataset.'); /** * @summary Search the contact's photo(s) */ export const SearchPhotosParams = zod.object({ contact_id: zod.string().describe('The Contact ID linked with.'), }); export const SearchPhotosQueryParams = zod.object({ page: zod .number() .optional() .describe('Page number of result dataset records. offset = (page*size)'), size: zod .number() .optional() .describe('Size count of records on result page. limit = (size++)'), q: zod .string() .optional() .describe( 'Search term: email address.\n`?` - matches any one character\n`*` - matches 0 or more characters', ), sort: zod .array(zod.string()) .optional() .describe('Sort the result according to fields.'), fields: zod .array(zod.string()) .optional() .describe('Fields to be retrieved into result.'), id: zod .array(zod.string()) .optional() .describe('Link(s) with unique ID only.'), primary: zod.boolean().optional().describe('Default photos only.'), }); export const SearchPhotosResponse = zod .object({ data: zod .array( zod .object({ createdAt: zod .string() .optional() .describe('The user who created this Field.'), 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('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).', ), id: zod .string() .optional() .describe('The unique ID of the association. Never changes.'), photoId: zod.string().optional(), photoUrl: zod.string().optional(), primary: zod .boolean() .optional() .describe( 'True if the photo is a default photo; false if the photo is a user-provided photo.', ), updatedAt: zod .string() .optional() .describe( 'Timestamp(milli) of the last Field update.\nTake part in Etag generation.', ), 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 performed last Update.'), ver: zod .number() .optional() .describe('Version of the latest update. Numeric sequence.'), }) .describe( "A contact's photo.\nA picture shown next to the contact's name\nto help others recognize the contact.", ), ) .optional() .describe('Photo dataset page.'), next: zod.boolean().optional(), page: zod .number() .optional() .describe('The page number of the partial result.'), }) .describe('Photo dataset.'); /** * @summary Link photo(s) with the contact */ export const CreatePhotosParams = zod.object({ contact_id: zod.string().describe('Link contact ID.'), }); export const CreatePhotosQueryParams = zod.object({ fields: zod .array(zod.string()) .optional() .describe('Fields to be retrieved into result of changes.'), }); export const CreatePhotosBodyItem = zod .object({ etag: zod .string() .optional() .describe('Unique ID of the latest version of an existing association.'), photoId: zod.string().optional(), photoUrl: zod.string().optional(), primary: zod .boolean() .optional() .describe( 'True if the photo is a default photo; false if the photo is a user-provided photo.', ), }) .describe('Input of the photo.'); export const CreatePhotosBody = zod.array(CreatePhotosBodyItem); export const CreatePhotosResponse = zod .object({ data: zod .array( zod .object({ createdAt: zod .string() .optional() .describe('The user who created this Field.'), 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('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).', ), id: zod .string() .optional() .describe('The unique ID of the association. Never changes.'), photoId: zod.string().optional(), photoUrl: zod.string().optional(), primary: zod .boolean() .optional() .describe( 'True if the photo is a default photo; false if the photo is a user-provided photo.', ), updatedAt: zod .string() .optional() .describe( 'Timestamp(milli) of the last Field update.\nTake part in Etag generation.', ), 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 performed last Update.'), ver: zod .number() .optional() .describe('Version of the latest update. Numeric sequence.'), }) .describe( "A contact's photo.\nA picture shown next to the contact's name\nto help others recognize the contact.", ), ) .optional() .describe('Photo dataset page.'), next: zod.boolean().optional(), page: zod .number() .optional() .describe('The page number of the partial result.'), }) .describe('Photo dataset.'); /** * @summary Reset the contact's photos to fit given data set. */ export const UpdatePhotosParams = zod.object({ contact_id: zod.string().describe('Link contact ID.'), }); export const UpdatePhotosQueryParams = zod.object({ fields: zod .array(zod.string()) .optional() .describe('Fields to be retrieved into result of changes.'), }); export const UpdatePhotosBodyItem = zod .object({ etag: zod .string() .optional() .describe('Unique ID of the latest version of an existing association.'), photoId: zod.string().optional(), photoUrl: zod.string().optional(), primary: zod .boolean() .optional() .describe( 'True if the photo is a default photo; false if the photo is a user-provided photo.', ), }) .describe('Input of the photo.'); export const UpdatePhotosBody = zod.array(UpdatePhotosBodyItem); export const UpdatePhotosResponse = zod .object({ data: zod .array( zod .object({ createdAt: zod .string() .optional() .describe('The user who created this Field.'), 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('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).', ), id: zod .string() .optional() .describe('The unique ID of the association. Never changes.'), photoId: zod.string().optional(), photoUrl: zod.string().optional(), primary: zod .boolean() .optional() .describe( 'True if the photo is a default photo; false if the photo is a user-provided photo.', ), updatedAt: zod .string() .optional() .describe( 'Timestamp(milli) of the last Field update.\nTake part in Etag generation.', ), 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 performed last Update.'), ver: zod .number() .optional() .describe('Version of the latest update. Numeric sequence.'), }) .describe( "A contact's photo.\nA picture shown next to the contact's name\nto help others recognize the contact.", ), ) .optional() .describe('Photo dataset page.'), next: zod.boolean().optional(), page: zod .number() .optional() .describe('The page number of the partial result.'), }) .describe('Photo dataset.'); /** * @summary Remove the contact's photo */ export const DeletePhotoParams = zod.object({ contact_id: zod.string().describe('Link contact ID.'), etag: zod.string().describe('Unique link ID to be removed.'), }); export const DeletePhotoQueryParams = zod.object({ fields: zod .array(zod.string()) .optional() .describe('Fields to be retrieved into result of changes.'), }); export const DeletePhotoResponse = zod .object({ createdAt: zod .string() .optional() .describe('The user who created this Field.'), 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('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).', ), id: zod .string() .optional() .describe('The unique ID of the association. Never changes.'), photoId: zod.string().optional(), photoUrl: zod.string().optional(), primary: zod .boolean() .optional() .describe( 'True if the photo is a default photo; false if the photo is a user-provided photo.', ), updatedAt: zod .string() .optional() .describe( 'Timestamp(milli) of the last Field update.\nTake part in Etag generation.', ), 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 performed last Update.'), ver: zod .number() .optional() .describe('Version of the latest update. Numeric sequence.'), }) .describe( "A contact's photo.\nA picture shown next to the contact's name\nto help others recognize the contact.", ); /** * @summary Update the contact's photo link details */ export const UpdatePhoto2Params = zod.object({ contact_id: zod.string().describe('Link contact ID.'), etag: zod .string() .describe('Unique ID of the latest version of an existing association.'), }); export const UpdatePhoto2QueryParams = zod.object({ fields: zod .array(zod.string()) .optional() .describe('Fields to be retrieved into result of changes.'), }); export const UpdatePhoto2Body = zod.object({ photoId: zod.string().optional(), photoUrl: zod.string().optional(), primary: zod .boolean() .optional() .describe( 'True if the photo is a default photo; false if the photo is a user-provided photo.', ), }); export const UpdatePhoto2Response = zod .object({ createdAt: zod .string() .optional() .describe('The user who created this Field.'), 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('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).', ), id: zod .string() .optional() .describe('The unique ID of the association. Never changes.'), photoId: zod.string().optional(), photoUrl: zod.string().optional(), primary: zod .boolean() .optional() .describe( 'True if the photo is a default photo; false if the photo is a user-provided photo.', ), updatedAt: zod .string() .optional() .describe( 'Timestamp(milli) of the last Field update.\nTake part in Etag generation.', ), 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 performed last Update.'), ver: zod .number() .optional() .describe('Version of the latest update. Numeric sequence.'), }) .describe( "A contact's photo.\nA picture shown next to the contact's name\nto help others recognize the contact.", ); /** * @summary Update the contact's photo link details */ export const UpdatePhotoParams = zod.object({ contact_id: zod.string().describe('Link contact ID.'), etag: zod .string() .describe('Unique ID of the latest version of an existing association.'), }); export const UpdatePhotoQueryParams = zod.object({ fields: zod .array(zod.string()) .optional() .describe('Fields to be retrieved into result of changes.'), }); export const UpdatePhotoBody = zod.object({ photoId: zod.string().optional(), photoUrl: zod.string().optional(), primary: zod .boolean() .optional() .describe( 'True if the photo is a default photo; false if the photo is a user-provided photo.', ), }); export const UpdatePhotoResponse = zod .object({ createdAt: zod .string() .optional() .describe('The user who created this Field.'), 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('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).', ), id: zod .string() .optional() .describe('The unique ID of the association. Never changes.'), photoId: zod.string().optional(), photoUrl: zod.string().optional(), primary: zod .boolean() .optional() .describe( 'True if the photo is a default photo; false if the photo is a user-provided photo.', ), updatedAt: zod .string() .optional() .describe( 'Timestamp(milli) of the last Field update.\nTake part in Etag generation.', ), 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 performed last Update.'), ver: zod .number() .optional() .describe('Version of the latest update. Numeric sequence.'), }) .describe( "A contact's photo.\nA picture shown next to the contact's name\nto help others recognize the contact.", ); /** * @summary Locate the contact's photo link. */ export const LocatePhotoParams = zod.object({ contact_id: zod.string().describe('Link contact ID.'), id: zod.string().describe('Link unique ID.'), }); export const LocatePhotoQueryParams = zod.object({ fields: zod .array(zod.string()) .optional() .describe('Fields to be retrieved into result.'), }); export const LocatePhotoResponse = zod .object({ createdAt: zod .string() .optional() .describe('The user who created this Field.'), 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('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).', ), id: zod .string() .optional() .describe('The unique ID of the association. Never changes.'), photoId: zod.string().optional(), photoUrl: zod.string().optional(), primary: zod .boolean() .optional() .describe( 'True if the photo is a default photo; false if the photo is a user-provided photo.', ), updatedAt: zod .string() .optional() .describe( 'Timestamp(milli) of the last Field update.\nTake part in Etag generation.', ), 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 performed last Update.'), ver: zod .number() .optional() .describe('Version of the latest update. Numeric sequence.'), }) .describe( "A contact's photo.\nA picture shown next to the contact's name\nto help others recognize the contact.", );