Merge pull request #2267 from ministryofjustice/update-api-types

API model updates

server/@types/shared/index.d.ts

@@ -6,7 +6,6 @@
 export type { ActiveOffence } from './models/ActiveOffence';
 export type { Adjudication } from './models/Adjudication';
 export type { AllocatedFilter } from './models/AllocatedFilter';
-export type { AnyValue } from './models/AnyValue';
 export type { ApArea } from './models/ApArea';
 export type { Appeal } from './models/Appeal';
 export type { AppealDecision } from './models/AppealDecision';
@@ -93,8 +92,8 @@ export type { Cas1OverbookingRange } from './models/Cas1OverbookingRange';
 export type { Cas1PremiseCapacity } from './models/Cas1PremiseCapacity';
 export type { Cas1PremiseCapacityForDay } from './models/Cas1PremiseCapacityForDay';
 export type { Cas1PremiseCharacteristicAvailability } from './models/Cas1PremiseCharacteristicAvailability';
-export type { Cas1PremiseDaySummary } from './models/Cas1PremiseDaySummary';
 export type { Cas1PremisesBasicSummary } from './models/Cas1PremisesBasicSummary';
+export type { Cas1PremisesDaySummary } from './models/Cas1PremisesDaySummary';
 export type { Cas1PremisesSearchResultSummary } from './models/Cas1PremisesSearchResultSummary';
 export type { Cas1PremisesSummary } from './models/Cas1PremisesSummary';
 export type { Cas1ReportName } from './models/Cas1ReportName';

server/@types/shared/models/ApprovedPremisesApplication.ts

@@ -2,7 +2,6 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { AnyValue } from './AnyValue';
 import type { ApArea } from './ApArea';
 import type { Application } from './Application';
 import type { ApprovedPremisesApplicationStatus } from './ApprovedPremisesApplicationStatus';
@@ -12,6 +11,7 @@ import type { Cas1ApplicationUserDetails } from './Cas1ApplicationUserDetails';
 import type { Cas1CruManagementArea } from './Cas1CruManagementArea';
 import type { PersonRisks } from './PersonRisks';
 import type { PersonStatus } from './PersonStatus';
