@companieshouse/api-sdk-node 2.0.46 → 2.0.47

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -33,10 +33,27 @@ class CompanyProfileService {
33
33
  // cast the response body to the expected type
34
34
  const body = resp.body;
35
35
  const roa = body.registered_office_address;
36
+ const serviceAddress = body.service_address;
36
37
  const acc = body.accounts;
37
38
  const nextAccs = acc === null || acc === void 0 ? void 0 : acc.next_accounts;
38
39
  const confirmationStatement = body.confirmation_statement;
40
+ const foreignCompanyDetailsResource = body.foreign_company_details;
41
+ const originatingRegistryResource = foreignCompanyDetailsResource === null || foreignCompanyDetailsResource === void 0 ? void 0 : foreignCompanyDetailsResource.originating_registry;
42
+ const originatingRegistry = (Object.keys(originatingRegistryResource || {}).length)
43
+ ? Object.assign({}, originatingRegistryResource) : {};
44
+ const foreignCompanyDetails = (Object.keys(foreignCompanyDetailsResource || {}).length)
45
+ ? {
46
+ businessActivity: foreignCompanyDetailsResource === null || foreignCompanyDetailsResource === void 0 ? void 0 : foreignCompanyDetailsResource.business_activity,
47
+ governedBy: foreignCompanyDetailsResource === null || foreignCompanyDetailsResource === void 0 ? void 0 : foreignCompanyDetailsResource.governed_by,
48
+ originatingRegistry: originatingRegistry,
49
+ isACreditFinacialInstitution: foreignCompanyDetailsResource === null || foreignCompanyDetailsResource === void 0 ? void 0 : foreignCompanyDetailsResource.is_a_credit_finacial_institution,
50
+ legalForm: foreignCompanyDetailsResource === null || foreignCompanyDetailsResource === void 0 ? void 0 : foreignCompanyDetailsResource.legal_form
51
+ }
52
+ : {};
39
53
  const links = body.links;
54
+ const isOnRegisterInCountryFormedIn = (body.is_on_register_in_country_formed_in)
55
+ ? body.is_on_register_in_country_formed_in === "true"
56
+ : false;
40
57
  resource.resource = {
41
58
  companyName: body.company_name,
42
59
  companyNumber: body.company_number,
@@ -61,6 +78,17 @@ class CompanyProfileService {
61
78
  premises: roa === null || roa === void 0 ? void 0 : roa.premises,
62
79
  region: roa === null || roa === void 0 ? void 0 : roa.region
63
80
  },
81
+ serviceAddress: {
82
+ addressLineOne: serviceAddress === null || serviceAddress === void 0 ? void 0 : serviceAddress.address_line_1,
83
+ addressLineTwo: serviceAddress === null || serviceAddress === void 0 ? void 0 : serviceAddress.address_line_2,
84
+ careOf: serviceAddress === null || serviceAddress === void 0 ? void 0 : serviceAddress.care_of,
85
+ country: serviceAddress === null || serviceAddress === void 0 ? void 0 : serviceAddress.country,
86
+ locality: serviceAddress === null || serviceAddress === void 0 ? void 0 : serviceAddress.locality,
87
+ poBox: serviceAddress === null || serviceAddress === void 0 ? void 0 : serviceAddress.po_box,
88
+ postalCode: serviceAddress === null || serviceAddress === void 0 ? void 0 : serviceAddress.postal_code,
89
+ premises: serviceAddress === null || serviceAddress === void 0 ? void 0 : serviceAddress.premises,
90
+ region: serviceAddress === null || serviceAddress === void 0 ? void 0 : serviceAddress.region
91
+ },
64
92
  accounts: {
65
93
  nextAccounts: {
66
94
  periodEndOn: nextAccs === null || nextAccs === void 0 ? void 0 : nextAccs.period_end_on,
@@ -75,6 +103,8 @@ class CompanyProfileService {
75
103
  nextMadeUpTo: confirmationStatement === null || confirmationStatement === void 0 ? void 0 : confirmationStatement.next_made_up_to,
76
104
  overdue: confirmationStatement === null || confirmationStatement === void 0 ? void 0 : confirmationStatement.overdue
77
105
  },
106
+ foreignCompanyDetails: foreignCompanyDetails,
107
+ isOnRegisterInCountryFormedIn: isOnRegisterInCountryFormedIn,
78
108
  links: {
79
109
  filingHistory: links === null || links === void 0 ? void 0 : links.filing_history
80
110
  }
@@ -1 +1 @@
1
- {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/company-profile/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAOA;;GAEG;AACH,MAAqB,qBAAqB;IACtC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEtD;;;;KAIC;IACY,iBAAiB,CAAE,MAAc;;YAC1C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,MAAM,EAAE,CAAC,CAAC;YAE7D,MAAM,QAAQ,GAA6B;gBACvC,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,QAAQ,CAAC;aACnB;YAED,8CAA8C;YAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,IAA8B,CAAC;YAEjD,MAAM,GAAG,GAAG,IAAI,CAAC,yBAA4D,CAAC;YAE9E,MAAM,GAAG,GAAG,IAAI,CAAC,QAA4B,CAAC;YAE9C,MAAM,QAAQ,GAAG,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,aAAqC,CAAC;YAE5D,MAAM,qBAAqB,GAAG,IAAI,CAAC,sBAAuD,CAAC;YAE3F,MAAM,KAAK,GAAG,IAAI,CAAC,KAAsB,CAAC;YAE1C,QAAQ,CAAC,QAAQ,GAAG;gBAChB,WAAW,EAAE,IAAI,CAAC,YAAY;gBAC9B,aAAa,EAAE,IAAI,CAAC,cAAc;gBAClC,aAAa,EAAE,IAAI,CAAC,cAAc;gBAClC,mBAAmB,EAAE,IAAI,CAAC,qBAAqB;gBAC/C,cAAc,EAAE,IAAI,CAAC,gBAAgB;gBACrC,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,QAAQ,EAAE,IAAI,CAAC,SAAS;gBACxB,iBAAiB,EAAE,IAAI,CAAC,mBAAmB;gBAC3C,kBAAkB,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,qBAAqB;gBAC/C,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,UAAU,EAAE,IAAI,CAAC,WAAW;gBAC5B,oBAAoB,EAAE,IAAI,CAAC,sBAAsB;gBACjD,uBAAuB,EAAE;oBACrB,cAAc,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,cAAc;oBACnC,cAAc,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,cAAc;oBACnC,MAAM,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO;oBACpB,OAAO,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO;oBACrB,QAAQ,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,QAAQ;oBACvB,KAAK,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM;oBAClB,UAAU,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,WAAW;oBAC5B,QAAQ,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,QAAQ;oBACvB,MAAM,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM;iBACtB;gBACD,QAAQ,EAAE;oBACN,YAAY,EAAE;wBACV,WAAW,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,aAAa;wBACpC,aAAa,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,eAAe;qBAC3C;oBACD,OAAO,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,QAAQ;oBACtB,OAAO,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO;iBACxB;gBACD,qBAAqB,EAAE;oBACnB,YAAY,EAAE,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,eAAe;oBACpD,OAAO,EAAE,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,QAAQ;oBACxC,YAAY,EAAE,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,eAAe;oBACpD,OAAO,EAAE,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,OAAO;iBAC1C;gBACD,KAAK,EAAE;oBACH,aAAa,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,cAAc;iBACvC;aACJ,CAAC;YAEF,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ;AA7ED,wCA6EC"}
1
+ {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/company-profile/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAOA;;GAEG;AACH,MAAqB,qBAAqB;IACtC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEtD;;;;KAIC;IACY,iBAAiB,CAAE,MAAc;;YAC1C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,MAAM,EAAE,CAAC,CAAC;YAE7D,MAAM,QAAQ,GAA6B;gBACvC,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,QAAQ,CAAC;aACnB;YAED,8CAA8C;YAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,IAA8B,CAAC;YAEjD,MAAM,GAAG,GAAG,IAAI,CAAC,yBAA4D,CAAC;YAC9E,MAAM,cAAc,GAAG,IAAI,CAAC,eAAyC,CAAC;YAEtE,MAAM,GAAG,GAAG,IAAI,CAAC,QAA4B,CAAC;YAE9C,MAAM,QAAQ,GAAG,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,aAAqC,CAAC;YAE5D,MAAM,qBAAqB,GAAG,IAAI,CAAC,sBAAuD,CAAC;YAE3F,MAAM,6BAA6B,GAAG,IAAI,CAAC,uBAAwD,CAAC;YAEpG,MAAM,2BAA2B,GAAG,6BAA6B,aAA7B,6BAA6B,uBAA7B,6BAA6B,CAAE,oBAAoB,CAAC;YACxF,MAAM,mBAAmB,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;gBAC/E,CAAC,mBAAM,2BAA2B,EAClC,CAAC,CAAC,EAAE,CAAC;YAET,MAAM,qBAAqB,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,6BAA6B,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;gBACnF,CAAC,CAAC;oBACE,gBAAgB,EAAE,6BAA6B,aAA7B,6BAA6B,uBAA7B,6BAA6B,CAAE,iBAAiB;oBAClE,UAAU,EAAE,6BAA6B,aAA7B,6BAA6B,uBAA7B,6BAA6B,CAAE,WAAW;oBACtD,mBAAmB,EAAE,mBAAmB;oBACxC,4BAA4B,EAAE,6BAA6B,aAA7B,6BAA6B,uBAA7B,6BAA6B,CAAE,gCAAgC;oBAC7F,SAAS,EAAE,6BAA6B,aAA7B,6BAA6B,uBAA7B,6BAA6B,CAAE,UAAU;iBACvD;gBACD,CAAC,CAAC,EAAE,CAAC;YAET,MAAM,KAAK,GAAG,IAAI,CAAC,KAAsB,CAAC;YAE1C,MAAM,6BAA6B,GAAG,CAAC,IAAI,CAAC,mCAAmC,CAAC;gBAC5E,CAAC,CAAC,IAAI,CAAC,mCAAmC,KAAK,MAAM;gBACrD,CAAC,CAAC,KAAK,CAAC;YAEZ,QAAQ,CAAC,QAAQ,GAAG;gBAChB,WAAW,EAAE,IAAI,CAAC,YAAY;gBAC9B,aAAa,EAAE,IAAI,CAAC,cAAc;gBAClC,aAAa,EAAE,IAAI,CAAC,cAAc;gBAClC,mBAAmB,EAAE,IAAI,CAAC,qBAAqB;gBAC/C,cAAc,EAAE,IAAI,CAAC,gBAAgB;gBACrC,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,QAAQ,EAAE,IAAI,CAAC,SAAS;gBACxB,iBAAiB,EAAE,IAAI,CAAC,mBAAmB;gBAC3C,kBAAkB,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,qBAAqB;gBAC/C,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,UAAU,EAAE,IAAI,CAAC,WAAW;gBAC5B,oBAAoB,EAAE,IAAI,CAAC,sBAAsB;gBACjD,uBAAuB,EAAE;oBACrB,cAAc,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,cAAc;oBACnC,cAAc,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,cAAc;oBACnC,MAAM,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO;oBACpB,OAAO,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO;oBACrB,QAAQ,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,QAAQ;oBACvB,KAAK,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM;oBAClB,UAAU,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,WAAW;oBAC5B,QAAQ,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,QAAQ;oBACvB,MAAM,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM;iBACtB;gBACD,cAAc,EAAE;oBACZ,cAAc,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,cAAc;oBAC9C,cAAc,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,cAAc;oBAC9C,MAAM,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,OAAO;oBAC/B,OAAO,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,OAAO;oBAChC,QAAQ,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,QAAQ;oBAClC,KAAK,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,MAAM;oBAC7B,UAAU,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,WAAW;oBACvC,QAAQ,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,QAAQ;oBAClC,MAAM,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,MAAM;iBACjC;gBACD,QAAQ,EAAE;oBACN,YAAY,EAAE;wBACV,WAAW,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,aAAa;wBACpC,aAAa,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,eAAe;qBAC3C;oBACD,OAAO,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,QAAQ;oBACtB,OAAO,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO;iBACxB;gBACD,qBAAqB,EAAE;oBACnB,YAAY,EAAE,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,eAAe;oBACpD,OAAO,EAAE,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,QAAQ;oBACxC,YAAY,EAAE,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,eAAe;oBACpD,OAAO,EAAE,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,OAAO;iBAC1C;gBACD,qBAAqB,EAAE,qBAAqB;gBAC5C,6BAA6B,EAAE,6BAA6B;gBAC5D,KAAK,EAAE;oBACH,aAAa,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,cAAc;iBACvC;aACJ,CAAC;YAEF,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ;AAhHD,wCAgHC"}
@@ -15,11 +15,25 @@ export interface CompanyProfileResource {
15
15
  has_charges: boolean;
16
16
  has_insolvency_history: boolean;
17
17
  registered_office_address: RegisteredOfficeAddressResource;
18
+ service_address?: ServiceAddressResource;
18
19
  accounts: AccountsResource;
19
20
  confirmation_statement?: ConfirmationStatementResource;
21
+ foreign_company_details?: ForeignCompanyDetailsResource;
22
+ is_on_register_in_country_formed_in?: string;
20
23
  links: LinksResource;
21
24
  }
22
- export interface RegisteredOfficeAddressResource {
25
+ export interface ForeignCompanyDetailsResource {
26
+ business_activity?: string;
27
+ governed_by?: string;
28
+ originating_registry?: OriginatingRegistryResource;
29
+ is_a_credit_finacial_institution?: boolean;
30
+ legal_form?: string;
31
+ }
32
+ export interface OriginatingRegistryResource {
33
+ name?: string;
34
+ country?: string;
35
+ }
36
+ export interface OfficeAddressResource {
23
37
  address_line_1: string;
24
38
  address_line_2: string;
25
39
  care_of: string;
@@ -30,6 +44,10 @@ export interface RegisteredOfficeAddressResource {
30
44
  premises: string;
31
45
  region: string;
32
46
  }
47
+ export interface RegisteredOfficeAddressResource extends OfficeAddressResource {
48
+ }
49
+ export interface ServiceAddressResource extends OfficeAddressResource {
50
+ }
33
51
  export interface AccountsResource {
34
52
  next_accounts: NextAccountsResource;
35
53
  next_due: string;
@@ -48,7 +66,7 @@ export interface ConfirmationStatementResource {
48
66
  export interface LinksResource {
49
67
  filing_history?: string;
50
68
  }
51
- export interface RegisteredOfficeAddress {
69
+ export interface OfficeAddress {
52
70
  addressLineOne: string;
53
71
  addressLineTwo: string;
54
72
  careOf: string;
@@ -59,6 +77,10 @@ export interface RegisteredOfficeAddress {
59
77
  premises: string;
60
78
  region: string;
61
79
  }
80
+ export interface RegisteredOfficeAddress extends OfficeAddress {
81
+ }
82
+ export interface ServiceAddress extends OfficeAddress {
83
+ }
62
84
  export interface Accounts {
63
85
  nextAccounts: NextAccounts;
64
86
  nextDue: string;
@@ -77,6 +99,17 @@ export interface ConfirmationStatement {
77
99
  export interface Links {
78
100
  filingHistory?: string;
79
101
  }
102
+ export interface ForeignCompanyDetails {
103
+ businessActivity?: string;
104
+ governedBy?: string;
105
+ originatingRegistry?: OriginatingRegistry;
106
+ isACreditFinacialInstitution?: boolean;
107
+ legalForm?: string;
108
+ }
109
+ export interface OriginatingRegistry {
110
+ name?: string;
111
+ country?: string;
112
+ }
80
113
  /**
81
114
  * CompanyProfile is the interface used within this SDK.
82
115
  */
@@ -94,7 +127,10 @@ export interface CompanyProfile {
94
127
  hasCharges: boolean;
95
128
  hasInsolvencyHistory: boolean;
96
129
  registeredOfficeAddress: RegisteredOfficeAddress;
130
+ serviceAddress?: ServiceAddress;
97
131
  accounts: Accounts;
98
132
  confirmationStatement?: ConfirmationStatement;
133
+ foreignCompanyDetails?: ForeignCompanyDetails;
134
+ isOnRegisterInCountryFormedIn?: boolean;
99
135
  links: Links;
100
136
  }
@@ -1,3 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ ;
4
+ ;
5
+ ;
6
+ ;
3
7
  //# sourceMappingURL=types.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/company-profile/types.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/company-profile/types.ts"],"names":[],"mappings":";;AAkDiF,CAAC;AACV,CAAC;AAoCR,CAAC;AACV,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@companieshouse/api-sdk-node",
3
- "version": "2.0.46",
3
+ "version": "2.0.47",
4
4
  "main": "./dist/index.js",
5
5
  "types": "./dist/index.d.ts",
6
6
  "files": [