prisoner-contact-registry-api.d.ts

/**
 * This file was auto-generated by openapi-typescript.
 * Do not make direct changes to the file.
 */

export interface paths {
  '/v2/prisoners/{prisonerId}/contacts/social/approved/restrictions/visit-request/date-ranges': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    get?: never
    put?: never
    /**
     * Get all date ranges of visitor restrictions which would cause a visit to be a request visit
     * @description Returns a List<DateRangeDto> containing all start/end date pairs of visitor restrictions which cause a visit to be a request visit
     */
    post: operations['getDateRangesForVisitorRestrictionsWhichEffectRequestVisits']
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/v2/prisoners/{prisonerId}/contacts/{contactId}/relationships/{relationshipId}': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * Get a single contact details via their prisoner / contact relationship
     * @description Get a single contact details via their prisoner / contact relationship
     */
    get: operations['getPrisonerContactDetailsViaRelationship']
    put?: never
    post?: never
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/v2/prisoners/{prisonerId}/contacts/social': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * Get Prisoners Social Contacts
     * @description Returns details of a prisoner's social contacts
     */
    get: operations['getPrisonerSocialContacts']
    put?: never
    post?: never
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/v2/prisoners/{prisonerId}/contacts/social/approved': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * Get Prisoners Social Contacts that are approved
     * @description Returns details of a prisoner's social contacts that have been approved.
     */
    get: operations['getPrisonersSocialContactsApproved']
    put?: never
    post?: never
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/v2/prisoners/{prisonerId}/contacts/social/approved/restrictions/closed': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * Get status on any visitors having closed restrictions
     * @description Returns a boolean true/false for a given list of visitors if any closed restrictions are found
     */
    get: operations['getClosedRestrictionStatusForPrisonerVisitors']
    put?: never
    post?: never
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/v2/prisoners/{prisonerId}/contacts/social/approved/restrictions/banned/dateRange': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * Get an updated date range for visitors if a visitor with ban restriction is found, else returns original date
     * @description Returns an updated date range for visitors if one is found with an active ban restriction. If not, it returns the original date range
     */
    get: operations['getUpdatedDateRangeForPrisonerVisitorsIfFoundWithBanRestrictions']
    put?: never
    post?: never
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/v2/contacts/{contactId}': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * Get a contact via Contact ID
     * @description Returns a contact's basic details
     */
    get: operations['getContact']
    put?: never
    post?: never
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/v2/contacts/{contactId}/restrictions/global': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * Get a contact's global restrictions
     * @description Returns a contact's global restrictions
     */
    get: operations['getContactGlobalRestrictions']
    put?: never
    post?: never
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/v2/contacts/{contactId}/linked-social-prisoners': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * Get a contact's linked prisoners via Contact ID
     * @description Returns a contact's linked prisoners (prisonerIds) as a list
     */
    get: operations['getContactLinkedPrisoners']
    put?: never
    post?: never
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
  '/v2/contacts/search': {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    /**
     * Search for contacts with a potential relationship to a prisoner
     * @description Returns contact details (including relationship details of prisoner if prisonerId provided).
     */
    get: operations['searchContacts']
    put?: never
    post?: never
    delete?: never
    options?: never
    head?: never
    patch?: never
    trace?: never
  }
}
export type webhooks = Record<string, never>
export interface components {
  schemas: {
    ErrorResponse: {
      /** Format: int32 */
      status: number
      /** Format: int32 */
      errorCode?: number | null
      userMessage?: string | null
      developerMessage?: string | null
    }
    /** @description A date range */
    DateRangeDto: {
      /**
       * Format: date
       * @description The start of the date range
       */
      fromDate: string
      /**
       * Format: date
       * @description The end of the date range
       */
      toDate: string
    }
    /** @description Request body for finding visitor restriction date ranges which would effect request visits */
    RequestVisitVisitorRestrictionsBodyDto: {
      /** @description Prisoner Id of prisoner who the visit is for */
      prisonerId: string
      /** @description List of all visitors attending the visit */
      visitorIds: string[]
      /** @description A list of restriction codes to search for when finding visitor restrictions */
      supportedVisitorRestrictionsCodesForRequestVisits: string[]
      /** @description The current visit booking window date range (used to limit restriction search) */
      currentDateRange: components['schemas']['DateRangeDto']
    }
    /** @description An address */
    AddressDto: {
      /**
       * @description Flat
       * @example 3B
       */
      flat?: string | null
      /**
       * @description Premise
       * @example Liverpool Prison
       */
      premise?: string | null
      /**
       * @description Street
       * @example Slinn Street
       */
      street?: string | null
      /**
       * @description Locality
       * @example Brincliffe
       */
      locality?: string | null
      /**
       * @description Town/City
       * @example Liverpool
       */
      town?: string | null
      /**
       * @description Postal Code
       * @example LI1 5TH
       */
      postalCode?: string | null
      /**
       * @description County
       * @example HEREFORD
       */
      county?: string | null
      /**
       * @description Country
       * @example ENG
       */
      country?: string | null
      /**
       * @description Additional Information
       * @example This is a comment text
       */
      comment?: string | null
      /**
       * @description Primary Address
       * @example false
       */
      primary: boolean
      /**
       * @description No Fixed Address
       * @example false
       */
      noFixedAddress: boolean
    }
    /** @description A contact for a prisoner */
    PrisonerContactDto: {
      /**
       * Format: int64
       * @description Identifier for this contact (Person in NOMIS)
       * @example 5871791
       */
      personId?: number | null
      /**
       * @description First name
       * @example John
       */
      firstName: string
      /**
       * @description Middle name
       * @example Mark
       */
      middleName?: string | null
      /**
       * @description Last name
       * @example Smith
       */
      lastName: string
      /**
       * Format: date
       * @description Date of birth
       * @example 1980-01-28
       */
      dateOfBirth?: string | null
      /**
       * @description Code for relationship to Prisoner
       * @example RO
       */
      relationshipCode: string
      /**
       * @description Description of relationship to Prisoner
       * @example Responsible Officer
       */
      relationshipDescription?: string | null
      /**
       * @description Type of Contact
       * @example O
       */
      contactType: string
      /**
       * @description Description of Contact Type
       * @example Official
       */
      contactTypeDescription?: string | null
      /** @description Approved Visitor Flag */
      approvedVisitor: boolean
      /** @description Emergency Contact Flag */
      emergencyContact: boolean
      /** @description Next of Kin Flag */
      nextOfKin: boolean
      /** @description List of restrictions associated with the contact */
      restrictions: components['schemas']['RestrictionDto'][]
      address?: components['schemas']['AddressDto'] | null
      /**
       * @description Additional Information
       * @example This is a comment text
       */
      commentText?: string | null
    }
    /** @description A contact for a prisoner */
    RestrictionDto: {
      /**
       * Format: int32
       * @description Restriction ID
       * @example 123
       */
      restrictionId: number
      /**
       * @description Restriction Type Code
       * @example 123
       */
      restrictionType: string
      /**
       * @description Description of Restriction Type
       * @example 123
       */
      restrictionTypeDescription: string
      /**
       * Format: date
       * @description Date from which the restriction applies
       * @example 2000-10-31
       */
      startDate: string
      /**
       * Format: date
       * @description Restriction Expiry
       * @example 2000-10-31
       */
      expiryDate?: string | null
      /** @description True if applied globally to the contact or False if applied in the context of a visit */
      globalRestriction: boolean
      /**
       * @description Additional Information
       * @example This is a comment text
       */
      comment?: string | null
    }
    /** @description Boolean flag signifying if any visitors have closed restrictions */
    HasClosedRestrictionDto: {
      /** @description Has closed restriction */
      value: boolean
    }
    /** @description A contact (no prisoner relationship) */
    ContactDto: {
      /**
       * Format: int64
       * @description Identifier for this contact
       * @example 5871791
       */
      contactId?: number | null
      /**
       * @description First name
       * @example John
       */
      firstName: string
      /**
       * @description Middle name
       * @example Mark
       */
      middleName?: string | null
      /**
       * @description Last name
       * @example Smith
       */
      lastName: string
      /**
       * Format: date
       * @description Date of birth
       * @example 1980-01-28
       */
      dateOfBirth?: string | null
    }
    /** @description A linked prisoner of contact */
    ContactLinkedPrisonerDto: {
      /**
       * @description Prisoner number (NOMS ID)
       * @example A1234BC
       */
      prisonerNumber: string
      /**
       * @description Coded value indicating either a social or official contact (mandatory).
       *         This is a coded value from the group code CONTACT_TYPE in reference data.
       *         Known values are (S) Social or (O) official.
       * @example S
       */
      relationshipTypeCode: string
    }
    /** @description A contact with an optional prisoner relationship */
    ContactWithOptionalPrisonerRelationshipDto: {
      /**
       * Format: int64
       * @description Identifier for this contact (Person in NOMIS)
       * @example 5871791
       */
      contactId: number
      /**
       * Format: int64
       * @description The unique identifier for the prisoner-contact relationship
       * @example 123456
       */
      prisonerContactId?: number | null
      /**
       * @description First name
       * @example John
       */
      firstName: string
      /**
       * @description Middle name
       * @example Mark
       */
      middleName?: string | null
      /**
       * @description Last name
       * @example Smith
       */
      lastName: string
      /**
       * Format: date
       * @description Date of birth
       * @example 1980-01-28
       */
      dateOfBirth?: string | null
      /**
       * @description Code for relationship to Prisoner
       * @example RO
       */
      relationshipCode?: string | null
      /**
       * @description Description of relationship to Prisoner
       * @example Responsible Officer
       */
      relationshipDescription?: string | null
      /**
       * @description Type of Contact
       * @example O
       */
      contactType?: string | null
      /**
       * @description Description of Contact Type
       * @example Official
       */
      contactTypeDescription?: string | null
      /** @description List of restrictions associated with the contact */
      restrictions: components['schemas']['RestrictionDto'][]
      address?: components['schemas']['AddressDto'] | null
      /**
       * @description Is this prisoner's contact relationship approved?
       * @example true
       */
      approvedVisitor?: boolean | null
      /**
       * @description Is this prisoner's contact relationship the emergency contact?
       * @example true
       */
      emergencyContact?: boolean | null
      /**
       * @description Is this prisoner's contact relationship the next of kin?
       * @example true
       */
      nextOfKin?: boolean | null
      /** @description comments of the relationship */
      comments?: string | null
    }
  }
  responses: never
  parameters: never
  requestBodies: never
  headers: never
  pathItems: never
}
export type $defs = Record<string, never>
export interface operations {
  getDateRangesForVisitorRestrictionsWhichEffectRequestVisits: {
    parameters: {
      query?: never
      header?: never
      path?: never
      cookie?: never
    }
    requestBody: {
      content: {
        'application/json': components['schemas']['RequestVisitVisitorRestrictionsBodyDto']
      }
    }
    responses: {
      /** @description Date ranges returned (empty if none cause sessions to be request visits) */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['DateRangeDto'][]
        }
      }
      /** @description Incorrect request to Get date ranges for prisoner visitors */
      400: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Unauthorized to access this endpoint */
      401: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Incorrect permissions to Get date ranges for prisoner visitors */
      403: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Prisoner or Visitor not found */
      404: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
    }
  }
  getPrisonerContactDetailsViaRelationship: {
    parameters: {
      query?: {
        /**
         * @description Defaults to false. Returns contact restrictions if set to true, skips grabbing restrictions if false
         * @example false
         */
        withRestrictions?: boolean
      }
      header?: never
      path: {
        /**
         * @description Prisoner Identifier (NOMIS Offender No)
         * @example A1234AA
         */
        prisonerId: string
        /**
         * @description The ID of the contact which is associated with the prisoner
         * @example 57392371
         */
        contactId: string
        /**
         * @description The ID of the prisoner / contact relationship
         * @example 23621947
         */
        relationshipId: number
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description Prisoner Contact Information Returned */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['PrisonerContactDto']
        }
      }
      /** @description Incorrect request to retrieve prisoner's contact details */
      400: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Unauthorized to access this endpoint */
      401: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Incorrect permissions to retrieve prisoner's contact details */
      403: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Prisoner or contact not found */
      404: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
    }
  }
  getPrisonerSocialContacts: {
    parameters: {
      query?: {
        /**
         * @description Defaults to false. By default when false, returns all contacts with or without a DOB. If true, returns only contacts with a DOB.
         * @example false
         */
        hasDateOfBirth?: boolean
        /**
         * @description Defaults to false. Returns all contacts restrictions if set to true, skips grabbing restrictions if false
         * @example false
         */
        withRestrictions?: boolean
      }
      header?: never
      path: {
        /**
         * @description Prisoner Identifier (NOMIS Offender No)
         * @example A1234AA
         */
        prisonerId: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description Prisoner Social Contacts Information Returned */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['PrisonerContactDto'][]
        }
      }
      /** @description Incorrect request to retrieve prisoner's approved social contacts */
      400: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Unauthorized to access this endpoint */
      401: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Incorrect permissions to retrieve prisoner's approved social contacts */
      403: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Prisoner not found */
      404: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
    }
  }
  getPrisonersSocialContactsApproved: {
    parameters: {
      query?: {
        /**
         * @description Defaults to false. By default when false, returns all contacts with or without a DOB. If true, returns only contacts with a DOB.
         * @example false
         */
        hasDateOfBirth?: boolean
        /**
         * @description Defaults to false. Returns all contacts restrictions if set to true, skips grabbing restrictions if false
         * @example false
         */
        withRestrictions?: boolean
      }
      header?: never
      path: {
        /**
         * @description Prisoner Identifier (NOMIS Offender No)
         * @example A1234AA
         */
        prisonerId: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description Prisoner Approved Social Contacts Information Returned */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['PrisonerContactDto'][]
        }
      }
      /** @description Incorrect request to retrieve prisoner's approved social contacts */
      400: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Unauthorized to access this endpoint */
      401: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Incorrect permissions to retrieve prisoner's approved social contacts */
      403: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Prisoner not found */
      404: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
    }
  }
  getClosedRestrictionStatusForPrisonerVisitors: {
    parameters: {
      query: {
        /**
         * @description Ids of prisoner visitors
         * @example 9147510, 8431201
         */
        visitors: number[]
      }
      header?: never
      path: {
        /**
         * @description Prisoner Identifier (NOMIS Offender No)
         * @example A1234AA
         */
        prisonerId: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description Returned status on visitor closed restrictions successfully */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['HasClosedRestrictionDto']
        }
      }
      /** @description Incorrect request to Get status of visitors closed restrictions */
      400: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Unauthorized to access this endpoint */
      401: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Incorrect permissions to Get status of visitors closed restrictions */
      403: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Prisoner or Visitor */
      404: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
    }
  }
  getUpdatedDateRangeForPrisonerVisitorsIfFoundWithBanRestrictions: {
    parameters: {
      query: {
        /**
         * @description Ids of prisoner visitors
         * @example 9147510, 8431201
         */
        visitors: number[]
        /**
         * @description Start date range
         * @example 2024-03-15
         */
        fromDate: string
        /**
         * @description To date range
         * @example 2024-03-31
         */
        toDate: string
      }
      header?: never
      path: {
        /**
         * @description Prisoner Identifier (NOMIS Offender No)
         * @example A1234AA
         */
        prisonerId: string
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description Date range returned (original or adjusted) */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['DateRangeDto']
        }
      }
      /** @description Incorrect request to Get date range for prisoner visitors */
      400: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Unauthorized to access this endpoint */
      401: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Incorrect permissions to Get date range for prisoner visitors */
      403: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Prisoner, Visitor or Date range not found */
      404: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
    }
  }
  getContact: {
    parameters: {
      query?: never
      header?: never
      path: {
        /**
         * @description The ID of the contact
         * @example 57392371
         */
        contactId: number
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description Contact's basic details returned */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ContactDto']
        }
      }
      /** @description Incorrect request to retrieve a contact's details */
      400: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Unauthorized to access this endpoint */
      401: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Incorrect permissions to retrieve a contact's details */
      403: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Contact not found */
      404: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
    }
  }
  getContactGlobalRestrictions: {
    parameters: {
      query?: never
      header?: never
      path: {
        /**
         * @description The ID of the contact whose global restrictions are sought.
         * @example 57392371
         */
        contactId: number
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description Contact's global restrictions returned */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['RestrictionDto'][]
        }
      }
      /** @description Incorrect request to retrieve a contact's global restrictions */
      400: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Unauthorized to access this endpoint */
      401: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Incorrect permissions to retrieve a contact's global restrictions */
      403: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Contact not found */
      404: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
    }
  }
  getContactLinkedPrisoners: {
    parameters: {
      query?: never
      header?: never
      path: {
        /**
         * @description The ID of the contact
         * @example 57392371
         */
        contactId: number
      }
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description Contact's linked prisoners list returned */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ContactLinkedPrisonerDto'][]
        }
      }
      /** @description Incorrect request to retrieve a contact's linked prisoners */
      400: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Unauthorized to access this endpoint */
      401: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Incorrect permissions to retrieve a contact's linked prisoners */
      403: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Contact not found */
      404: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
    }
  }
  searchContacts: {
    parameters: {
      query: {
        /**
         * @description Contact IDs. Comma-separated list of contact IDs, e.g. contactIds=123,456,789
         * @example 123,456,789
         */
        contactIds: number[]
        /**
         * @description The unique identifier of the prisoner (e.g. prisonNumber, prisonerNumber, prisonId). If provided, relationship information will be included between contacts and prisoner
         * @example AA123456
         */
        prisonerId?: string
        /**
         * @description Defaults to false. Returns all contacts restrictions if set to true, skips grabbing restrictions if false
         * @example false
         */
        withRestrictions?: boolean
      }
      header?: never
      path?: never
      cookie?: never
    }
    requestBody?: never
    responses: {
      /** @description Contact information returned, including relationship details of prisoner if prisonerId provided */
      200: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ContactWithOptionalPrisonerRelationshipDto'][]
        }
      }
      /** @description Incorrect request to search for contacts with a potential relationship to a prisoner */
      400: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Unauthorized to access this endpoint */
      401: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
      /** @description Incorrect permissions to search for contacts with a potential relationship to a prisoner */
      403: {
        headers: {
          [name: string]: unknown
        }
        content: {
          'application/json': components['schemas']['ErrorResponse']
        }
      }
    }
  }
}