@companieshouse/api-sdk-node 2.0.256 → 2.0.258
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.
- package/dist/services/limited-partnerships/service.d.ts +6 -1
- package/dist/services/limited-partnerships/service.js +53 -0
- package/dist/services/limited-partnerships/service.js.map +1 -1
- package/dist/services/limited-partnerships/types.d.ts +33 -22
- package/dist/services/limited-partnerships/types.js +3 -3
- package/dist/services/limited-partnerships/types.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { IHttpClient } from "../../http";
|
|
2
|
-
import { Incorporation, LimitedPartnership, LimitedPartnershipResourceCreated, LimitedPartnershipIncorporation, GeneralPartner } from "./types";
|
|
2
|
+
import { Incorporation, LimitedPartnership, LimitedPartnershipResourceCreated, LimitedPartnershipIncorporation, GeneralPartner, LimitedPartner } from "./types";
|
|
3
3
|
import Resource, { ApiErrorResponse } from "../resource";
|
|
4
4
|
export default class LimitedPartnershipsService {
|
|
5
5
|
private readonly client;
|
|
@@ -14,4 +14,9 @@ export default class LimitedPartnershipsService {
|
|
|
14
14
|
getGeneralPartners(transactionId: string): Promise<Resource<GeneralPartner[]> | ApiErrorResponse>;
|
|
15
15
|
patchGeneralPartner(transactionId: string, generalPartnerId: string, body: GeneralPartner["data"]): Promise<Resource<void> | ApiErrorResponse>;
|
|
16
16
|
deleteGeneralPartner(transactionId: string, generalPartnerId: string): Promise<Resource<void> | ApiErrorResponse>;
|
|
17
|
+
postLimitedPartner(transactionId: string, body: LimitedPartner): Promise<Resource<LimitedPartnershipResourceCreated> | ApiErrorResponse>;
|
|
18
|
+
getLimitedPartner(transactionId: string, limitedPartnerId: string): Promise<Resource<LimitedPartner> | ApiErrorResponse>;
|
|
19
|
+
getLimitedPartners(transactionId: string): Promise<Resource<LimitedPartner[]> | ApiErrorResponse>;
|
|
20
|
+
patchLimitedPartner(transactionId: string, limitedPartnerId: string, body: LimitedPartner["data"]): Promise<Resource<void> | ApiErrorResponse>;
|
|
21
|
+
deleteLimitedPartner(transactionId: string, limitedPartnerId: string): Promise<Resource<void> | ApiErrorResponse>;
|
|
17
22
|
}
|
|
@@ -122,6 +122,59 @@ class LimitedPartnershipsService {
|
|
|
122
122
|
};
|
|
123
123
|
});
|
|
124
124
|
}
|
|
125
|
+
/*
|
|
126
|
+
* Calls to limited partner endpoints
|
|
127
|
+
*/
|
|
128
|
+
postLimitedPartner(transactionId, body) {
|
|
129
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
130
|
+
const URL = `/transactions/${transactionId}/limited-partnership/limited-partner`;
|
|
131
|
+
const response = yield this.client.httpPost(URL, body);
|
|
132
|
+
return {
|
|
133
|
+
httpStatusCode: response.status,
|
|
134
|
+
resource: Object.assign({}, response.body)
|
|
135
|
+
};
|
|
136
|
+
});
|
|
137
|
+
}
|
|
138
|
+
getLimitedPartner(transactionId, limitedPartnerId) {
|
|
139
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
140
|
+
const URL = `/transactions/${transactionId}/limited-partnership/limited-partner/${limitedPartnerId}`;
|
|
141
|
+
const response = yield this.client.httpGet(URL);
|
|
142
|
+
return {
|
|
143
|
+
httpStatusCode: response.status,
|
|
144
|
+
resource: Object.assign({}, response.body)
|
|
145
|
+
};
|
|
146
|
+
});
|
|
147
|
+
}
|
|
148
|
+
getLimitedPartners(transactionId) {
|
|
149
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
150
|
+
const URL = `/transactions/${transactionId}/limited-partnership/limited-partners`;
|
|
151
|
+
const response = yield this.client.httpGet(URL);
|
|
152
|
+
return {
|
|
153
|
+
httpStatusCode: response.status,
|
|
154
|
+
resource: response.body
|
|
155
|
+
};
|
|
156
|
+
});
|
|
157
|
+
}
|
|
158
|
+
patchLimitedPartner(transactionId, limitedPartnerId, body) {
|
|
159
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
160
|
+
const URL = `/transactions/${transactionId}/limited-partnership/limited-partner/${limitedPartnerId}`;
|
|
161
|
+
const response = yield this.client.httpPatch(URL, body);
|
|
162
|
+
return {
|
|
163
|
+
httpStatusCode: response.status,
|
|
164
|
+
resource: Object.assign({}, response.body)
|
|
165
|
+
};
|
|
166
|
+
});
|
|
167
|
+
}
|
|
168
|
+
deleteLimitedPartner(transactionId, limitedPartnerId) {
|
|
169
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
170
|
+
const URL = `/transactions/${transactionId}/limited-partnership/limited-partner/${limitedPartnerId}`;
|
|
171
|
+
const response = yield this.client.httpDelete(URL);
|
|
172
|
+
return {
|
|
173
|
+
httpStatusCode: response.status,
|
|
174
|
+
resource: Object.assign({}, response.body)
|
|
175
|
+
};
|
|
176
|
+
});
|
|
177
|
+
}
|
|
125
178
|
}
|
|
126
179
|
exports.default = LimitedPartnershipsService;
|
|
127
180
|
//# sourceMappingURL=service.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/limited-partnerships/service.ts"],"names":[],"mappings":";;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/limited-partnerships/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAWA,MAAqB,0BAA0B;IAC3C,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAExC,sBAAsB,CAC/B,aAAqB,EACrB,IAAwB;;YAExB,MAAM,GAAG,GAAG,iBAAiB,aAAa,kCAAkC,CAAC;YAC7E,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAErE,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;IAEY,uBAAuB,CAChC,aAAqB,EACrB,YAAoB,EACpB,IAAgC;;YAEhC,MAAM,GAAG,GAAG,iBAAiB,aAAa,oCAAoC,YAAY,EAAE,CAAC;YAC7F,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAEtE,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;IAEY,qBAAqB,CAC9B,aAAqB,EACrB,YAAoB;;YAEpB,MAAM,GAAG,GAAG,iBAAiB,aAAa,oCAAoC,YAAY,EAAE,CAAC;YAC7F,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE9D,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;IAED;;OAEG;IAEU,mCAAmC,CAC5C,aAAqB,EACrB,IAAmB;;YAEnB,MAAM,GAAG,GAAG,iBAAiB,aAAa,oCAAoC,CAAC;YAC/E,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAErE,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;IAEY,kCAAkC,CAC3C,aAAqB,EACrB,gBAAwB,EACxB,mBAA6B;;YAE7B,MAAM,iBAAiB,GAAW,mBAAmB;gBACjD,CAAC,CAAC,yBAAyB,GAAG,mBAAmB;gBACjD,CAAC,CAAC,EAAE,CAAC;YACT,MAAM,GAAG,GAAG,iBAAiB,aAAa,sCAAsC,gBAAgB,GAAG,iBAAiB,EAAE,CAAC;YAEvH,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE9D,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;IAED;;OAEG;IAEU,kBAAkB,CAC3B,aAAqB,EACrB,IAAoB;;YAEpB,MAAM,GAAG,GAAG,iBAAiB,aAAa,sCAAsC,CAAC;YACjF,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAErE,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;IAEY,iBAAiB,CAC1B,aAAqB,EACrB,gBAAwB;;YAExB,MAAM,GAAG,GAAG,iBAAiB,aAAa,wCAAwC,gBAAgB,EAAE,CAAC;YACrG,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE9D,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;IAEY,kBAAkB,CAC3B,aAAqB;;YAErB,MAAM,GAAG,GAAG,iBAAiB,aAAa,uCAAuC,CAAC;YAClF,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;YAEjF,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,EAAE,QAAQ,CAAC,IAAI;aAC1B,CAAC;QACN,CAAC;KAAA;IAEY,mBAAmB,CAC5B,aAAqB,EACrB,gBAAwB,EACxB,IAA4B;;YAE5B,MAAM,GAAG,GAAG,iBAAiB,aAAa,wCAAwC,gBAAgB,EAAE,CAAC;YACrG,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAEtE,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;IAEY,oBAAoB,CAC7B,aAAqB,EACrB,gBAAwB;;YAExB,MAAM,GAAG,GAAG,iBAAiB,aAAa,wCAAwC,gBAAgB,EAAE,CAAC;YACrG,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAEjE,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;IAED;;MAEE;IAEW,kBAAkB,CAC3B,aAAqB,EACrB,IAAoB;;YAEpB,MAAM,GAAG,GAAG,iBAAiB,aAAa,sCAAsC,CAAC;YACjF,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAErE,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;IAEY,iBAAiB,CAC1B,aAAqB,EACrB,gBAAwB;;YAExB,MAAM,GAAG,GAAG,iBAAiB,aAAa,wCAAwC,gBAAgB,EAAE,CAAC;YACrG,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE9D,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;IAEY,kBAAkB,CAC3B,aAAqB;;YAErB,MAAM,GAAG,GAAG,iBAAiB,aAAa,uCAAuC,CAAC;YAClF,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE9D,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,EAAE,QAAQ,CAAC,IAAI;aAC1B,CAAC;QACN,CAAC;KAAA;IAEY,mBAAmB,CAC5B,aAAqB,EACrB,gBAAwB,EACxB,IAA4B;;YAE5B,MAAM,GAAG,GAAG,iBAAiB,aAAa,wCAAwC,gBAAgB,EAAE,CAAC;YACrG,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAEtE,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;IAEY,oBAAoB,CAC7B,aAAqB,EACrB,gBAAwB;;YAExB,MAAM,GAAG,GAAG,iBAAiB,aAAa,wCAAwC,gBAAgB,EAAE,CAAC;YACrG,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAEjE,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;CACJ;AAvND,6CAuNC"}
|
|
@@ -26,30 +26,40 @@ export interface LimitedPartnership {
|
|
|
26
26
|
sic_codes?: string[];
|
|
27
27
|
};
|
|
28
28
|
}
|
|
29
|
+
declare type Partner = {
|
|
30
|
+
date_effective_from?: string;
|
|
31
|
+
date_of_birth?: string;
|
|
32
|
+
etag?: string;
|
|
33
|
+
forename?: string;
|
|
34
|
+
former_names?: string;
|
|
35
|
+
governing_law?: string;
|
|
36
|
+
kind?: string;
|
|
37
|
+
legal_entity_name?: string;
|
|
38
|
+
legal_entity_register_name?: string;
|
|
39
|
+
legal_entity_registration_location?: string;
|
|
40
|
+
legal_form?: string;
|
|
41
|
+
nationality1?: string;
|
|
42
|
+
nationality2?: string;
|
|
43
|
+
principal_office_address?: Address;
|
|
44
|
+
registered_company_number?: string;
|
|
45
|
+
resignation_date?: string;
|
|
46
|
+
surname?: string;
|
|
47
|
+
usual_residential_address?: Address;
|
|
48
|
+
};
|
|
49
|
+
export interface LimitedPartner {
|
|
50
|
+
id?: string;
|
|
51
|
+
data?: Partner & {
|
|
52
|
+
contribution_currency_type?: string;
|
|
53
|
+
contribution_currency_value?: string;
|
|
54
|
+
contribution_non_monetary_value?: string;
|
|
55
|
+
};
|
|
56
|
+
}
|
|
29
57
|
export interface GeneralPartner {
|
|
30
58
|
id?: string;
|
|
31
|
-
data?: {
|
|
32
|
-
date_effective_from?: string;
|
|
33
|
-
date_of_birth?: string;
|
|
34
|
-
etag?: string;
|
|
35
|
-
forename?: string;
|
|
36
|
-
former_names?: string;
|
|
37
|
-
governing_law?: string;
|
|
38
|
-
kind?: string;
|
|
39
|
-
legal_entity_name?: string;
|
|
40
|
-
legal_entity_register_name?: string;
|
|
41
|
-
legal_entity_registration_location?: string;
|
|
42
|
-
legal_form?: string;
|
|
43
|
-
nationality1?: string;
|
|
44
|
-
nationality2?: string;
|
|
59
|
+
data?: Partner & {
|
|
45
60
|
not_disqualified_statement_checked?: boolean;
|
|
46
61
|
legal_personality_statement_checked?: boolean;
|
|
47
|
-
principal_office_address?: Address;
|
|
48
|
-
registered_company_number?: string;
|
|
49
|
-
resignation_date?: string;
|
|
50
62
|
service_address?: Address;
|
|
51
|
-
surname?: string;
|
|
52
|
-
usual_residential_address?: Address;
|
|
53
63
|
};
|
|
54
64
|
}
|
|
55
65
|
/**
|
|
@@ -78,9 +88,9 @@ export declare enum PartnershipType {
|
|
|
78
88
|
SPFLP = "SPFLP"
|
|
79
89
|
}
|
|
80
90
|
export declare enum Jurisdiction {
|
|
81
|
-
ENGLAND_AND_WALES = "
|
|
82
|
-
NORTHERN_IRELAND = "
|
|
83
|
-
SCOTLAND = "
|
|
91
|
+
ENGLAND_AND_WALES = "england-wales",
|
|
92
|
+
NORTHERN_IRELAND = "northern-ireland",
|
|
93
|
+
SCOTLAND = "scotland"
|
|
84
94
|
}
|
|
85
95
|
export interface LimitedPartnershipIncorporation {
|
|
86
96
|
etag: string;
|
|
@@ -105,3 +115,4 @@ export declare enum Term {
|
|
|
105
115
|
UNTIL_DISSOLUTION = "UNTIL_DISSOLUTION",
|
|
106
116
|
NONE = "NONE"
|
|
107
117
|
}
|
|
118
|
+
export {};
|
|
@@ -27,9 +27,9 @@ var PartnershipType;
|
|
|
27
27
|
})(PartnershipType = exports.PartnershipType || (exports.PartnershipType = {}));
|
|
28
28
|
var Jurisdiction;
|
|
29
29
|
(function (Jurisdiction) {
|
|
30
|
-
Jurisdiction["ENGLAND_AND_WALES"] = "
|
|
31
|
-
Jurisdiction["NORTHERN_IRELAND"] = "
|
|
32
|
-
Jurisdiction["SCOTLAND"] = "
|
|
30
|
+
Jurisdiction["ENGLAND_AND_WALES"] = "england-wales";
|
|
31
|
+
Jurisdiction["NORTHERN_IRELAND"] = "northern-ireland";
|
|
32
|
+
Jurisdiction["SCOTLAND"] = "scotland";
|
|
33
33
|
})(Jurisdiction = exports.Jurisdiction || (exports.Jurisdiction = {}));
|
|
34
34
|
var Term;
|
|
35
35
|
(function (Term) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/limited-partnerships/types.ts"],"names":[],"mappings":";AAAA;;GAEG;;;
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/limited-partnerships/types.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AA2EH,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IACzB,sEAAiD,CAAA;IACjD,kEAA6C,CAAA;AACjD,CAAC,EAHW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAG5B;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"}
|