@companieshouse/api-sdk-node 2.0.25 → 2.0.28
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/client.d.ts +2 -0
- package/dist/client.js +2 -0
- package/dist/client.js.map +1 -1
- package/dist/services/order/certificates/types.d.ts +2 -2
- package/dist/services/order/certified-copies/types.d.ts +2 -2
- package/dist/services/order/checkout/types.d.ts +2 -2
- package/dist/services/order/order-item/service.d.ts +9 -0
- package/dist/services/order/order-item/service.js +46 -0
- package/dist/services/order/order-item/service.js.map +1 -0
- package/dist/services/order/types.d.ts +3 -0
- package/dist/services/order/types.js +3 -0
- package/dist/services/order/types.js.map +1 -0
- package/package.json +1 -1
package/dist/client.d.ts
CHANGED
|
@@ -17,6 +17,7 @@ import CompanyPscStatementsService from "./services/company-psc-statements/servi
|
|
|
17
17
|
import { ConfirmationStatementService } from "./services/confirmation-statement";
|
|
18
18
|
import { OverseasEntityService } from "./services/overseas-entities";
|
|
19
19
|
import { CheckoutSearchService } from "./services/order/search/service";
|
|
20
|
+
import OrderItemService from "./services/order/order-item/service";
|
|
20
21
|
/**
|
|
21
22
|
* ApiClient is the class that all service objects hang off.
|
|
22
23
|
*/
|
|
@@ -36,6 +37,7 @@ export default class ApiClient {
|
|
|
36
37
|
readonly payment: PaymentService;
|
|
37
38
|
readonly checkout: CheckoutService;
|
|
38
39
|
readonly order: OrderService;
|
|
40
|
+
readonly orderItem: OrderItemService;
|
|
39
41
|
readonly checkoutSearchService: CheckoutSearchService;
|
|
40
42
|
readonly mid: MidService;
|
|
41
43
|
readonly refreshToken: RefreshTokenService;
|
package/dist/client.js
CHANGED
|
@@ -21,6 +21,7 @@ const service_11 = __importDefault(require("./services/company-psc-statements/se
|
|
|
21
21
|
const confirmation_statement_1 = require("./services/confirmation-statement");
|
|
22
22
|
const overseas_entities_1 = require("./services/overseas-entities");
|
|
23
23
|
const service_12 = require("./services/order/search/service");
|
|
24
|
+
const service_13 = __importDefault(require("./services/order/order-item/service"));
|
|
24
25
|
/**
|
|
25
26
|
* ApiClient is the class that all service objects hang off.
|
|
26
27
|
*/
|
|
@@ -42,6 +43,7 @@ class ApiClient {
|
|
|
42
43
|
this.payment = new payment_1.PaymentService(apiClient); // TODO split payments url/domain into a separate config item and http client
|
|
43
44
|
this.checkout = new order_1.CheckoutService(apiClient);
|
|
44
45
|
this.order = new order_1.OrderService(apiClient);
|
|
46
|
+
this.orderItem = new service_13.default(apiClient);
|
|
45
47
|
this.checkoutSearchService = new service_12.CheckoutSearchService(apiClient);
|
|
46
48
|
this.mid = new order_1.MidService(apiClient);
|
|
47
49
|
this.alphabeticalSearch = new service_6.default(apiClient);
|
package/dist/client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;AACA,kFAAyE;AACzE,iFAAuE;AACvE,6EAA+D;AAC/D,wCAA0D;AAC1D,6CAAyI;AACzI,iDAAqD;AACrD,wFAAoF;AACpF,4DAA+D;AAC/D,wFAA8E;AAC9E,4FAAsF;AACtF,yFAAgF;AAChF,mFAAyE;AACzE,0FAAwF;AACxF,8EAAgE;AAChE,yFAAoF;AACpF,8EAAiF;AACjF,oEAAqE;AACrE,8DAAwE;
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;AACA,kFAAyE;AACzE,iFAAuE;AACvE,6EAA+D;AAC/D,wCAA0D;AAC1D,6CAAyI;AACzI,iDAAqD;AACrD,wFAAoF;AACpF,4DAA+D;AAC/D,wFAA8E;AAC9E,4FAAsF;AACtF,yFAAgF;AAChF,mFAAyE;AACzE,0FAAwF;AACxF,8EAAgE;AAChE,yFAAoF;AACpF,8EAAiF;AACjF,oEAAqE;AACrE,8DAAwE;AACxE,mFAAmE;AAEnE;;GAEG;AACH,MAAqB,SAAS;IA0B5B,YAAsB,SAAsB,EAAW,aAA0B;QAA3D,cAAS,GAAT,SAAS,CAAa;QAAW,kBAAa,GAAb,aAAa,CAAa;QAC7E,iDAAiD;QACjD,IAAI,CAAC,mBAAmB,GAAG,IAAI,8BAAwB,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,IAAI,iBAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,oBAAoB,GAAG,IAAI,iBAA2B,CAAC,SAAS,CAAC,CAAC;QACvE,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,UAAU,GAAG,IAAI,iBAAiB,CAAC,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,oBAAoB,GAAG,IAAI,kBAA2B,CAAC,SAAS,CAAC,CAAC;QACvE,IAAI,CAAC,4BAA4B,GAAG,IAAI,qDAA4B,CAAC,SAAS,CAAC,CAAC;QAChF,IAAI,CAAC,WAAW,GAAG,IAAI,0BAAkB,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,eAAe,GAAG,IAAI,8BAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,MAAM,GAAG,IAAI,qBAAa,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,GAAG,IAAI,wBAAc,CAAC,SAAS,CAAC,CAAC,CAAC,6EAA6E;QAC3H,IAAI,CAAC,QAAQ,GAAG,IAAI,uBAAe,CAAC,SAAS,CAAC,CAAC;QAC/C,IAAI,CAAC,KAAK,GAAG,IAAI,oBAAY,CAAC,SAAS,CAAC,CAAC;QACzC,IAAI,CAAC,SAAS,GAAG,IAAI,kBAAgB,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,CAAC,qBAAqB,GAAG,IAAI,gCAAqB,CAAC,SAAS,CAAC,CAAC;QAClE,IAAI,CAAC,GAAG,GAAG,IAAI,kBAAU,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,CAAC,kBAAkB,GAAG,IAAI,iBAAyB,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,IAAI,iBAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,cAAc,GAAG,IAAI,yCAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,iEAAiE;QACjE,4DAA4D;QAC5D,IAAI,CAAC,YAAY,GAAG,IAAI,mCAAmB,CAAC,aAAa,CAAC,CAAC;QAC3D,IAAI,CAAC,gBAAgB,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,oBAAoB,GAAG,IAAI,iBAA6B,CAAC,SAAS,CAAC,CAAC;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;CACF;AAvDD,4BAuDC"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { ItemOptionsDeliveryTimescaleConfigurable } from "../types";
|
|
1
2
|
export interface CertificateItemResource {
|
|
2
3
|
company_name: string;
|
|
3
4
|
company_number: string;
|
|
@@ -120,13 +121,12 @@ export interface ItemCosts {
|
|
|
120
121
|
itemCost: string;
|
|
121
122
|
productType: string;
|
|
122
123
|
}
|
|
123
|
-
export interface ItemOptions {
|
|
124
|
+
export interface ItemOptions extends ItemOptionsDeliveryTimescaleConfigurable {
|
|
124
125
|
certificateType: string;
|
|
125
126
|
collectionLocation: string;
|
|
126
127
|
companyType: string;
|
|
127
128
|
contactNumber: string;
|
|
128
129
|
deliveryMethod: string;
|
|
129
|
-
deliveryTimescale: string;
|
|
130
130
|
designatedMemberDetails?: DesignatedMemberDetails;
|
|
131
131
|
directorDetails?: DirectorOrSecretaryDetails;
|
|
132
132
|
forename: string;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { ItemOptionsDeliveryTimescaleConfigurable } from "../types";
|
|
1
2
|
export interface CertifiedCopyItemResource {
|
|
2
3
|
company_name: string;
|
|
3
4
|
company_number: string;
|
|
@@ -66,11 +67,10 @@ export interface ItemCosts {
|
|
|
66
67
|
itemCost: string;
|
|
67
68
|
productType: string;
|
|
68
69
|
}
|
|
69
|
-
export interface ItemOptions {
|
|
70
|
+
export interface ItemOptions extends ItemOptionsDeliveryTimescaleConfigurable {
|
|
70
71
|
collectionLocation: string;
|
|
71
72
|
contactNumber: string;
|
|
72
73
|
deliveryMethod: string;
|
|
73
|
-
deliveryTimescale: string;
|
|
74
74
|
filingHistoryDocuments: FilingHistoryDocuments[];
|
|
75
75
|
forename: string;
|
|
76
76
|
surname: string;
|
|
@@ -18,13 +18,13 @@ export interface Checkout {
|
|
|
18
18
|
self: string;
|
|
19
19
|
payment: string;
|
|
20
20
|
};
|
|
21
|
-
paidAt
|
|
21
|
+
paidAt?: string;
|
|
22
22
|
checkedOutBy: {
|
|
23
23
|
email: string;
|
|
24
24
|
id: string;
|
|
25
25
|
};
|
|
26
26
|
status: string;
|
|
27
|
-
paymentReference
|
|
27
|
+
paymentReference?: string;
|
|
28
28
|
reference: string;
|
|
29
29
|
totalOrderCost: string;
|
|
30
30
|
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { IHttpClient } from "../../../http";
|
|
2
|
+
import { ApiResult } from "../../../services/resource";
|
|
3
|
+
import { Item } from "../order";
|
|
4
|
+
export default class OrderItemService {
|
|
5
|
+
private readonly client;
|
|
6
|
+
private static readonly EXCLUDED_FIELDS;
|
|
7
|
+
constructor(client: IHttpClient);
|
|
8
|
+
getOrderItem(orderId: string, itemId: string): Promise<ApiResult<Item>>;
|
|
9
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
12
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
13
|
+
};
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
const result_1 = require("../../../services/result");
|
|
16
|
+
const mapping_1 = __importDefault(require("../../../mapping/mapping"));
|
|
17
|
+
class OrderItemService {
|
|
18
|
+
constructor(client) {
|
|
19
|
+
this.client = client;
|
|
20
|
+
}
|
|
21
|
+
getOrderItem(orderId, itemId) {
|
|
22
|
+
var _a;
|
|
23
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24
|
+
const resp = yield this.client.httpGet(`/orders/${orderId}/items/${itemId}`);
|
|
25
|
+
if (resp.error) {
|
|
26
|
+
return result_1.failure({
|
|
27
|
+
httpStatusCode: resp.status,
|
|
28
|
+
errors: ((_a = resp === null || resp === void 0 ? void 0 : resp.error) === null || _a === void 0 ? void 0 : _a.errors) || resp.error
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
const body = resp.body;
|
|
32
|
+
const result = mapping_1.default.camelCaseKeys(body, OrderItemService.EXCLUDED_FIELDS);
|
|
33
|
+
return result_1.success(result);
|
|
34
|
+
});
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
exports.default = OrderItemService;
|
|
38
|
+
OrderItemService.EXCLUDED_FIELDS = {
|
|
39
|
+
deep: true,
|
|
40
|
+
stopPaths: [
|
|
41
|
+
"description_values",
|
|
42
|
+
"item_options.filing_history_description_values",
|
|
43
|
+
"item_options.filing_history_documents.filing_history_description_values" // certified copies
|
|
44
|
+
]
|
|
45
|
+
};
|
|
46
|
+
//# sourceMappingURL=service.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../../src/services/order/order-item/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAEA,qDAA4D;AAC5D,uEAA+C;AAG/C,MAAqB,gBAAgB;IAUjC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEzC,YAAY,CAAE,OAAe,EAAE,MAAc;;;YACtD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,OAAO,UAAU,MAAM,EAAE,CAAC,CAAC;YAE7E,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,gBAAO,CAAC;oBACX,cAAc,EAAE,IAAI,CAAC,MAAM;oBAC3B,MAAM,EAAE,OAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,0CAAE,MAAM,KAAI,IAAI,CAAC,KAAK;iBAC5C,CAAC,CAAC;aACN;YAED,MAAM,IAAI,GAAG,IAAI,CAAC,IAAoB,CAAC;YAEvC,MAAM,MAAM,GAAS,iBAAO,CAAC,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;YACnF,OAAO,gBAAO,CAAC,MAAM,CAAC,CAAC;;KAC1B;;AA1BL,mCA2BC;AA1B2B,gCAAe,GAAG;IACtC,IAAI,EAAE,IAAI;IACV,SAAS,EAAE;QACP,oBAAoB;QACpB,gDAAgD;QAChD,yEAAyE,CAAC,mBAAmB;KAChG;CACJ,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/order/types.ts"],"names":[],"mappings":""}
|