@companieshouse/api-sdk-node 2.0.300 → 2.0.301

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.
@@ -1,5 +1,5 @@
1
1
  import { IHttpClient } from "../../http";
2
- import { CompanyOfficers } from "./types";
2
+ import { CompanyOfficers, CompanyOfficer } from "./types";
3
3
  import Resource from "../resource";
4
4
  /**
5
5
  * https://developer.companieshouse.gov.uk/api/docs/company/company_number/officers/officers.html
@@ -19,4 +19,11 @@ export default class CompanyOfficersService {
19
19
  * @param orderBy the field by which to order the result set
20
20
  */
21
21
  getCompanyOfficers(number: string, pageSize?: number, pageIndex?: number, registerView?: boolean, orderBy?: string): Promise<Resource<CompanyOfficers>>;
22
+ /**
23
+ * Get a specific company appointment.
24
+ * @param number the company number to look up
25
+ * @param appointmentId the appointment ID to look up
26
+ * @returns the company appointment
27
+ */
28
+ getCompanyAppointment(number: string, appointmentId: string): Promise<Resource<CompanyOfficer>>;
22
29
  }
@@ -50,6 +50,27 @@ class CompanyOfficersService {
50
50
  return resource;
51
51
  });
52
52
  }
53
+ /**
54
+ * Get a specific company appointment.
55
+ * @param number the company number to look up
56
+ * @param appointmentId the appointment ID to look up
57
+ * @returns the company appointment
58
+ */
59
+ getCompanyAppointment(number, appointmentId) {
60
+ return __awaiter(this, void 0, void 0, function* () {
61
+ const url = `/company/${number}/appointments/${appointmentId}`;
62
+ const resp = yield this.client.httpGet(url);
63
+ const resource = {
64
+ httpStatusCode: resp.status
65
+ };
66
+ if (resp.error) {
67
+ return resource;
68
+ }
69
+ const body = resp.body;
70
+ resource.resource = mapping_1.default.camelCaseKeys(body);
71
+ return resource;
72
+ });
73
+ }
53
74
  }
54
75
  exports.default = CompanyOfficersService;
55
76
  //# sourceMappingURL=service.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/company-officers/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAGA,oEAA4C;AAE5C;;GAEG;AACH,MAAqB,sBAAsB;IACvC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEtD;;;;;;;;;;KAUC;IACY,kBAAkB,CAAE,MAAc,EAAE,WAAmB,EAAE,EAAE,YAAoB,CAAC,EAAE,eAAwB,KAAK,EAAE,OAAgB;;YAC1I,IAAI,GAAG,GAAG,YAAY,MAAM,WAAW,CAAC;YACxC,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,EAChB,aAAa,QAAQ,EAAE,EACvB,GAAG,EACH,cAAc,SAAS,EAAE,EACzB,GAAG,EACH,iBAAiB,YAAY,EAAE,CAAC,CAAC;YACrC,IAAI,OAAO,EAAE;gBACT,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,aAAa,OAAO,EAAE,CAAC,CAAC;aAC5C;YAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE5C,MAAM,QAAQ,GAA8B;gBACxC,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,QAAQ,CAAC;aACnB;YAED,MAAM,IAAI,GAAG,IAAI,CAAC,IAA+B,CAAC;YAElD,QAAQ,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAAkB,IAAI,CAAC,CAAC;YAEjE,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ;AA1CD,yCA0CC"}
1
+ {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/company-officers/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAGA,oEAA4C;AAE5C;;GAEG;AACH,MAAqB,sBAAsB;IACvC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEtD;;;;;;;;;;KAUC;IACY,kBAAkB,CAAE,MAAc,EAAE,WAAmB,EAAE,EAAE,YAAoB,CAAC,EAAE,eAAwB,KAAK,EAAE,OAAgB;;YAC1I,IAAI,GAAG,GAAG,YAAY,MAAM,WAAW,CAAC;YACxC,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,EAChB,aAAa,QAAQ,EAAE,EACvB,GAAG,EACH,cAAc,SAAS,EAAE,EACzB,GAAG,EACH,iBAAiB,YAAY,EAAE,CAAC,CAAC;YACrC,IAAI,OAAO,EAAE;gBACT,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,aAAa,OAAO,EAAE,CAAC,CAAC;aAC5C;YAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE5C,MAAM,QAAQ,GAA8B;gBACxC,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,QAAQ,CAAC;aACnB;YAED,MAAM,IAAI,GAAG,IAAI,CAAC,IAA+B,CAAC;YAElD,QAAQ,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAAkB,IAAI,CAAC,CAAC;YAEjE,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAED;;;;;OAKG;IACU,qBAAqB,CAAE,MAAc,EAAE,aAAqB;;YACrE,MAAM,GAAG,GAAG,YAAY,MAAM,iBAAiB,aAAa,EAAE,CAAC;YAE/D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE5C,MAAM,QAAQ,GAA6B;gBACvC,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,QAAQ,CAAC;aACnB;YAED,MAAM,IAAI,GAAG,IAAI,CAAC,IAA+B,CAAC;YAElD,QAAQ,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAAiB,IAAI,CAAC,CAAC;YAEhE,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ;AApED,yCAoEC"}
@@ -30,6 +30,7 @@ export interface LimitedPartnership {
30
30
  };
31
31
  }
