Skip to content

Commit d8ff2ea

Browse files
authored
Merge pull request #245 from companieshouse/bug/BI-9041_correct_principal_usage
BI-9041 Change to use correct word for certificate item options
2 parents b2f2931 + 69b38a4 commit d8ff2ea

File tree

6 files changed

+34
-34
lines changed

6 files changed

+34
-34
lines changed

src/services/order/certificates/mapping.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import {
99
GeneralPartnerDetails,
1010
LimitedPartnerDetailsResource,
1111
OrdinaryMemberDetailsResource,
12-
PrinciplePlaceOfBusinessDetailsResource,
12+
PrincipalPlaceOfBusinessDetailsResource,
1313
AddressDetailsRequest,
1414
AddressDetailsResource,
1515
GeneralPartnerDetailsResource,
@@ -19,7 +19,7 @@ import {
1919
PartnerDetailsRequest,
2020
PartnerDetailsResource,
2121
PartnerDetails,
22-
PrinciplePlaceOfBusinessDetails,
22+
PrincipalPlaceOfBusinessDetails,
2323
OrdinaryMemberDetails,
2424
LimitedPartnerDetails
2525
} from "./types";
@@ -38,8 +38,8 @@ export default class CertificateMapping {
3838
const registeredOfficeAddressDetails: RegisteredOfficeAddressDetailsResource =
3939
this.mapAddressDetailsRequestToAddressDetailsResource(itemOptions.registeredOfficeAddressDetails);
4040

41-
const principlePlaceOfBusinessDetails: PrinciplePlaceOfBusinessDetailsResource =
42-
this.mapAddressDetailsRequestToAddressDetailsResource(itemOptions.principlePlaceOfBusinessDetails);
41+
const principalPlaceOfBusinessDetails: PrincipalPlaceOfBusinessDetailsResource =
42+
this.mapAddressDetailsRequestToAddressDetailsResource(itemOptions.principalPlaceOfBusinessDetails);
4343

4444
const designatedMemberDetails: DesignatedMemberDetailsResource =
4545
this.mapMemberDetailsRequestToMemberDetailsResource(itemOptions.designatedMemberDetails);
@@ -71,7 +71,7 @@ export default class CertificateMapping {
7171
include_good_standing_information: itemOptions.includeGoodStandingInformation,
7272
limited_partner_details: limitedPartnerDetails,
7373
member_details: ordinaryMemberDetails,
74-
principle_place_of_business_details: principlePlaceOfBusinessDetails,
74+
principal_place_of_business_details: principalPlaceOfBusinessDetails,
7575
registered_office_address_details: registeredOfficeAddressDetails,
7676
secretary_details: secretaryDetails,
7777
surname: itemOptions.surname
@@ -92,8 +92,8 @@ export default class CertificateMapping {
9292
const registeredOfficeAddressDetails: RegisteredOfficeAddressDetails =
9393
this.mapAddressDetailsResourceToAddressDetails(io.registered_office_address_details);
9494

95-
const principlePlaceOfBusinessDetails: PrinciplePlaceOfBusinessDetails =
96-
this.mapAddressDetailsResourceToAddressDetails(io.principle_place_of_business_details);
95+
const principalPlaceOfBusinessDetails: PrincipalPlaceOfBusinessDetails =
96+
this.mapAddressDetailsResourceToAddressDetails(io.principal_place_of_business_details);
9797

9898
const designatedMemberDetails: DesignatedMemberDetails =
9999
this.mapMemberDetailsResourceToMemberDetails(io.designated_member_details);
@@ -139,7 +139,7 @@ export default class CertificateMapping {
139139
includeGoodStandingInformation: io.include_good_standing_information,
140140
limitedPartnerDetails,
141141
memberDetails: ordinaryMemberDetails,
142-
principlePlaceOfBusinessDetails,
142+
principalPlaceOfBusinessDetails,
143143
registeredOfficeAddressDetails,
144144
secretaryDetails,
145145
surname: io.surname

src/services/order/certificates/types.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export interface ItemOptionsResource {
4545
include_good_standing_information: boolean;
4646
limited_partner_details: LimitedPartnerDetailsResource;
4747
member_details: OrdinaryMemberDetailsResource;
48-
principle_place_of_business_details: PrinciplePlaceOfBusinessDetailsResource;
48+
principal_place_of_business_details: PrincipalPlaceOfBusinessDetailsResource;
4949
registered_office_address_details: RegisteredOfficeAddressDetailsResource;
5050
secretary_details: DirectorOrSecretaryDetailsResource;
5151
surname: string;
@@ -69,7 +69,7 @@ export interface AddressDetailsResource {
6969
export interface RegisteredOfficeAddressDetailsResource extends AddressDetailsResource {
7070
}
7171

72-
export interface PrinciplePlaceOfBusinessDetailsResource extends AddressDetailsResource {
72+
export interface PrincipalPlaceOfBusinessDetailsResource extends AddressDetailsResource {
7373
}
7474

7575
export interface MemberDetailsResource {
@@ -147,7 +147,7 @@ export interface ItemOptions {
147147
includeGoodStandingInformation: boolean;
148148
limitedPartnerDetails?: LimitedPartnerDetails;
149149
memberDetails?: OrdinaryMemberDetails;
150-
principlePlaceOfBusinessDetails?: PrinciplePlaceOfBusinessDetails;
150+
principalPlaceOfBusinessDetails?: PrincipalPlaceOfBusinessDetails;
151151
registeredOfficeAddressDetails?: RegisteredOfficeAddressDetails;
152152
secretaryDetails?: DirectorOrSecretaryDetails;
153153
surname: string;
@@ -171,7 +171,7 @@ export interface AddressDetails {
171171
export interface RegisteredOfficeAddressDetails extends AddressDetails {
172172
}
173173

174-
export interface PrinciplePlaceOfBusinessDetails extends AddressDetails {
174+
export interface PrincipalPlaceOfBusinessDetails extends AddressDetails {
175175
}
176176

177177
export interface MemberDetails {
@@ -234,7 +234,7 @@ export interface ItemOptionsRequest {
234234
includeGoodStandingInformation?: boolean | null;
235235
limitedPartnerDetails?: LimitedPartnerDetailsRequest;
236236
memberDetails?: OrdinaryMemberDetailsRequest;
237-
principlePlaceOfBusinessDetails?: PrinciplePlaceOfBusinessDetailsRequest;
237+
principalPlaceOfBusinessDetails?: PrincipalPlaceOfBusinessDetailsRequest;
238238
registeredOfficeAddressDetails?: RegisteredOfficeAddressDetailsRequest;
239239
secretaryDetails?: DirectorOrSecretaryDetailsRequest;
240240
surname?: string;
@@ -258,7 +258,7 @@ export interface AddressDetailsRequest {
258258
export interface RegisteredOfficeAddressDetailsRequest extends AddressDetailsRequest {
259259
}
260260

261-
export interface PrinciplePlaceOfBusinessDetailsRequest extends AddressDetailsRequest {
261+
export interface PrincipalPlaceOfBusinessDetailsRequest extends AddressDetailsRequest {
262262
}
263263

264264
export interface MemberDetailsRequest {

src/services/order/order/mapping.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,8 @@ export default class OrderMapping {
116116
includeAddressRecordsType: itemResource?.registered_office_address_details?.include_address_records_type
117117
});
118118

119-
const principlePlaceOfBusinessDetails = this.removeEmptyObjects({
120-
includeAddressRecordsType: itemResource?.principle_place_of_business_details?.include_address_records_type
119+
const principalPlaceOfBusinessDetails = this.removeEmptyObjects({
120+
includeAddressRecordsType: itemResource?.principal_place_of_business_details?.include_address_records_type
121121
});
122122

123123
const generalPartnerDetails = this.removeEmptyObjects({
@@ -141,7 +141,7 @@ export default class OrderMapping {
141141
limitedPartnerDetails: limitedPartnerDetails,
142142
memberDetails: memberDetails,
143143
registeredOfficeAddressDetails: registeredOfficeAddressDetails,
144-
principlePlaceOfBusinessDetails: principlePlaceOfBusinessDetails,
144+
principalPlaceOfBusinessDetails: principalPlaceOfBusinessDetails,
145145
secretaryDetails: secretaryDetails,
146146
directorDetails: directorDetails,
147147
forename: itemResource.forename,

src/services/order/order/types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ export interface CertificateItemOptions {
8989
includeCountryOfResidence?: boolean;
9090
includeDobType?: string;
9191
};
92-
principlePlaceOfBusinessDetails: {
92+
principalPlaceOfBusinessDetails: {
9393
includeAddressRecordsType?: string;
9494
};
9595
registeredOfficeAddressDetails: {
@@ -233,7 +233,7 @@ export interface CertificateItemOptionsResource {
233233
include_country_of_residence?: boolean;
234234
include_dob_type?: string;
235235
};
236-
principle_place_of_business_details: {
236+
principal_place_of_business_details: {
237237
include_address_records_type?: string;
238238
};
239239
registered_office_address_details: {

test/services/certificates/service.spec.ts

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ const mockResponseBody : CertificateItemResource = ({
6161
limited_partner_details: {
6262
include_basic_information: true
6363
},
64-
principle_place_of_business_details: {
64+
principal_place_of_business_details: {
6565
include_address_records_type: "include address",
6666
include_dates: true
6767
},
@@ -131,7 +131,7 @@ const mockResponseBodyMissingFields : CertificateItemResource = ({
131131
include_good_standing_information: true,
132132
limited_partner_details: undefined,
133133
member_details: undefined,
134-
principle_place_of_business_details: undefined,
134+
principal_place_of_business_details: undefined,
135135
registered_office_address_details: undefined,
136136
secretary_details: undefined,
137137
surname: undefined
@@ -184,7 +184,7 @@ describe("order a certificate GET", () => {
184184
const resourceItemOptions = data.resource.itemOptions;
185185
const resourceDirectorDetails = resourceItemOptions.directorDetails;
186186
const resourceDesignatedMemberDetails = resourceItemOptions.designatedMemberDetails;
187-
const resourcePrinciplePlaceOfBusinessDetails = resourceItemOptions.principlePlaceOfBusinessDetails;
187+
const resourcePrincipalPlaceOfBusinessDetails = resourceItemOptions.principalPlaceOfBusinessDetails;
188188
const resourceMemberDetails = resourceItemOptions.memberDetails;
189189
const resourceLimitedPartnerDetails = resourceItemOptions.limitedPartnerDetails;
190190
const resourceGeneralPartnerDetails = resourceItemOptions.generalPartnerDetails;
@@ -197,7 +197,7 @@ describe("order a certificate GET", () => {
197197
const mockSecretaryDetails = mockItemOptions.secretary_details;
198198
const mockItemCosts = mockResponseBody.item_costs;
199199
const mockDesignatedMemberDetails = mockItemOptions.designated_member_details;
200-
const mockPrinciplePlaceOfBusinessDetails = mockItemOptions.principle_place_of_business_details;
200+
const mockPrincipalPlaceOfBusinessDetails = mockItemOptions.principal_place_of_business_details;
201201
const mockMemberDetails = mockItemOptions.member_details;
202202
const mockLimitedPartnerDetails = mockItemOptions.limited_partner_details;
203203
const mockGeneralPartnerDetails = mockItemOptions.general_partner_details;
@@ -246,8 +246,8 @@ describe("order a certificate GET", () => {
246246
expect(resourceMemberDetails.includeBasicInformation).to.equal(mockMemberDetails.include_basic_information);
247247
expect(resourceMemberDetails.includeCountryOfResidence).to.equal(mockMemberDetails.include_country_of_residence);
248248
expect(resourceMemberDetails.includeDobType).to.equal(mockMemberDetails.include_dob_type);
249-
expect(resourcePrinciplePlaceOfBusinessDetails.includeAddressRecordsType).to.equal(mockPrinciplePlaceOfBusinessDetails.include_address_records_type);
250-
expect(resourcePrinciplePlaceOfBusinessDetails.includeDates).to.equal(mockPrinciplePlaceOfBusinessDetails.include_dates);
249+
expect(resourcePrincipalPlaceOfBusinessDetails.includeAddressRecordsType).to.equal(mockPrincipalPlaceOfBusinessDetails.include_address_records_type);
250+
expect(resourcePrincipalPlaceOfBusinessDetails.includeDates).to.equal(mockPrincipalPlaceOfBusinessDetails.include_dates);
251251
expect(resourceRegisteredOfficeAddressDetails.includeAddressRecordsType).to.equal(mockRegisteredOfficeAddressDetails.include_address_records_type);
252252
expect(resourceRegisteredOfficeAddressDetails.includeDates).to.equal(mockRegisteredOfficeAddressDetails.include_dates);
253253
expect(resourceSecretaryDetails.includeAddress).to.equal(mockSecretaryDetails.include_address);
@@ -280,7 +280,7 @@ describe("order a certificate GET", () => {
280280
const resourceRegisteredOfficeAddressDetails = resourceItemOptions.registeredOfficeAddressDetails;
281281
const resourceSecretaryDetails = resourceItemOptions.secretaryDetails;
282282
const resourceDesignatedMemberDetails = resourceItemOptions.designatedMemberDetails;
283-
const resourcePrinciplePlaceOfBusinessDetails = resourceItemOptions.principlePlaceOfBusinessDetails;
283+
const resourcePrincipalPlaceOfBusinessDetails = resourceItemOptions.principalPlaceOfBusinessDetails;
284284
const resourceMemberDetails = resourceItemOptions.memberDetails;
285285
const resourceLimitedPartnerDetails = resourceItemOptions.limitedPartnerDetails;
286286
const resourceGeneralPartnerDetails = resourceItemOptions.generalPartnerDetails;
@@ -324,7 +324,7 @@ describe("order a certificate GET", () => {
324324
expect(resourceItemOptions.includeGoodStandingInformation).to.equal(mockItemOptions.include_good_standing_information);
325325
expect(resourceLimitedPartnerDetails).to.be.undefined;
326326
expect(resourceMemberDetails).to.be.undefined;
327-
expect(resourcePrinciplePlaceOfBusinessDetails).to.be.undefined;
327+
expect(resourcePrincipalPlaceOfBusinessDetails).to.be.undefined;
328328
expect(resourceRegisteredOfficeAddressDetails?.includeAddressRecordsType).to.be.undefined;
329329
expect(resourceRegisteredOfficeAddressDetails?.includeDates).to.be.undefined;
330330
expect(resourceSecretaryDetails?.includeAddress).to.be.undefined;
@@ -388,7 +388,7 @@ describe("create a certificate POST", () => {
388388
includeCountryOfResidence: true,
389389
includeDobType: "dob"
390390
},
391-
principlePlaceOfBusinessDetails: {
391+
principalPlaceOfBusinessDetails: {
392392
includeAddressRecordsType: "include address",
393393
includeDates: true
394394
},
@@ -480,8 +480,8 @@ describe("create a certificate POST", () => {
480480
expect(io.memberDetails.includeBasicInformation).to.equal(mockIo.member_details.include_basic_information);
481481
expect(io.memberDetails.includeCountryOfResidence).to.equal(mockIo.member_details.include_country_of_residence);
482482
expect(io.memberDetails.includeDobType).to.equal(mockIo.member_details.include_dob_type);
483-
expect(io.principlePlaceOfBusinessDetails.includeAddressRecordsType).to.equal(mockIo.registered_office_address_details.include_address_records_type);
484-
expect(io.principlePlaceOfBusinessDetails.includeDates).to.equal(mockIo.registered_office_address_details.include_dates);
483+
expect(io.principalPlaceOfBusinessDetails.includeAddressRecordsType).to.equal(mockIo.registered_office_address_details.include_address_records_type);
484+
expect(io.principalPlaceOfBusinessDetails.includeDates).to.equal(mockIo.registered_office_address_details.include_dates);
485485
expect(io.registeredOfficeAddressDetails.includeAddressRecordsType).to.equal(mockIo.registered_office_address_details.include_address_records_type);
486486
expect(io.registeredOfficeAddressDetails.includeDates).to.equal(mockIo.registered_office_address_details.include_dates);
487487
expect(io.secretaryDetails.includeAddress).to.equal(mockIo.secretary_details.include_address);
@@ -573,7 +573,7 @@ describe("update a certificate PATCH", () => {
573573
includeCountryOfResidence: true,
574574
includeDobType: "dob"
575575
},
576-
principlePlaceOfBusinessDetails: {
576+
principalPlaceOfBusinessDetails: {
577577
includeAddressRecordsType: "include address",
578578
includeDates: true
579579
},
@@ -665,8 +665,8 @@ describe("update a certificate PATCH", () => {
665665
expect(io.memberDetails.includeBasicInformation).to.equal(mockIo.member_details.include_basic_information);
666666
expect(io.memberDetails.includeCountryOfResidence).to.equal(mockIo.member_details.include_country_of_residence);
667667
expect(io.memberDetails.includeDobType).to.equal(mockIo.member_details.include_dob_type);
668-
expect(io.principlePlaceOfBusinessDetails.includeAddressRecordsType).to.equal(mockIo.registered_office_address_details.include_address_records_type);
669-
expect(io.principlePlaceOfBusinessDetails.includeDates).to.equal(mockIo.registered_office_address_details.include_dates);
668+
expect(io.principalPlaceOfBusinessDetails.includeAddressRecordsType).to.equal(mockIo.registered_office_address_details.include_address_records_type);
669+
expect(io.principalPlaceOfBusinessDetails.includeDates).to.equal(mockIo.registered_office_address_details.include_dates);
670670
expect(io.registeredOfficeAddressDetails.includeAddressRecordsType).to.equal(mockIo.registered_office_address_details.include_address_records_type);
671671
expect(io.registeredOfficeAddressDetails.includeDates).to.equal(mockIo.registered_office_address_details.include_dates);
672672
expect(io.secretaryDetails.includeAddress).to.equal(mockIo.secretary_details.include_address);

test/services/order/service.spec.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ const mockCertificateOrderResponseBody: OrderResource = {
6969
member_details: {},
7070
include_general_nature_of_business_information: true,
7171
include_good_standing_information: true,
72-
principle_place_of_business_details: {},
72+
principal_place_of_business_details: {},
7373
registered_office_address_details: {},
7474
secretary_details: {},
7575
surname: "surname"

0 commit comments

Comments
 (0)