+import type { Unit } from './Unit';
 export type ApprovedPremisesApplication = (Application & {
     isWomensApplication?: boolean;
     /**
@@ -31,8 +31,8 @@ export type ApprovedPremisesApplication = (Application & {
     createdByUserId: string;
     schemaVersion: string;
     outdatedSchema: boolean;
-    data?: AnyValue;
-    document?: AnyValue;
+    data?: Unit;
+    document?: Unit;
     status: ApprovedPremisesApplicationStatus;
     assessmentId?: string;
     assessmentDecision?: AssessmentDecision;

server/@types/shared/models/Assessment.ts

@@ -2,10 +2,10 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { AnyValue } from './AnyValue';
 import type { AssessmentDecision } from './AssessmentDecision';
 import type { ClarificationNote } from './ClarificationNote';
 import type { ReferralHistoryNote } from './ReferralHistoryNote';
+import type { Unit } from './Unit';
 export type Assessment = {
     service: string;
     id: string;
@@ -16,7 +16,7 @@ export type Assessment = {
     submittedAt?: string;
     decision?: AssessmentDecision;
     rejectionRationale?: string;
-    data?: AnyValue;
+    data?: Unit;
     clarificationNotes: Array<ClarificationNote>;
     referralHistoryNotes?: Array<ReferralHistoryNote>;
 };

server/@types/shared/models/AssessmentAcceptance.ts

@@ -2,12 +2,12 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { AnyValue } from './AnyValue';
 import type { ApType } from './ApType';
 import type { PlacementDates } from './PlacementDates';
 import type { PlacementRequirements } from './PlacementRequirements';
+import type { Unit } from './Unit';
 export type AssessmentAcceptance = {
-    document: AnyValue;
+    document: Unit;
     requirements?: PlacementRequirements;
     placementDates?: PlacementDates;
     apType?: ApType;

server/@types/shared/models/AssessmentRejection.ts

@@ -2,9 +2,9 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { AnyValue } from './AnyValue';
+import type { Unit } from './Unit';
 export type AssessmentRejection = {
-    document: AnyValue;
+    document: Unit;
     rejectionRationale: string;
     referralRejectionReasonId?: string;
     referralRejectionReasonDetail?: string;

server/@types/shared/models/Cas1OutOfServiceBedSummary.ts

@@ -6,6 +6,7 @@ import type { Cas1OutOfServiceBedReason } from './Cas1OutOfServiceBedReason';
 import type { Cas1SpaceCharacteristic } from './Cas1SpaceCharacteristic';
 export type Cas1OutOfServiceBedSummary = {
     id: string;
+    roomName?: string;
     startDate: string;
     endDate: string;
     reason: Cas1OutOfServiceBedReason;

server/@types/shared/models/Cas1PremiseDaySummary.ts → server/@types/shared/models/Cas1PremisesDaySummary.ts

@@ -5,7 +5,7 @@
 import type { Cas1OutOfServiceBedSummary } from './Cas1OutOfServiceBedSummary';
 import type { Cas1PremiseCapacityForDay } from './Cas1PremiseCapacityForDay';
 import type { Cas1SpaceBookingDaySummary } from './Cas1SpaceBookingDaySummary';
-export type Cas1PremiseDaySummary = {
+export type Cas1PremisesDaySummary = {
     forDate: string;
     previousDate: string;
     nextDate: string;

server/@types/shared/models/Cas1PremisesSearchResultSummary.ts

@@ -3,23 +3,42 @@
 /* tslint:disable */
 /* eslint-disable */
 import type { ApType } from './ApType';
+import type { Cas1SpaceCharacteristic } from './Cas1SpaceCharacteristic';
 import type { CharacteristicPair } from './CharacteristicPair';
 import type { NamedId } from './NamedId';
 export type Cas1PremisesSearchResultSummary = {
-    id?: string;
-    apCode?: string;
-    deliusQCode?: string;
-    apType?: ApType;
-    name?: string;
+    id: string;
+    apType: ApType;
+    name: string;
+    /**
+     * Full address, excluding postcode
+     */
+    fullAddress: string;
+    /**
+     * Deprecated, use fullAddress
+     * @deprecated
+     */
     addressLine1?: string;
+    /**
+     * Deprecated, use fullAddress
+     * @deprecated
+     */
     addressLine2?: string;
+    /**
+     * Deprecated, use fullAddress
+     * @deprecated
+     */
     town?: string;
     postcode?: string;
-    apArea?: NamedId;
+    apArea: NamedId;
     /**
-     * The total number of spaces in this premises
+     * This is not populated. Instead, use 'characteristics'
+     * @deprecated
      */
-    totalSpaceCount?: number;
     premisesCharacteristics?: Array<CharacteristicPair>;
+    /**
+     * Room and premise characteristics
+     */
+    characteristics: Array<Cas1SpaceCharacteristic>;
 };
 

server/@types/shared/models/Cas1SpaceBookingDaySummary.ts

@@ -18,8 +18,8 @@ export type Cas1SpaceBookingDaySummary = {
     /**
      * Risk rating tier level of corresponding application
      */
-    tier: string;
-    releaseType: string;
+    tier?: string;
+    releaseType?: string;
     essentialCharacteristics: Array<Cas1SpaceBookingCharacteristic>;
 };
 

server/@types/shared/models/Cas1SpaceBookingDaySummarySortField.ts

@@ -2,4 +2,4 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-export type Cas1SpaceBookingDaySummarySortField = 'personName' | 'tier' | 'canonicalArrivalDate' | 'canonicalDepartureDate' | 'releaseType' | 'spaceType';
+export type Cas1SpaceBookingDaySummarySortField = 'personName' | 'tier' | 'canonicalArrivalDate' | 'canonicalDepartureDate' | 'releaseType';

server/@types/shared/models/Cas1SpaceSearchRequirements.ts

@@ -6,7 +6,12 @@ import type { ApType } from './ApType';
 import type { Cas1SpaceCharacteristic } from './Cas1SpaceCharacteristic';
 import type { Gender } from './Gender';
 export type Cas1SpaceSearchRequirements = {
+    /**
+     * Searching on multiple types is not supported, instead use apType. If this is used, the first type wll be matched, and type 'normal' will be ignored
+     * @deprecated
+     */
     apTypes?: Array<ApType>;
+    apType?: ApType;
     spaceCharacteristics?: Array<Cas1SpaceCharacteristic>;
     /**
      * gender is obtained from application's associated gender

server/@types/shared/models/Cas2Application.ts

@@ -2,18 +2,18 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { AnyValue } from './AnyValue';
 import type { Application } from './Application';
 import type { ApplicationStatus } from './ApplicationStatus';
 import type { Cas2Assessment } from './Cas2Assessment';
 import type { Cas2TimelineEvent } from './Cas2TimelineEvent';
 import type { NomisUser } from './NomisUser';
+import type { Unit } from './Unit';
 export type Cas2Application = (Application & {
     createdBy: NomisUser;
     schemaVersion: string;
     outdatedSchema: boolean;
-    data?: AnyValue;
-    document?: AnyValue;
+    data?: Unit;
+    document?: Unit;
     status: ApplicationStatus;
     submittedAt?: string;
     telephoneNumber?: string;

server/@types/shared/models/Cas2SubmittedApplication.ts

@@ -2,19 +2,19 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { AnyValue } from './AnyValue';
 import type { Cas2Assessment } from './Cas2Assessment';
 import type { Cas2TimelineEvent } from './Cas2TimelineEvent';
 import type { NomisUser } from './NomisUser';
 import type { Person } from './Person';
+import type { Unit } from './Unit';
 export type Cas2SubmittedApplication = {
     id: string;
     person: Person;
     createdAt: string;
     submittedBy?: NomisUser;
     schemaVersion: string;
     outdatedSchema: boolean;
-    document?: AnyValue;
+    document?: Unit;
     submittedAt?: string;
     telephoneNumber?: string;
     timelineEvents: Array<Cas2TimelineEvent>;

server/@types/shared/models/PlacementApplication.ts

@@ -2,10 +2,10 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { AnyValue } from './AnyValue';
 import type { NewPlacementApplication } from './NewPlacementApplication';
 import type { PlacementApplicationType } from './PlacementApplicationType';
 import type { PlacementDates } from './PlacementDates';
+import type { Unit } from './Unit';
 import type { WithdrawPlacementRequestReason } from './WithdrawPlacementRequestReason';
 export type PlacementApplication = (NewPlacementApplication & {
     /**
@@ -23,8 +23,8 @@ export type PlacementApplication = (NewPlacementApplication & {
     assessmentId: string;
     assessmentCompletedAt: string;
     applicationCompletedAt: string;
-    data?: AnyValue;
-    document?: AnyValue;
+    data?: Unit;
+    document?: Unit;
     canBeWithdrawn: boolean;
     isWithdrawn: boolean;
     withdrawalReason?: WithdrawPlacementRequestReason;

server/@types/shared/models/ReferralHistoryNoteMessageDetails.ts

@@ -2,11 +2,11 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { AnyValue } from './AnyValue';
+import type { Unit } from './Unit';
 export type ReferralHistoryNoteMessageDetails = {
     rejectionReason?: string;
     rejectionReasonDetails?: string;
     isWithdrawn?: boolean;
-    domainEvent?: AnyValue;
+    domainEvent?: Unit;
 };
 

server/@types/shared/models/RequestForPlacement.ts

@@ -2,10 +2,10 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { AnyValue } from './AnyValue';
 import type { PlacementDates } from './PlacementDates';
 import type { RequestForPlacementStatus } from './RequestForPlacementStatus';
 import type { RequestForPlacementType } from './RequestForPlacementType';
+import type { Unit } from './Unit';
 import type { WithdrawPlacementRequestReason } from './WithdrawPlacementRequestReason';
 export type RequestForPlacement = {
     /**
@@ -23,7 +23,7 @@ export type RequestForPlacement = {
      *
      */
     requestReviewedAt?: string;
-    document?: AnyValue;
+    document?: Unit;
     /**
      * If true, the user making this request can withdraw this request for placement.
      * If false, it may still be possible to indirectly withdraw this request for placement by withdrawing the application.

server/@types/shared/models/SeedFileType.ts

@@ -2,4 +2,4 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-export type SeedFileType = 'approved_premises' | 'approved_premises_rooms' | 'temporary_accommodation_premises' | 'temporary_accommodation_bedspace' | 'user' | 'nomis_users' | 'external_users' | 'cas2_applications' | 'temporary_accommodation_users' | 'approved_premises_users' | 'characteristics' | 'update_noms_number' | 'update_users_from_api' | 'approved_premises_ap_staff_users' | 'approved_premises_cancel_bookings' | 'approved_premises_assessment_more_info_bug_fix' | 'approved_premises_redact_assessment_details' | 'approved_premises_booking_to_space_booking' | 'approved_premises_withdraw_placement_request' | 'approved_premises_replay_domain_events' | 'approved_premises_duplicate_application' | 'approved_premises_update_event_number' | 'approved_premises_link_booking_to_placement_request' | 'approved_premises_out_of_service_beds' | 'approved_premises_cru_management_areas' | 'approved_premises_space_planning_dry_run' | 'approved_premises_import_delius_booking_management_data' | 'approved_premises_update_space_booking' | 'temporary_accommodation_referral_rejection';
+export type SeedFileType = 'approved_premises' | 'approved_premises_rooms' | 'temporary_accommodation_premises' | 'temporary_accommodation_bedspace' | 'user' | 'nomis_users' | 'external_users' | 'cas2_applications' | 'temporary_accommodation_users' | 'approved_premises_users' | 'characteristics' | 'update_noms_number' | 'update_users_from_api' | 'approved_premises_ap_staff_users' | 'approved_premises_cancel_bookings' | 'approved_premises_assessment_more_info_bug_fix' | 'approved_premises_redact_assessment_details' | 'approved_premises_booking_to_space_booking' | 'approved_premises_withdraw_placement_request' | 'approved_premises_replay_domain_events' | 'approved_premises_duplicate_application' | 'approved_premises_update_event_number' | 'approved_premises_link_booking_to_placement_request' | 'approved_premises_out_of_service_beds' | 'approved_premises_cru_management_areas' | 'approved_premises_space_planning_dry_run' | 'approved_premises_import_delius_referrals' | 'approved_premises_update_space_booking' | 'temporary_accommodation_referral_rejection';

server/@types/shared/models/SeedFromExcelFileType.ts

@@ -2,4 +2,4 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-export type SeedFromExcelFileType = 'approved_premises_room' | 'cas1_import_site_survey_premise';
+export type SeedFromExcelFileType = 'cas1_import_site_survey_rooms' | 'cas1_import_site_survey_premises';

server/@types/shared/models/SeedFromExcelRequest.ts

@@ -5,7 +5,6 @@
 import type { SeedFromExcelFileType } from './SeedFromExcelFileType';
 export type SeedFromExcelRequest = {
     seedType: SeedFromExcelFileType;
-    premisesId: string;
     fileName: string;
 };
 

server/@types/shared/models/SubmitApplication.ts

@@ -2,9 +2,9 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { AnyValue } from './AnyValue';
+import type { Unit } from './Unit';
 export type SubmitApplication = {
     type: string;
-    translatedDocument?: AnyValue;
+    translatedDocument?: Unit;
 };
 

server/@types/shared/models/SubmitCas2Application.ts

@@ -2,9 +2,9 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { AnyValue } from './AnyValue';
+import type { Unit } from './Unit';
 export type SubmitCas2Application = {
-    translatedDocument: AnyValue;
+    translatedDocument: Unit;
     /**
      * Id of the application being submitted
      */

server/@types/shared/models/SubmitPlacementApplication.ts

@@ -2,11 +2,11 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { AnyValue } from './AnyValue';
 import type { PlacementDates } from './PlacementDates';
 import type { PlacementType } from './PlacementType';
+import type { Unit } from './Unit';
 export type SubmitPlacementApplication = {
-    translatedDocument: AnyValue;
+    translatedDocument: Unit;
     placementType: PlacementType;
     placementDates: Array<PlacementDates>;
 };

server/@types/shared/models/SubmitTemporaryAccommodationApplication.ts

@@ -2,8 +2,8 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { AnyValue } from './AnyValue';
 import type { SubmitApplication } from './SubmitApplication';
+import type { Unit } from './Unit';
 export type SubmitTemporaryAccommodationApplication = (SubmitApplication & {
     arrivalDate: string;
     isRegisteredSexOffender?: boolean;
@@ -22,6 +22,6 @@ export type SubmitTemporaryAccommodationApplication = (SubmitApplication & {
     isConcerningSexualBehaviour?: boolean;
     isConcerningArsonBehaviour?: boolean;
     prisonReleaseTypes?: Array<string>;
-    summaryData: AnyValue;
+    summaryData: Unit;
 });
 

server/@types/shared/models/TemporaryAccommodationApplication.ts

@@ -2,16 +2,16 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { AnyValue } from './AnyValue';
 import type { Application } from './Application';
 import type { ApplicationStatus } from './ApplicationStatus';
 import type { PersonRisks } from './PersonRisks';
+import type { Unit } from './Unit';
 export type TemporaryAccommodationApplication = (Application & {
     createdByUserId: string;
     schemaVersion: string;
     outdatedSchema: boolean;
-    data?: AnyValue;
-    document?: AnyValue;
+    data?: Unit;
+    document?: Unit;
     status: ApplicationStatus;
     risks?: PersonRisks;
     submittedAt?: string;