32
32
  declare type Partner = {
33
+ appointment_id?: string;
33
34
  completed?: boolean;
34
35
  date_effective_from?: string;
35
36
  date_of_birth?: string;
@@ -49,6 +50,8 @@ declare type Partner = {
49
50
  resignation_date?: string;
50
51
  surname?: string;
51
52
  usual_residential_address?: Address;
53
+ cease_date?: string;
54
+ remove_confirmation_checked?: boolean;
52
55
  };
53
56
  export interface LimitedPartner {
54
57
  id?: string;
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/limited-partnerships/types.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AA+EH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IACzB,sEAAiD,CAAA;IACjD,kEAA6C,CAAA;IAC7C,4EAAuD,CAAA;AAC3D,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B;AAED,IAAY,WASX;AATD,WAAY,WAAW;IACnB,4FAA6E,CAAA;IAC7E,wGAAyF,CAAA;IACzF,4FAA6E,CAAA;IAC7E,wGAAyF,CAAA;IACzF,kGAAmF,CAAA;IACnF,8GAA+F,CAAA;IAC/F,kGAAmF,CAAA;IACnF,8GAA+F,CAAA;AACnG,CAAC,EATW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAStB;AAED,IAAY,eAKX;AALD,WAAY,eAAe;IACvB,oIAAiH,CAAA;IACjH,0FAAuE,CAAA;IACvE,0FAAuE,CAAA;IACvE,wJAAqI,CAAA;AACzI,CAAC,EALW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAK1B;AAED,IAAY,cAOX;AAPD,WAAY,cAAc;IACtB,6DAA2C,CAAA;IAC3C,2BAAS,CAAA;IACT,sCAAoB,CAAA;IACpB,qEAAmD,CAAA;IACnD,2BAAS,CAAA;IACT,sCAAoB,CAAA;AACxB,CAAC,EAPW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAOzB;AAED,IAAY,eAKX;AALD,WAAY,eAAe;IACvB,4BAAS,CAAA;IACT,gCAAa,CAAA;IACb,8BAAW,CAAA;IACX,kCAAe,CAAA;AACnB,CAAC,EALW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAK1B;AAED,IAAY,YAIX;AAJD,WAAY,YAAY;IACpB,mDAAmC,CAAA;IACnC,qDAAqC,CAAA;IACrC,qCAAqB,CAAA;AACzB,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB;AAsBD,IAAY,IAIX;AAJD,WAAY,IAAI;IACZ,qCAA6B,CAAA;IAC7B,+CAAuC,CAAA;IACvC,qBAAa,CAAA;AACjB,CAAC,EAJW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAIf"}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/limited-partnerships/types.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAkFH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IACzB,sEAAiD,CAAA;IACjD,kEAA6C,CAAA;IAC7C,4EAAuD,CAAA;AAC3D,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B;AAED,IAAY,WASX;AATD,WAAY,WAAW;IACnB,4FAA6E,CAAA;IAC7E,wGAAyF,CAAA;IACzF,4FAA6E,CAAA;IAC7E,wGAAyF,CAAA;IACzF,kGAAmF,CAAA;IACnF,8GAA+F,CAAA;IAC/F,kGAAmF,CAAA;IACnF,8GAA+F,CAAA;AACnG,CAAC,EATW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAStB;AAED,IAAY,eAKX;AALD,WAAY,eAAe;IACvB,oIAAiH,CAAA;IACjH,0FAAuE,CAAA;IACvE,0FAAuE,CAAA;IACvE,wJAAqI,CAAA;AACzI,CAAC,EALW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAK1B;AAED,IAAY,cAOX;AAPD,WAAY,cAAc;IACtB,6DAA2C,CAAA;IAC3C,2BAAS,CAAA;IACT,sCAAoB,CAAA;IACpB,qEAAmD,CAAA;IACnD,2BAAS,CAAA;IACT,sCAAoB,CAAA;AACxB,CAAC,EAPW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAOzB;AAED,IAAY,eAKX;AALD,WAAY,eAAe;IACvB,4BAAS,CAAA;IACT,gCAAa,CAAA;IACb,8BAAW,CAAA;IACX,kCAAe,CAAA;AACnB,CAAC,EALW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAK1B;AAED,IAAY,YAIX;AAJD,WAAY,YAAY;IACpB,mDAAmC,CAAA;IACnC,qDAAqC,CAAA;IACrC,qCAAqB,CAAA;AACzB,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB;AAsBD,IAAY,IAIX;AAJD,WAAY,IAAI;IACZ,qCAA6B,CAAA;IAC7B,+CAAuC,CAAA;IACvC,qBAAa,CAAA;AACjB,CAAC,EAJW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAIf"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@companieshouse/api-sdk-node",
3
- "version": "2.0.300",
3
+ "version": "2.0.301",
4
4
  "main": "./dist/index.js",
5
5
  "types": "./dist/index.d.ts",
6
6
  "files": [