Skip to content

Commit 7025266

Browse files
PhilipGloverPhilipGlover
authored
Merge pull request #758 from companieshouse/feature/rename-psc-appointment-id
Rename psc-appointment-id to psc-notification-id
2 parents 9cc1d4d + eb57b7e commit 7025266

File tree

5 files changed

+25
-25
lines changed

5 files changed

+25
-25
lines changed

‎src/services/psc-verification-link/types.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ export interface PscVerificationResource {
139139

140140
export interface PscVerificationDataResource {
141141
company_number?: string,
142-
psc_appointment_id?: string,
142+
psc_notification_id?: string,
143143
verification_details?: VerificationDetailsResource
144144
}
145145

@@ -151,7 +151,7 @@ export interface PscVerification {
151151
}
152152
export interface PscVerificationData {
153153
companyNumber?: string,
154-
pscAppointmentId?: string,
154+
pscNotificationId?: string,
155155
verificationDetails?: VerificationDetails
156156
}
157157

‎test/services/psc-verification-link/service.mock.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { NameMismatchReasonEnum, PlannedMaintenance, PscVerification, PscVerific
55
export const requestClient = new RequestClient({ baseUrl: "URL_NOT_USED", oauthToken: "123" });
66

77
export const COMPANY_NUMBER = "12345678";
8-
export const PSC_VERIFICATION_ID = "662a0de6a2c6f9aead0f32ab"
8+
export const PSC_NOTIFICATION_ID = "662a0de6a2c6f9aead0f32ab"
99
export const TRANSACTION_ID = "12345";
1010
export const FILING_ID = "00112233";
1111
export const FIRST_DATE = new Date("2024-03-13T10:08:42Z");
@@ -19,7 +19,7 @@ export const PSC_VERIFICATION_CREATED: PscVerificationData = {
1919

2020
export const PSC_VERIFICATION_IND: PscVerificationData = {
2121
companyNumber: COMPANY_NUMBER,
22-
pscAppointmentId: PSC_VERIFICATION_ID,
22+
pscNotificationId: PSC_NOTIFICATION_ID,
2323
verificationDetails: {
2424
nameMismatchReason: NameMismatchReasonEnum.LEGAL_NAME_CHANGE,
2525
verificationStatements: [VerificationStatementEnum.INDIVIDUAL_VERIFIED]
@@ -55,7 +55,7 @@ export const mockPscVerificationCreatedResource: PscVerificationResource = {
5555
};
5656

5757
const PSC_VERIFICATION_INDV_PATCH: PscVerificationDataResource = {
58-
psc_appointment_id: PSC_VERIFICATION_ID
58+
psc_notification_id: PSC_NOTIFICATION_ID
5959
};
6060

6161
export const mockPscVerificationPatchedResource: PscVerificationResource = {
@@ -79,7 +79,7 @@ export const mockPscVerificationPatchIndResource: PscVerificationResource = {
7979
};
8080

8181
const PSC_VERIFICATION_INDV_PATCH_CAMEL: PscVerificationData = {
82-
pscAppointmentId: PSC_VERIFICATION_ID
82+
pscNotificationId: PSC_NOTIFICATION_ID
8383
};
8484

8585
export const mockPscVerificationPatchInd: PscVerification = {
@@ -100,7 +100,7 @@ export const mockPscVerificationCreatedResponse = {
100100

101101
const PSC_VERIFICATION_IND_RESOURCE: PscVerificationDataResource = {
102102
company_number: COMPANY_NUMBER,
103-
psc_appointment_id: PSC_VERIFICATION_ID,
103+
psc_notification_id: PSC_NOTIFICATION_ID,
104104
verification_details: {
105105
name_mismatch_reason: NameMismatchReasonEnum.LEGAL_NAME_CHANGE,
106106
verification_statements: [VerificationStatementEnum.INDIVIDUAL_VERIFIED]
@@ -109,7 +109,7 @@ const PSC_VERIFICATION_IND_RESOURCE: PscVerificationDataResource = {
109109

110110
export const PSC_VERIFICATION_IND_CAMEL: PscVerificationData = {
111111
companyNumber: COMPANY_NUMBER,
112-
pscAppointmentId: PSC_VERIFICATION_ID,
112+
pscNotificationId: PSC_NOTIFICATION_ID,
113113
verificationDetails: {
114114
nameMismatchReason: NameMismatchReasonEnum.LEGAL_NAME_CHANGE,
115115
verificationStatements: [VerificationStatementEnum.INDIVIDUAL_VERIFIED]

‎test/services/psc-verification-link/service.spec.ts‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import * as sinon from "sinon";
55
import PscVerificationService from "../../../src/services/psc-verification-link/service";
66
import { PlannedMaintenance, PscVerification, ValidationStatusResponse } from "../../../src/services/psc-verification-link/types";
77
import Resource, { ApiErrorResponse, ApiResponse } from "../../../src/services/resource";
8-
import { COMPANY_NUMBER, FILING_ID, PSC_VERIFICATION_CREATED, PSC_VERIFICATION_ID, PSC_VERIFICATION_IND, TRANSACTION_ID, mockPlannedMaintenanceResource, mockPlannedMaintenanceResponse, mockGetValidationStatusResponseErrors, mockGetValidationStatusResponse, mockPscVerificationCreated, mockPscVerificationCreatedResponse, mockPscVerificationInd, mockPscVerificationIndResponse, mockPscVerificationPatchInd, mockPscVerificationPatchIndResponse, requestClient, mockValidationStatusResponseValid, mockValidationStatusResponseErrors } from "./service.mock";
8+
import { COMPANY_NUMBER, FILING_ID, PSC_VERIFICATION_CREATED, PSC_NOTIFICATION_ID, PSC_VERIFICATION_IND, TRANSACTION_ID, mockPlannedMaintenanceResource, mockPlannedMaintenanceResponse, mockGetValidationStatusResponseErrors, mockGetValidationStatusResponse, mockPscVerificationCreated, mockPscVerificationCreatedResponse, mockPscVerificationInd, mockPscVerificationIndResponse, mockPscVerificationPatchInd, mockPscVerificationPatchIndResponse, requestClient, mockValidationStatusResponseValid, mockValidationStatusResponseErrors } from "./service.mock";
99

1010
describe("PSC Verification Link", () => {
1111
const pscService = new PscVerificationService(requestClient);
@@ -50,7 +50,7 @@ describe("PSC Verification Link", () => {
5050

5151
const response = (await pscService.getPscVerification(
5252
TRANSACTION_ID,
53-
PSC_VERIFICATION_ID
53+
PSC_NOTIFICATION_ID
5454
)) as Resource<PscVerification>;
5555

5656
expect(response.httpStatusCode).to.equal(StatusCodes.OK);
@@ -60,7 +60,7 @@ describe("PSC Verification Link", () => {
6060
it("should return status 401 Unauthorised on unauthorised access", async () => {
6161
sinon.stub(requestClient, "httpGet").resolves(mockPscVerificationIndResponse[401]);
6262

63-
const response = await pscService.getPscVerification(TRANSACTION_ID, PSC_VERIFICATION_ID) as ApiErrorResponse;
63+
const response = await pscService.getPscVerification(TRANSACTION_ID, PSC_NOTIFICATION_ID) as ApiErrorResponse;
6464

6565
expect(response.httpStatusCode).to.equal(StatusCodes.UNAUTHORIZED);
6666
expect(response.errors?.[0]).to.equal(ReasonPhrases.UNAUTHORIZED);
@@ -69,7 +69,7 @@ describe("PSC Verification Link", () => {
6969
it("should return status 404 Not Found if resource id not found", async () => {
7070
sinon.stub(requestClient, "httpGet").resolves(mockPscVerificationIndResponse[404]);
7171

72-
const response = await pscService.getPscVerification(TRANSACTION_ID, PSC_VERIFICATION_ID) as ApiErrorResponse;
72+
const response = await pscService.getPscVerification(TRANSACTION_ID, PSC_NOTIFICATION_ID) as ApiErrorResponse;
7373

7474
expect(response.httpStatusCode).to.equal(StatusCodes.NOT_FOUND);
7575
expect(response.errors?.[0]).to.equal(ReasonPhrases.NOT_FOUND);
@@ -112,7 +112,7 @@ describe("PSC Verification Link", () => {
112112

113113
const response = (await pscService.getValidationStatus(
114114
TRANSACTION_ID,
115-
PSC_VERIFICATION_ID
115+
PSC_NOTIFICATION_ID
116116
)) as Resource<ValidationStatusResponse>;
117117

118118
expect(response.httpStatusCode).to.equal(StatusCodes.OK);
@@ -126,7 +126,7 @@ describe("PSC Verification Link", () => {
126126

127127
const response = (await pscService.getValidationStatus(
128128
TRANSACTION_ID,
129-
PSC_VERIFICATION_ID
129+
PSC_NOTIFICATION_ID
130130
)) as Resource<ValidationStatusResponse>;
131131

132132
expect(response.httpStatusCode).to.equal(StatusCodes.OK);
@@ -138,7 +138,7 @@ describe("PSC Verification Link", () => {
138138
it("should return status 401 Unauthorised on unauthorised access", async () => {
139139
sinon.stub(requestClient, "httpGet").resolves(mockGetValidationStatusResponse[401]);
140140

141-
const response = await pscService.getValidationStatus(TRANSACTION_ID, PSC_VERIFICATION_ID) as ApiErrorResponse;
141+
const response = await pscService.getValidationStatus(TRANSACTION_ID, PSC_NOTIFICATION_ID) as ApiErrorResponse;
142142

143143
expect(response.httpStatusCode).to.equal(StatusCodes.UNAUTHORIZED);
144144
expect(response.errors?.[0]).to.equal(ReasonPhrases.UNAUTHORIZED);
@@ -147,7 +147,7 @@ describe("PSC Verification Link", () => {
147147
it("should return status 404 Not Found if resource is not found", async () => {
148148
sinon.stub(requestClient, "httpGet").resolves(mockGetValidationStatusResponse[404]);
149149

150-
const response = await pscService.getValidationStatus(TRANSACTION_ID, PSC_VERIFICATION_ID) as ApiErrorResponse;
150+
const response = await pscService.getValidationStatus(TRANSACTION_ID, PSC_NOTIFICATION_ID) as ApiErrorResponse;
151151

152152
expect(response.httpStatusCode).to.equal(StatusCodes.NOT_FOUND);
153153
expect(response.errors?.[0]).to.equal(ReasonPhrases.NOT_FOUND);
@@ -156,7 +156,7 @@ describe("PSC Verification Link", () => {
156156
it("should return status 500 Internal Server Error if a server error occurs", async () => {
157157
sinon.stub(requestClient, "httpGet").resolves(mockGetValidationStatusResponse[500]);
158158

159-
const response = await pscService.getValidationStatus(TRANSACTION_ID, PSC_VERIFICATION_ID) as ApiErrorResponse;
159+
const response = await pscService.getValidationStatus(TRANSACTION_ID, PSC_NOTIFICATION_ID) as ApiErrorResponse;
160160

161161
expect(response.httpStatusCode).to.equal(StatusCodes.INTERNAL_SERVER_ERROR);
162162
expect(response.errors?.[0]).to.equal(ReasonPhrases.INTERNAL_SERVER_ERROR);
@@ -187,7 +187,7 @@ describe("PSC Verification Link", () => {
187187
it("should return status 500 Internal Server Error if a server error occurs", async () => {
188188
sinon.stub(requestClient, "httpGet").resolves(mockGetValidationStatusResponse[500]);
189189

190-
const response = await pscService.getValidationStatus(TRANSACTION_ID, PSC_VERIFICATION_ID) as ApiErrorResponse;
190+
const response = await pscService.getValidationStatus(TRANSACTION_ID, PSC_NOTIFICATION_ID) as ApiErrorResponse;
191191

192192
expect(response.httpStatusCode).to.equal(StatusCodes.INTERNAL_SERVER_ERROR);
193193
expect(response.errors?.[0]).to.equal(ReasonPhrases.INTERNAL_SERVER_ERROR);

‎test/services/psc/service.mock.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ import { PersonWithSignificantControlResource } from "../../../src/services/psc/
66
export const requestClient = new RequestClient({ baseUrl: "URL_NOT_USED", oauthToken: "123" });
77

88
export const COMPANY_NUMBER = "12345678";
9-
export const PSC_ID = "67edfE436y35hetsie6zuAZtr"
9+
export const PSC_NOTIFICATION_ID = "67edfE436y35hetsie6zuAZtr"
1010
export const TRANSACTION_ID = "12345";
1111
export const FILING_ID = "00112233";
1212
export const FIRST_DATE = new Date("2024-03-13T10:08:42Z");
1313
export const UPDATE_DATE = new Date("2024-04-13T10:08:42Z");
1414
export const DOB_DATE = new Date("1970-01-01");
15-
export const SELF_LINK = `/company/${COMPANY_NUMBER}/persons-with-significant-control/individual/${PSC_ID}`;
15+
export const SELF_LINK = `/company/${COMPANY_NUMBER}/persons-with-significant-control/individual/${PSC_NOTIFICATION_ID}`;
1616
export const KIND_INDIVIDUAL = "individual-person-with-significant-control";
1717
export const NATURE_OF_CONTROL = ["ownership-of-shares-75-to-100-percent", "voting-rights-75-to-100-percent-as-trust"]
1818
export const NAME = "Sir Forename Middlename Surname";
@@ -68,7 +68,7 @@ export const mockPscVerificationCreatedResource: PscVerificationResource = {
6868
};
6969

7070
export const PSC_VERIFICATION_INDV_PATCH: PscVerificationDataResource = {
71-
psc_appointment_id: PSC_ID
71+
psc_notification_id: PSC_NOTIFICATION_ID
7272
};
7373

7474
export const mockPscVerificationCreatedResponse = {

‎test/services/psc/service.spec.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import * as sinon from "sinon";
55
import PscService from "../../../src/services/psc/service";
66
import { PersonWithSignificantControl } from "../../../src/services/psc/types";
77
import Resource, { ApiErrorResponse } from "../../../src/services/resource";
8-
import { COMPANY_NUMBER, PSC_ID, PSC_INDIVIDUAL, mockIndividualResponse, requestClient } from "./service.mock";
8+
import { COMPANY_NUMBER, PSC_NOTIFICATION_ID, PSC_INDIVIDUAL, mockIndividualResponse, requestClient } from "./service.mock";
99
import Mapping from "../../../src/mapping/mapping";
1010

1111
describe("PSC details", () => {
@@ -16,7 +16,7 @@ describe("PSC details", () => {
1616
sinon.stub(requestClient, "httpGet").resolves(mockIndividualResponse[200]);
1717

1818
const response = (await pscService.getPscIndividual(
19-
COMPANY_NUMBER, PSC_ID)) as Resource<PersonWithSignificantControl>;
19+
COMPANY_NUMBER, PSC_NOTIFICATION_ID)) as Resource<PersonWithSignificantControl>;
2020

2121
expect(response.httpStatusCode).to.equal(StatusCodes.OK);
2222
expect(response.resource).to.eql(Mapping.camelCaseKeys(PSC_INDIVIDUAL));
@@ -25,7 +25,7 @@ describe("PSC details", () => {
2525
it("should return status 401 Unauthorised on unauthorised access", async () => {
2626
sinon.stub(requestClient, "httpGet").resolves(mockIndividualResponse[401]);
2727

28-
const response = await pscService.getPscIndividual(COMPANY_NUMBER, PSC_ID) as ApiErrorResponse;
28+
const response = await pscService.getPscIndividual(COMPANY_NUMBER, PSC_NOTIFICATION_ID) as ApiErrorResponse;
2929

3030
expect(response.httpStatusCode).to.equal(StatusCodes.UNAUTHORIZED);
3131
expect(response.errors?.[0]).to.equal(ReasonPhrases.UNAUTHORIZED);
@@ -34,7 +34,7 @@ describe("PSC details", () => {
3434
it("should return status 404 Not Found if resource id not found", async () => {
3535
sinon.stub(requestClient, "httpGet").resolves(mockIndividualResponse[404]);
3636

37-
const response = await pscService.getPscIndividual(COMPANY_NUMBER, PSC_ID) as ApiErrorResponse;
37+
const response = await pscService.getPscIndividual(COMPANY_NUMBER, PSC_NOTIFICATION_ID) as ApiErrorResponse;
3838

3939
expect(response.httpStatusCode).to.equal(StatusCodes.NOT_FOUND);
4040
expect(response.errors?.[0]).to.equal(ReasonPhrases.NOT_FOUND);

0 commit comments

Comments
 (0)